Skip to content

Commit

Permalink
chore(docs): add new flags to table (#198)
Browse files Browse the repository at this point in the history
  • Loading branch information
ecrupper authored Aug 20, 2024
1 parent 5d056a0 commit 0e69356
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,15 +249,18 @@ The following parameters are used to configure the image:
| `cache_repo` | specific repo to enable caching for | `false` | `N/A` | `PARAMETER_CACHE_REPO`<br>`KANIKO_CACHE_REPO` |
| `compression` | compression to use (`gzip` or `zstd` - kaniko uses `gzip` if not defined) | `false` | `N/A` | `PARAMETER_COMPRESSION`<br>`KANIKO_COMPRESSION` |
| `compression_level` | compression level to use (1 - 9, inclusive) | `false` | `N/A` | `PARAMETER_COMPRESSION_LEVEL`<br>`KANIKO_COMPRESSION_LEVEL` |
| `compressed_caching` | set this to false in order to prevent tar compression for cached layers | `false` | `true` | `PARAMETER_COMPRESSED_CACHING`<br>`KANIKO_COMPRESSED_CACHING` |
| `context` | path to context for building the image | `true` | `.` | `PARAMETER_CONTEXT`<br>`KANIKO_CONTEXT` |
| `dockerfile` | path to the file for building the image | `true` | `Dockerfile` | `PARAMETER_DOCKERFILE`<br>`KANIKO_DOCKERFILE` |
| `dry_run` | enable building the image without publishing | `false` | `false` | `PARAMETER_DRY_RUN`<br>`KANIKO_DRY_RUN` |
| `event` | event generated for build | `true` | **set by Vela** | `PARAMETER_EVENT`<br>`KANIKO_EVENT`<br>`VELA_BUILD_EVENT` |
| `force_build_metadata` | enable force adding metadata layers to build image | `false` | `false` | `PARAMETER_FORCE_BUILD_METADATA`<br>`KANIKO_FORCE_BUILD_METADATA` |
| `repo_topics_filter` | regex expression to filter out repository topics | `false` | `empty slice` | `PARAMETER_REPO_TOPICS_FILTER`<br>`KANIKO_REPO_TOPICS_FILTER` |
| `ignore_path` | ignore path when taking an image snapshot | `false` | `empty slice` | `PARAMETER_IGNORE_PATH`<br>`KANIKO_IGNORE_PATH` |
| `ignore_var_run` | sets `--ignore-var-run` kaniko flag to control whether /var/run is included in image snapshot | `false` | `true` | `PARAMETER_IGNORE_VAR_RUN`<br>`KANIKO_IGNORE_VAR_RUN`<br>`VELA_IGNORE_VAR_RUN` |
| `labels` | unique labels to add to the image | `false` | `N/A` | `PARAMETER_LABELS`<br>`KANIKO_LABELS` |
| `log_level` | set the log level for the plugin | `true` | `info` | `PARAMETER_LOG_LEVEL`<br>`KANIKO_LOG_LEVEL` |
| `log_timestamps` | add timestamps to log lines | `false` | `false` | `PARAMETER_LOG_TIMESTAMPS`<br>`KANIKO_LOG_TIMESTAMPS` |
| `mirror` | name of the mirror registry to use | `false` | `N/A` | `PARAMETER_MIRROR`<br>`KANIKO_MIRROR` |
| `password` | password for communication with the registry | `true` | `N/A` | `PARAMETER_PASSWORD`<br>`KANIKO_PASSWORD`<br>`DOCKER_PASSWORD` |
| `push_retry` | number of retries for pushing an image to a remote destination | `false` | `0` | `PARAMETER_PUSH_RETRY`<br>`KANIKO_PUSH_RETRY` |
Expand Down

0 comments on commit 0e69356

Please sign in to comment.