Skip to content

Commit

Permalink
Add details for exporter
Browse files Browse the repository at this point in the history
Signed-off-by: Natalie Arellano <[email protected]>
  • Loading branch information
natalieparellano committed Feb 16, 2022
1 parent 6135181 commit 5fb5f47
Showing 1 changed file with 22 additions and 21 deletions.
43 changes: 22 additions & 21 deletions platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,26 +526,27 @@ Usage:
```

##### Inputs
| Input | Environment Variable | Default Value | Description
|---------------------|----------------------------|---------------------|---------------------------------------
| `<analyzed>` | `CNB_ANALYZED_PATH` | `<layers>/analyzed.toml` | Path to analysis metadata (see [`analyzed.toml`](#analyzedtoml-toml)
| `<app>` | `CNB_APP_DIR` | `/workspace` | Path to application directory
| `<cache-dir>` | `CNB_CACHE_DIR` | | Path to a cache directory
| `<cache-image>` | `CNB_CACHE_IMAGE` | | Reference to a cache image in an OCI image registry
| `<daemon>` | `CNB_USE_DAEMON` | `false` | Export image to docker daemon
| `<gid>` | `CNB_GROUP_ID` | | Primary GID of the build image `User`
| `<group>` | `CNB_GROUP_PATH` | `<layers>/group.toml` | Path to group file (see [`group.toml`](#grouptoml-toml))
| `<image>` | | | Tag reference to which the app image will be written
| `<launch-cache>` | `CNB_LAUNCH_CACHE_DIR` | | Path to a cache directory containing launch layers
| `<launcher>` | | `/cnb/lifecycle/launcher` | Path to the `launcher` executable
| `<layers>` | `CNB_LAYERS_DIR` | `/layers` | Path to layer directory
| `<log-level>` | `CNB_LOG_LEVEL` | `info` | Log Level
| `<process-type>` | `CNB_PROCESS_TYPE` | | Default process type to set in the exported image
| `<project-metadata>`| `CNB_PROJECT_METADATA_PATH`| `<layers>/project-metadata.toml` | Path to a project metadata file (see [`project-metadata.toml`](#project-metadatatoml-toml)
| `<report>` | `CNB_REPORT_PATH` | `<layers>/report.toml` | Path to report (see [`report.toml`](#reporttoml-toml)
| `<stack>` | `CNB_STACK_PATH` | `/cnb/stack.toml` | Path to stack file (see [`stack.toml`](#stacktoml-toml)
| `<uid>` | `CNB_USER_ID` | | UID of the build image `User`
| `<layers>/config/metadata.toml` | | | Build metadata (see [`metadata.toml`](#metadatatoml-toml)
| Input | Environment Variable | Default Value | Description |
|---------------------------------|-----------------------------|----------------------------------|--------------------------------------------------------------------------------------------|
| `<analyzed>` | `CNB_ANALYZED_PATH` | `<layers>/analyzed.toml` | Path to analysis metadata (see [`analyzed.toml`](#analyzedtoml-toml) |
| `<app>` | `CNB_APP_DIR` | `/workspace` | Path to application directory |
| `<cache-dir>` | `CNB_CACHE_DIR` | | Path to a cache directory |
| `<cache-image>` | `CNB_CACHE_IMAGE` | | Reference to a cache image in an OCI image registry |
| `<daemon>` | `CNB_USE_DAEMON` | `false` | Export image to docker daemon |
| `<gid>` | `CNB_GROUP_ID` | | Primary GID of the build image `User` |
| `<group>` | `CNB_GROUP_PATH` | `<layers>/group.toml` | Path to group file (see [`group.toml`](#grouptoml-toml)) |
| `<image>` | | | Tag reference to which the app image will be written |
| `<launch-cache>` | `CNB_LAUNCH_CACHE_DIR` | | Path to a cache directory containing launch layers |
| `<launcher>` | | `/cnb/lifecycle/launcher` | Path to the `launcher` executable |
| `<layers>` | `CNB_LAYERS_DIR` | `/layers` | Path to layer directory |
| `<log-level>` | `CNB_LOG_LEVEL` | `info` | Log Level |
| `<process-type>` | `CNB_PROCESS_TYPE` | | Default process type to set in the exported image |
| `<project-metadata>` | `CNB_PROJECT_METADATA_PATH` | `<layers>/project-metadata.toml` | Path to a project metadata file (see [`project-metadata.toml`](#project-metadatatoml-toml) |
| `<report>` | `CNB_REPORT_PATH` | `<layers>/report.toml` | Path to report (see [`report.toml`](#reporttoml-toml) |
| `<stack>` | `CNB_STACK_PATH` | `/cnb/stack.toml` | Path to stack file (see [`stack.toml`](#stacktoml-toml) |
| `<uid>` | `CNB_USER_ID` | | UID of the build image `User` |
| `<layers>/config/metadata.toml` | | | Build metadata (see [`metadata.toml`](#metadatatoml-toml) |
| | `SOURCE_DATE_EPOCH` | | Timestamp for `created` time in app image config |

- At least one `<image>` must be provided
- Each `<image>` MUST be a valid tag reference
Expand Down Expand Up @@ -601,7 +602,7 @@ Usage:
- `io.buildpacks.build.metadata`: see [build metadata](#iobuildpacksbuildmetadata-json)
- To ensure [build reproducibility](#build-reproducibility), the lifecycle:
- SHOULD set the modification time of all files in newly created layers to a constant value
- SHOULD set the `created` time in image config to a constant value
- SHOULD set the `created` time in image config to `SOURCE_DATE_EPOCH`, or to a constant value if not defined

- The lifecycle SHALL write a [report](#reporttoml-toml) to `<report>` describing the exported app image

Expand Down

0 comments on commit 5fb5f47

Please sign in to comment.