Default Containerized Application Labels/Annotations/Ids used to document the application and/or image
With the introduction of the Atomic command, we are accessing container image meta data to describe the purpose of the image or the application defined by the image.
We would like to get consensus on default names. Proposals have been made to namespace the label names defined in Docker.
But we believe their should be some generic toplevel names defined that are not vendor specific, or distribution specific.
If you would like to see additional names and descriptions added please open issues and send pull requests to update this readme.
The following types of data are being considered:
- Labels used to describe how to use the application/image
| Name | Description |
|---|---|
| RUN | Command required to run the image |
| UNINSTALL | Command Required to uninstall the image |
| INSTALL | Command Required to install the image |
- Labels Names used to describe the application/image
| Name | Description |
|---|---|
| Name | Name of the Image |
| Version | Version of the image |
| Release | Release Number for this version |
| Architecture | Architecture for the image |
| License | Image License |
| BuildDate | Date/Time image was built |
| BuildHost | Host Image was built on |
| Vendor | Owner of the image |
| URL | Url with more information on the image |
| Summary | Short Description of the image |
| Description | Detailed description of the image |
- Annotations with container configuration that is externally accessible, to clarify the extent to which a container image is a "black box". Rather than explicit fields, this is a pattern for the key (in likeness to an Object Identifiers (OID) or the Java package naming convention).
| Sample Name | Sample Description |
|---|---|
com.example.webserver.memory.max |
Maximum memory setting for "example.com" organization's webserver |
com.example.webserver.memory.min |
Minimum memory setting for "example.com" organization's webserver |