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

Finalize Platform 0.14 #410

Merged
merged 4 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ These documents currently specify:

- Buildpack API: `0.10`
- Distribution API: `0.3`
- Platform API: `0.12`
- Platform API: `0.14`
11 changes: 7 additions & 4 deletions platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Examples of a platform might include:

## Platform API Version

This document specifies Platform API version `0.12`.
This document specifies Platform API version `0.14`.

Platform API versions:
- MUST be in form `<major>.<minor>` or `<major>`, where `<major>` is equivalent to `<major>.0`
Expand Down Expand Up @@ -479,7 +479,8 @@ Usage:
[-layers <layers>] \
[-log-level <log-level>] \
[-skip-layers <skip-layers>] \
[-uid <uid>]
[-uid <uid>] \
[-run <run> ]
```

##### Inputs
Expand All @@ -499,11 +500,13 @@ Usage:
| `<log-level>` | `CNB_LOG_LEVEL` | `info` | Log Level |
| `<skip-layers>` | `CNB_SKIP_LAYERS` | `false` | Do not perform [layer restoration](#layer-restoration) |
| `<uid>` | `CNB_USER_ID` | | UID of the build image `User` |

| `<run>`** | `CNB_RUN_PATH` | `/cnb/run.toml` | Path to run file (see [`run.toml`](#runtoml-toml)) |
> ^ Only needed when using image extensions

> \* Only needed when using image extensions to extend the build image

> \** Only needed when using image extensions to extend the run image

##### Outputs

| Output | Description |
Expand Down Expand Up @@ -533,7 +536,7 @@ Usage:
- MUST record the digest reference to the provided `<build-image>` in `<analyzed>`
- MUST copy the OCI manifest and config file for `<build-image>` to `<kaniko-dir>/cache`
- The lifecycle:
- MUST resolve `run-image.reference` to a digest reference in `<analyzed>` if not present
- MUST [resolve mirrors](#run-image-resolution) for the `run-image.reference` in `<analyzed>` and resolve it to a digest reference
- MUST populate `run-image.target` data in `<analyzed>` if not present
- **If** `<analyzed>` has `run-image.extend = true`, the lifecycle:
- MUST download from the registry and save in OCI layout format the `run-image` in `<analyzed>` to `<kaniko-dir>/cache`
Expand Down