Skip to content

Commit 4ff09ff

Browse files
committed
add 'Required' collumn
1 parent e372b65 commit 4ff09ff

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

vendor/redhat/labels.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Red Hat built images will include a fields in the metadata to identify the offic
44

55
## Naming and versioning related labels
66

7-
The Fields are:
7+
The Fields, all required, are:
88

99
| Name | Description |
1010
|----------------|------------------------------------|
@@ -30,21 +30,21 @@ $authoritative-source[:PORT]/PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/REP
3030

3131
## Other labels
3232

33-
| Name | Description |
34-
|----------------|------------------------------------|
35-
| com.redhat.build-host | The build host used to create an image for internal use and auditability, similar to the use in RPM. |
36-
| distribution-scope | Scope of intended distribution of the image. For Red Hat product images this will be set to `"authoritative-source-only"`. Other possible values <ul><li>`private`: No public redistribution intended</li><li>`authoritative-source-only`: Redistribution only from the source listed in the `"authoritative-source"` label</li><li>`restricted`: Redistribution only with permission</li><li>`public`: No redistribution limits beyond licenses</li></ul> |
37-
| build-date | Date/Time image was built as [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time (Optional) |
38-
| url | (Optional) Url with more information on the image |
39-
| summary | (Required) Short Description of the image |
40-
| description | (Optional) Detailed description of the image |
41-
| vcs-type | (Optional) The type of version control used by the container source. Generally one of git, hg, svn, bzr, cvs |
42-
| vcs-url | (Optional) URL of the version control repository |
43-
| vcs-ref | (Optional) A 'reference' within the version control repository; e.g. a git commit, or a subversion branch |
44-
| io.k8s.description | (Optional) Description of the container displayed in Kubernetes |
45-
| io.k8s.display-name | (Optional) Name of the container displayed in Kubernetes |
46-
| io.openshift.expose-services | (Optional) port:service pairs separated with comma, e.g. `"8080:http,8443:https"` |
47-
| io.openshift.tags | (Optional) tags used by searching engine, e.g. `"builder,php,php56,rh-php56"` |
33+
| Name | Required | Description |
34+
|----------------|----------|------------------------------------|
35+
| com.redhat.build-host | yes | The build host used to create an image for internal use and auditability, similar to the use in RPM. |
36+
| distribution-scope | yes | Scope of intended distribution of the image. For Red Hat product images this will be set to `"authoritative-source-only"`. Possible values <ul><li>`private`: No public redistribution intended</li><li>`authoritative-source-only`: Redistribution only from the source listed in the `"authoritative-source"` label</li><li>`restricted`: Redistribution only with permission</li><li>`public`: No redistribution limits beyond licenses</li></ul> |
37+
| build-date | no | Date/Time image was built as [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time |
38+
| url | no | Url with more information on the image |
39+
| summary | yes | Short Description of the image |
40+
| description | no | Detailed description of the image |
41+
| vcs-type | no | The type of version control used by the container source. Generally one of git, hg, svn, bzr, cvs |
42+
| vcs-url | no | URL of the version control repository |
43+
| vcs-ref | no | A 'reference' within the version control repository; e.g. a git commit, or a subversion branch |
44+
| io.k8s.description | no | Description of the container displayed in Kubernetes |
45+
| io.k8s.display-name | no | Name of the container displayed in Kubernetes |
46+
| io.openshift.expose-services | no | port:service pairs separated with comma, e.g. `"8080:http,8443:https"` |
47+
| io.openshift.tags | no | tags used by searching engine, e.g. `"builder,php,php56,rh-php56"` |
4848

4949
### Examples
5050

0 commit comments

Comments
 (0)