Skip to content

Commit 1a6732f

Browse files
rhatdanrhatdan
committed
Merge pull request #52 from aweiteka/dash-keys
Change underscore '_' to dash '-'
2 parents 783eb90 + 5cb1568 commit 1a6732f

2 files changed

Lines changed: 34 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,24 @@ The following types of data are being considered:
3434
| version | Version of the image|
3535
| release | Release Number for this version|
3636
| architecture| Architecture for the image|
37-
| build_date | Date/Time image was built|
37+
| build-date | Date/Time image was built|
3838
| vendor | Owner of the image|
3939
| url | Url with more information on the image|
4040
| summary | Short Description of the image|
4141
| description | Detailed description of the image|
42-
| vcs_type | The type of version control used by the container source. Generally one of git, hg, svn, bzr, cvs|
43-
| vcs_url | URL of the version control repository|
44-
| vcs_ref | A 'reference' within the version control repository; e.g. a git commit, or a subversion branch|
45-
| authoritative_source_url | The authoritative location in which the image is published|
46-
| distribution_scope | Intended scope of distribution for image (see below for possible values)|
47-
| changelog_url | URL of a page containing release notes for the image|
42+
| vcs-type | The type of version control used by the container source. Generally one of git, hg, svn, bzr, cvs|
43+
| vcs-url | URL of the version control repository|
44+
| vcs-ref | A 'reference' within the version control repository; e.g. a git commit, or a subversion branch|
45+
| authoritative-source-url | The authoritative location in which the image is published|
46+
| distribution-scope | Intended scope of distribution for image (see below for possible values)|
47+
| changelog-url | URL of a page containing release notes for the image|
4848

49-
3. Possible values of distribution_scope field
49+
3. Possible values of distribution-scope field
5050

5151
|Name | Description |
5252
|-------------|-------------|
5353
| private | No public redistribution intended|
54-
| authoritative_source_only | Redistribution only from the source listed in the 'authoritative_source_url' label|
54+
| authoritative-source-only | Redistribution only from the source listed in the 'authoritative-source-url' label|
5555
| restricted | Redistribution only with permission|
5656
| public | No redistribution limits beyond licenses|
5757

@@ -62,11 +62,11 @@ The following types of data are being considered:
6262

6363
## Details on Labels
6464

65-
## `authoritative_source_url`
65+
## `authoritative-source-url`
6666
* The authoritative location the image is published by the owner.
6767
* In combination with the 'name' label, this tells a user where to go and look for official updates and current versions of the image, regardless of the local tags.
6868

69-
## `distribution_scope`
69+
## `distribution-scope`
7070
* The intended scope of distribution for the image.
7171
* Allows a user to define the intended scope of distribution. This addresses the end-user case of internal builds vs. public content and the use case of a vendor like Red Hat that provides content streams under subscription agreements - which is different from the license(s) of the image content.
72-
* In combination with the 'authoritative_source_url' and 'name' labels allows automatic redirect to the authoritative source.
72+
* In combination with the 'authoritative-source-url' and 'name' labels allows automatic redirect to the authoritative source.

‎vendor/redhat/labels.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Fields are:
1212
* Right now the value is `"x86_64"`
1313
* `"name"`
1414
* The primary name of the image (relative path without TAG): `PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/ REPO[$CONTENTGENERATION][--$PLATFORMDIFFERENTIATOR]`
15-
* `"authoritative_source"`
15+
* `"authoritative-source"`
1616
* The authoritative registry in which the image is published. For Red Hat this is `"registry.access.redhat.com"`. This allows e.g. to verify if a newer version is available independent of local tagging.
1717
* For ISVs this is optional.
1818
* `"release"`
@@ -27,40 +27,40 @@ The Fields are:
2727
To reconstruct the authoritative source for an image, docker pull...
2828

2929
```
30-
$authoritative_source/$name:$version-$release
30+
$authoritative-source/$name:$version-$release
3131
```
3232

3333
Aka:
3434

3535
```
36-
$authoritative_source[:PORT]/PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/REPO[$CONTENTGENERATION][--$PLATFORMDIFFERENTIATOR]:$COMPVER-$IMGBUILD
36+
$authoritative-source[:PORT]/PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/REPO[$CONTENTGENERATION][--$PLATFORMDIFFERENTIATOR]:$COMPVER-$IMGBUILD
3737
```
3838

3939
## Other labels
4040

