Skip to content

Commit

Permalink
Merge pull request #89 from kvedurmu/patch-1
Browse files Browse the repository at this point in the history
Updates platform spec for stack metadata RFC

Signed-off-by: Ben Hale <bhale@vmware.com>
  • Loading branch information
nebhale authored Oct 7, 2020
2 parents 635fff2 + d890c3c commit b545c07
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,16 @@ The platform MUST ensure that:
- The image config's `Label` field has the label `io.buildpacks.stack.id` set to the stack ID.
- The image config's `Label` field has the label `io.buildpacks.stack.mixins` set to a JSON array containing mixin names for each mixin applied to the image.

The platform SHOULD ensure that:

- The image config's `Label` field has the label `io.buildpacks.stack.maintainer` set to the name of the stack maintainer.
- The image config's `Label` field has the label `io.buildpacks.stack.homepage` set to the homepage of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.distro.name` set to the name of the stack's OS distro.
- The image config's `Label` field has the label `io.buildpacks.stack.distro.version` set to the version of the stack's OS distro.
- The image config's `Label` field has the label `io.buildpacks.stack.released` set to the release date of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.description` set to the description of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.metadata` set to additional metadata related to the stack.

### Run Image

The platform MUST ensure that:
Expand All @@ -163,6 +173,16 @@ The platform MUST ensure that:
- The image config's `Label` field has the label `io.buildpacks.stack.id` set to the stack ID.
- The image config's `Label` field has the label `io.buildpacks.stack.mixins` set to a JSON array containing mixin names for each mixin applied to the image.

The platform SHOULD ensure that:

- The image config's `Label` field has the label `io.buildpacks.stack.maintainer` set to the name of the stack maintainer.
- The image config's `Label` field has the label `io.buildpacks.stack.homepage` set to the homepage of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.distro.name` set to the name of the stack's OS distro.
- The image config's `Label` field has the label `io.buildpacks.stack.distro.version` set to the version of the stack's OS distro.
- The image config's `Label` field has the label `io.buildpacks.stack.released` set to the release date of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.description` set to the description of the stack.
- The image config's `Label` field has the label `io.buildpacks.stack.metadata` set to additional metadata related to the stack.

### Mixins

A mixin name MUST only be defined by the author of its corresponding stack.
Expand Down Expand Up @@ -660,6 +680,7 @@ Usage:
- The value of `io.buildpacks.lifecycle.metadata` SHALL be modified as follows
- `run-image.reference` SHALL uniquely identify `<run-image>`
- `run-image.top-layer` SHALL be set to the uncompressed digest of the top layer in `<run-image>`
- The value of `io.buildpacks.stack.*` labels SHALL be modified to that of the new `run-image`
- To ensure [build reproducibility](#build-reproducibility), the lifecycle:
- Set the `created` time in image config to a constant

Expand Down

0 comments on commit b545c07

Please sign in to comment.