Skip to content

Commit

Permalink
Added more fields from the RFC
Browse files Browse the repository at this point in the history
Signed-off-by: Jesse Brown <jabrown85@gmail.com>
  • Loading branch information
jabrown85 committed Mar 3, 2021
1 parent 4cdddd7 commit 83178a2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,31 +280,40 @@ Usage:
```
/cnb/lifecycle/analyzer \
[-analyzed <analyzed>] \
[-cache-dir <cache-dir>] \
[-cache-image <cache-image>] \
[-daemon] \ # sets <daemon>
[-gid <gid>] \
[-group <group>] \
[-layers <layers>] \
[-log-level <log-level>] \
[-previous-image <previous-image> ] \
[-run-image <run-image> ] \
[-stack-id <stack-id> ] \
[-stack <stack> ] \
[-uid <uid>]
```

##### Inputs
| Input | Environment Variable | Default Value | Description
|-------------------|-----------------------|--------------------------|----------------------
| `<analyzed>` | `CNB_ANALYZED_PATH` | `<layers>/analyzed.toml` | Path to output analysis metadata (see [`analyzed.toml`](#analyzedtoml-toml)
| `<cache-dir>` | `CNB_CACHE_DIR` | | Path to a cache directory
| `<cache-image>` | `CNB_CACHE_IMAGE` | | Location of cache, provided as an image
| `<daemon>` | `CNB_USE_DAEMON` | `false` | Analyze image from docker daemon
| `<gid>` | `CNB_GROUP_ID` | | Primary GID of the stack `User`
| `<group>` | `CNB_GROUP_PATH` | `<layers>/group.toml` | Path to group definition (see [`group.toml`](#grouptoml-toml))
| `<layers>` | `CNB_LAYERS_DIR` | `/layers` | Path to layers directory
| `<log-level>` | `CNB_LOG_LEVEL` | `info` | Log Level
| `<previous-image>`| `CNB_PREVIOUS_IMAGE` | `<image>` | Image reference to be analyzed (usually the result of the previous build)
| `<run-image>` | `CNB_RUN_IMAGE` | resolved from <stack> | Run image reference
| `<stack-id>` | `CNB_STACK_ID` | | Path to stack file (see [`stack.toml`](#stacktoml-toml))
| `<stack>` | `CNB_STACK_PATH` | `/cnb/stack.toml` | Chosen stack ID
| `<uid>` | `CNB_USER_ID` | | UID of the stack `User`

- **If** `<daemon>` is `false`, `<image>` MUST be a valid image reference
- **If** `<daemon>` is `true`, `<image>` MUST be either a valid image reference or an imageID
- **If** `<run-image>` is not provided by the platform the value will be resolved from the contents of stack
- The lifecycle MUST accept valid references to non-existent images without error.

##### Outputs
Expand Down

0 comments on commit 83178a2

Please sign in to comment.