41-
* `"com.redhat.build_host"`
41+
* `"com.redhat.build-host"`
4242
* The build host used to create an image for internal use and auditability, similar to the use in RPM.
43-
* `"distribution_scope"`
43+
* `"distribution-scope"`
4444
* Scope of intended distribution of the image.
4545
* Possible values
4646
* `private`: No public redistribution intended
47-
* `authoritative_source_only` Redistribution only from the source listed in the `"authoritative_source"` label
47+
* `authoritative-source-only` Redistribution only from the source listed in the `"authoritative-source"` label
4848
* `restricted` Redistribution only with permission
4949
* `public` No redistribution limits beyond licenses
50-
* For Red Hat product images this will be set to `"authoritative_source_only"`
51-
* `"build_date"`
50+
* For Red Hat product images this will be set to `"authoritative-source-only"`
51+
* `"build-date"`
5252
* Date/Time image was built (Optional)
5353
* `"url"` (Optional)
5454
* Url with more information on the image
5555
* `"summary"` (Required)
5656
* Short Description of the image
5757
* `"description"` (Optional)
5858
* Detailed description of the image
59-
* `"vcs_type"` (Optional)
59+
* `"vcs-type"` (Optional)
6060
* The type of version control used by the container source. Generally one of git, hg, svn, bzr, cvs
61-
* `"vcs_url"` (Optional)
61+
* `"vcs-url"` (Optional)
6262
* URL of the version control repository
63-
* `"vcs_ref"` (Optional)
63+
* `"vcs-ref"` (Optional)
6464
* A 'reference' within the version control repository; e.g. a git commit, or a subversion branch
6565

6666
### Examples
@@ -69,46 +69,46 @@ $authoritative_source[:PORT]/PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/REP
6969

7070
"Labels": {
7171
"architecture": "x86_64",
72-
"authoritative_source:" "registry.access.redhat.com",
73-
"com.redhat.build_host": "rcm-img04.build.eng.bos.redhat.com",
72+
"authoritative-source:" "registry.access.redhat.com",
73+
"com.redhat.build-host": "rcm-img04.build.eng.bos.redhat.com",
7474
"com.redhat.component": "rhel-server-docker",
7575
"name": "rhel7/rhel",
7676
"release": "4",
7777
"vendor": "Red Hat, Inc.",
7878
"version": "7.1",
7979
"summary":"RHEL 7 base platform image",
80-
"distribution_scope":"authoritative_source_only"
80+
"distribution-scope":"authoritative-source-only"
8181
},
8282

8383
1. `registry.access.redhat.com/rhel7/rsyslog:7.1-4` has the following metadata:
8484

8585
"Labels": {
8686
"architecture": "x86_64",
87-
"authoritative_source": "registry.access.redhat.com"
88-
"com.redhat.build_host": "rcm-img04.build.eng.bos.redhat.com",
87+
"authoritative-source": "registry.access.redhat.com"
88+
"com.redhat.build-host": "rcm-img04.build.eng.bos.redhat.com",
8989
"com.redhat.component": "rsyslog-docker",
9090
"name": "rhel7/rsyslog",
9191
"release": "4",
9292
"vendor": "Red Hat, Inc.",
9393
"version": "7.1",
9494
"summary":"RHEL 7 rsyslog application image",
95-
"distribution_scope":"authoritative_source_only"
95+
"distribution-scope":"authoritative-source-only"
9696
},
9797

9898
1. `registry.access.redhat.com/rhel7/php-5.4.16-3` has the following metadata:
9999

100100
"Labels": {
101101
"architecture": "x86_64",
102-
"authoritative_source": "registry.access.redhat.com"
103-
"com.redhat.build_host": "rcm-img04.build.eng.bos.redhat.com",
102+
"authoritative-source": "registry.access.redhat.com"
103+
"com.redhat.build-host": "rcm-img04.build.eng.bos.redhat.com",
104104
"com.redhat.component": "php-docker",
105105
"name": "rhel7/php",
106106
"release": "3",
107107
"vendor": "Red Hat, Inc.",
108108
"version": "5.4.16",
109109
"summary": "Multiple",
110110
"summary":"RHEL 7 based PHP platform image",
111-
"distribution_scope":"authoritative_source_only"
111+
"distribution-scope":"authoritative-source-only"
112112
},
113113

114114
## Primary Product Images in library/
@@ -253,9 +253,9 @@ Red Hat uses the LABEL metadata field to provide additional information for imag
253253
* Name of the ISV
254254
* `"version"`
255255
* Version part of the TAG in the primary name.
256-
* `"authoritative_source"`
256+
* `"authoritative-source"`
257257
* The official registry the ISV is publishing the images to.
258-
* `"distribution_scope"`
258+
* `"distribution-scope"`
259259
* Distribution scope for the image
260260

261261
Any vendor specific LABELS, `'com.redhat.*'`, must be blanked out.

0 commit comments

Comments
 (0)