Skip to content

Commit e898cf4

Browse files
author
Natalie Arellano
committed
Fix broken link
Signed-off-by: Natalie Arellano <[email protected]>
1 parent a421317 commit e898cf4

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

content/docs/reference/spec/migration/platform-api-0.10-0.11.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,18 @@ See the [spec release](https://github.com/buildpacks/spec/releases/tag/platform%
1414

1515
In Platform 0.11, the lifecycle ships with standardized SBOM files describing the `lifecycle` and `launcher` binaries
1616
(these are included in the tarball on the GitHub release page and within the image at `index.docker.io/buildpacksio/lifecycle:<version>`).
17-
SBOM files describing the `launcher` are included in the application image at `<layers>/sbom/launch/buildpacksio_lifecycle/launcher/sbom.<ext>`,
17+
18+
After a build, SBOM files describing the `launcher` are included in the application image at `<layers>/sbom/launch/buildpacksio_lifecycle/launcher/sbom.<ext>`,
1819
where `<ext>` is each of: `cdx.json`, `spdx.json`, and `syft.json`.
1920
Additionally, SBOM files describing the `lifecycle` are copied to `<layers>/sbom/build/buildpacksio_lifecycle/sbom.<ext>`,
2021
where they may be saved off by the platform prior to the build container exiting.
2122

2223
This mirrors what is already being done as of Platform 0.8 for buildpack-provided standardized SBOM files,
2324
which are exported to `<layers>/sbom/launch/<buildpack-id>/<layer>/sbom.<ext>` (for runtime dependencies)
2425
and copied to `<layers>/sbom/launch/<buildpack-id>/sbom.<ext>` (for build-time dependencies).
25-
Platforms that are already handling these files should not need to take additional action -
26-
the resulting SBOMs will simply be more complete.
26+
27+
To use this feature, no additional action is required from platforms that are already handling buildpack-provided SBOM files.
28+
The SBOMs for the image will simply be more complete.
2729

2830
### The rebaser accepts a -previous-image flag to allow rebasing by digest reference
2931

content/docs/reference/spec/migration/platform-api-0.11-0.12.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,24 @@ If `-force` is not provided,
5757

5858
In Platform 0.12, extensions can be used to extend not only build-time base images, but runtime base images as well.
5959

60+
#### During build
61+
6062
To use the feature, platforms should:
6163
* Invoke `analyzer` as usual for Platform 0.12
6264
* Invoke `detector` with the `-run` flag, to specify the location of a `run.toml` file containing run image information
6365
* When extensions switch the run image, this is used to log a warning if the new run image is not a known run image
6466
* Invoke `restorer` with the `-dameon` flag (newly added in this Platform API version) if the export target is a daemon
6567
* When extensions switch the run image, the `restorer` must re-read target data from the new run image in order to provide this information to buildpacks; if `-daemon` is provided the `restorer` will look for the run image in a daemon instead of a registry
6668
* When extensions extend the run image, the `-daemon` flag has no effect as the `restorer` must be able to pull the run image manifest from a registry
67-
* Invoke `extender` as usual to extend the builder image (see [migration guide](TODO) for Platform 0.10)
69+
* Invoke `extender` as usual to extend the builder image (see [migration guide](/docs/reference/spec/migration/platform-api-0.9-0.10/index.html) for Platform 0.10)
6870
* Inspect the contents of `analyzed.toml` - if `run-image.extend` is `true` we must run the `extender` on the run image
6971
* Using the **run image** as the basis for the container, invoke `extender` with flags `-kind run` and `-extended <extended dir>`
7072
* `<extended dir>` is the directory where layers from applying each `run.Dockerfile` to the run image will be saved for use by the `exporter`; it defaults to `<layers>/extended`
73+
* Run image extension may be done in parallel with builder image extension
7174
* Invoke `exporter` with the `-extended` flag
7275

76+
#### After build
77+
7378
Note that unlike buildpack-provided layers, layers from extensions may NOT be safe to rebase.
7479
The `io.buildpacks.rebasable` label on the exported application image will be `false` if rebase is unsafe.
7580
The `-force` flag must be provided to the `rebaser` in order to rebase images with unsafe extension layers,

0 commit comments

Comments
 (0)