Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates platform spec for stack metadata RFC #89

Merged
merged 5 commits into from
Oct 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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