Add missing flags/options to README, sort them
This commit is contained in:
Thomas Stromberg
parent
f79492b0cd
commit
c0b88a03de
149
README.md
149
README.md
|
|
@ -25,6 +25,7 @@ _If you are interested in contributing to kaniko, see [DEVELOPMENT.md](DEVELOPME
|
||||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||||
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
|
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
|
||||||
|
|
||||||
|
- [kaniko - Build Images In Kubernetes](#kaniko---build-images-in-kubernetes)
|
||||||
- [Community](#community)
|
- [Community](#community)
|
||||||
- [How does kaniko work?](#how-does-kaniko-work)
|
- [How does kaniko work?](#how-does-kaniko-work)
|
||||||
- [Known Issues](#known-issues)
|
- [Known Issues](#known-issues)
|
||||||
|
|
@ -34,6 +35,7 @@ _If you are interested in contributing to kaniko, see [DEVELOPMENT.md](DEVELOPME
|
||||||
- [kaniko Build Contexts](#kaniko-build-contexts)
|
- [kaniko Build Contexts](#kaniko-build-contexts)
|
||||||
- [Using Azure Blob Storage](#using-azure-blob-storage)
|
- [Using Azure Blob Storage](#using-azure-blob-storage)
|
||||||
- [Using Private Git Repository](#using-private-git-repository)
|
- [Using Private Git Repository](#using-private-git-repository)
|
||||||
|
- [Using Standard Input](#using-standard-input)
|
||||||
- [Running kaniko](#running-kaniko)
|
- [Running kaniko](#running-kaniko)
|
||||||
- [Running kaniko in a Kubernetes cluster](#running-kaniko-in-a-kubernetes-cluster)
|
- [Running kaniko in a Kubernetes cluster](#running-kaniko-in-a-kubernetes-cluster)
|
||||||
- [Kubernetes secret](#kubernetes-secret)
|
- [Kubernetes secret](#kubernetes-secret)
|
||||||
|
|
@ -52,30 +54,35 @@ _If you are interested in contributing to kaniko, see [DEVELOPMENT.md](DEVELOPME
|
||||||
- [--cache](#--cache)
|
- [--cache](#--cache)
|
||||||
- [--cache-dir](#--cache-dir)
|
- [--cache-dir](#--cache-dir)
|
||||||
- [--cache-repo](#--cache-repo)
|
- [--cache-repo](#--cache-repo)
|
||||||
|
- [--cache-ttl duration](#--cache-ttl-duration)
|
||||||
|
- [--cleanup](#--cleanup)
|
||||||
- [--context-sub-path](#--context-sub-path)
|
- [--context-sub-path](#--context-sub-path)
|
||||||
- [--digest-file](#--digest-file)
|
- [--digest-file](#--digest-file)
|
||||||
- [--oci-layout-path](#--oci-layout-path)
|
- [--force](#--force)
|
||||||
- [--insecure-registry](#--insecure-registry)
|
- [--git](#--git)
|
||||||
- [--skip-tls-verify-registry](#--skip-tls-verify-registry)
|
- [--image-name-with-digest-file](#--image-name-with-digest-file)
|
||||||
- [--cleanup](#--cleanup)
|
|
||||||
- [--insecure](#--insecure)
|
- [--insecure](#--insecure)
|
||||||
- [--insecure-pull](#--insecure-pull)
|
- [--insecure-pull](#--insecure-pull)
|
||||||
|
- [--insecure-registry](#--insecure-registry)
|
||||||
|
- [--label](#--label)
|
||||||
- [--log-format](#--log-format)
|
- [--log-format](#--log-format)
|
||||||
- [--log-timestamp](#--log-timestamp)
|
- [--log-timestamp](#--log-timestamp)
|
||||||
- [--no-push](#--no-push)
|
- [--no-push](#--no-push)
|
||||||
|
- [--oci-layout-path](#--oci-layout-path)
|
||||||
- [--registry-certificate](#--registry-certificate)
|
- [--registry-certificate](#--registry-certificate)
|
||||||
- [--registry-mirror](#--registry-mirror)
|
- [--registry-mirror](#--registry-mirror)
|
||||||
- [--reproducible](#--reproducible)
|
- [--reproducible](#--reproducible)
|
||||||
- [--single-snapshot](#--single-snapshot)
|
- [--single-snapshot](#--single-snapshot)
|
||||||
- [--skip-tls-verify](#--skip-tls-verify)
|
- [--skip-tls-verify](#--skip-tls-verify)
|
||||||
- [--skip-tls-verify-pull](#--skip-tls-verify-pull)
|
- [--skip-tls-verify-pull](#--skip-tls-verify-pull)
|
||||||
|
- [--skip-tls-verify-registry](#--skip-tls-verify-registry)
|
||||||
|
- [--skip-unused-stages](#--skip-unused-stages)
|
||||||
- [--snapshotMode](#--snapshotmode)
|
- [--snapshotMode](#--snapshotmode)
|
||||||
- [--target](#--target)
|
|
||||||
- [--tarPath](#--tarpath)
|
- [--tarPath](#--tarpath)
|
||||||
|
- [--target](#--target)
|
||||||
|
- [--use-new-run](#--use-new-run)
|
||||||
- [--verbosity](#--verbosity)
|
- [--verbosity](#--verbosity)
|
||||||
- [--whitelist-var-run](#--whitelist-var-run)
|
- [--whitelist-var-run](#--whitelist-var-run)
|
||||||
- [--label](#--label)
|
|
||||||
- [--skip-unused-stages](#--skip-unused-stages)
|
|
||||||
- [Debug Image](#debug-image)
|
- [Debug Image](#debug-image)
|
||||||
- [Security](#security)
|
- [Security](#security)
|
||||||
- [Comparison with Other Tools](#comparison-with-other-tools)
|
- [Comparison with Other Tools](#comparison-with-other-tools)
|
||||||
|
|
@ -158,7 +165,7 @@ gsutil cp context.tar.gz gs://<bucket name>
|
||||||
When running kaniko, use the `--context` flag with the appropriate prefix to specify the location of your build context:
|
When running kaniko, use the `--context` flag with the appropriate prefix to specify the location of your build context:
|
||||||
|
|
||||||
| Source | Prefix | Example |
|
| Source | Prefix | Example |
|
||||||
|---------|---------|---------|
|
| ------------------ | --------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| Local Directory | dir://[path to a directory in the kaniko container] | `dir:///workspace` |
|
| Local Directory | dir://[path to a directory in the kaniko container] | `dir:///workspace` |
|
||||||
| Local Tar Gz | tar://[path to a .tar.gz in the kaniko container] | `tar://path/to/context.tar.gz` |
|
| Local Tar Gz | tar://[path to a .tar.gz in the kaniko container] | `tar://path/to/context.tar.gz` |
|
||||||
| Standard Input | tar://[stdin] | `tar://stdin` |
|
| Standard Input | tar://[stdin] | `tar://stdin` |
|
||||||
|
|
@ -535,6 +542,14 @@ If `--destination=gcr.io/kaniko-project/test`, then cached layers will be stored
|
||||||
|
|
||||||
_This flag must be used in conjunction with the `--cache=true` flag._
|
_This flag must be used in conjunction with the `--cache=true` flag._
|
||||||
|
|
||||||
|
#### --cache-ttl duration
|
||||||
|
|
||||||
|
Cache timeout in hours. Defaults to two weeks.
|
||||||
|
|
||||||
|
#### --cleanup
|
||||||
|
|
||||||
|
Set this flag to clean the filesystem at the end of the build.
|
||||||
|
|
||||||
#### --context-sub-path
|
#### --context-sub-path
|
||||||
|
|
||||||
Set a sub path within the given `--context`.
|
Set a sub path within the given `--context`.
|
||||||
|
|
@ -553,6 +568,47 @@ will write the digest to that file, which is picked up by
|
||||||
Kubernetes automatically as the `{{.state.terminated.message}}`
|
Kubernetes automatically as the `{{.state.terminated.message}}`
|
||||||
of the container.
|
of the container.
|
||||||
|
|
||||||
|
#### --force
|
||||||
|
|
||||||
|
Force building outside of a container
|
||||||
|
|
||||||
|
#### --git
|
||||||
|
|
||||||
|
Branch to clone if build context is a git repository (default branch=,single-branch=false,recurse-submodules=false)
|
||||||
|
|
||||||
|
#### --image-name-with-digest-file
|
||||||
|
|
||||||
|
Specify a file to save the image name w/ digest of the built image to.
|
||||||
|
|
||||||
|
#### --insecure
|
||||||
|
|
||||||
|
Set this flag if you want to push images to a plain HTTP registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
|
||||||
|
#### --insecure-pull
|
||||||
|
|
||||||
|
Set this flag if you want to pull images from a plain HTTP registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
|
||||||
|
#### --insecure-registry
|
||||||
|
|
||||||
|
Set this flag to use plain HTTP requests when accessing a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
You can set it multiple times for multiple registries.
|
||||||
|
|
||||||
|
#### --label
|
||||||
|
|
||||||
|
Set this flag as `--label key=value` to set some metadata to the final image. This is equivalent as using the `LABEL` within the Dockerfile.
|
||||||
|
|
||||||
|
#### --log-format
|
||||||
|
|
||||||
|
Set this flag as `--log-format=<text|color|json>` to set the log format. Defaults to `color`.
|
||||||
|
|
||||||
|
#### --log-timestamp
|
||||||
|
|
||||||
|
Set this flag as `--log-timestamp=<true|false>` to add timestamps to `<text|color>` log format. Defaults to `false`.
|
||||||
|
|
||||||
|
#### --no-push
|
||||||
|
|
||||||
|
Set this flag if you only want to build the image, without pushing to a registry.
|
||||||
|
|
||||||
#### --oci-layout-path
|
#### --oci-layout-path
|
||||||
|
|
||||||
Set this flag to specify a directory in the container where the OCI image
|
Set this flag to specify a directory in the container where the OCI image
|
||||||
|
|
@ -566,31 +622,6 @@ this flag should be set to match the image resource `outputImageDir`.
|
||||||
_Note: Depending on the built image, the media type of the image manifest might be either
|
_Note: Depending on the built image, the media type of the image manifest might be either
|
||||||
`application/vnd.oci.image.manifest.v1+json` or `application/vnd.docker.distribution.manifest.v2+json`._
|
`application/vnd.oci.image.manifest.v1+json` or `application/vnd.docker.distribution.manifest.v2+json`._
|
||||||
|
|
||||||
#### --insecure-registry
|
|
||||||
|
|
||||||
Set this flag to use plain HTTP requests when accessing a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
|
||||||
You can set it multiple times for multiple registries.
|
|
||||||
|
|
||||||
#### --skip-tls-verify-registry
|
|
||||||
|
|
||||||
Set this flag to skip TLS certificate validation when accessing a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
|
||||||
You can set it multiple times for multiple registries.
|
|
||||||
|
|
||||||
#### --cleanup
|
|
||||||
|
|
||||||
Set this flag to clean the filesystem at the end of the build.
|
|
||||||
|
|
||||||
#### --insecure
|
|
||||||
|
|
||||||
Set this flag if you want to push images to a plain HTTP registry. It is supposed to be used for testing purposes only and should not be used in production!
|
|
||||||
|
|
||||||
#### --insecure-pull
|
|
||||||
|
|
||||||
Set this flag if you want to pull images from a plain HTTP registry. It is supposed to be used for testing purposes only and should not be used in production!
|
|
||||||
|
|
||||||
#### --no-push
|
|
||||||
|
|
||||||
Set this flag if you only want to build the image, without pushing to a registry.
|
|
||||||
|
|
||||||
#### --registry-certificate
|
#### --registry-certificate
|
||||||
|
|
||||||
|
|
@ -598,10 +629,13 @@ Set this flag to provide a certificate for TLS communication with a given regist
|
||||||
|
|
||||||
Expected format is `my.registry.url=/path/to/the/certificate.cert`
|
Expected format is `my.registry.url=/path/to/the/certificate.cert`
|
||||||
|
|
||||||
|
|
||||||
#### --registry-mirror
|
#### --registry-mirror
|
||||||
|
|
||||||
Set this flag if you want to use a registry mirror instead of default `index.docker.io`.
|
Set this flag if you want to use a registry mirror instead of default `index.docker.io`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### --reproducible
|
#### --reproducible
|
||||||
|
|
||||||
Set this flag to strip timestamps out of the built image and make it reproducible.
|
Set this flag to strip timestamps out of the built image and make it reproducible.
|
||||||
|
|
@ -610,6 +644,7 @@ Set this flag to strip timestamps out of the built image and make it reproducibl
|
||||||
|
|
||||||
This flag takes a single snapshot of the filesystem at the end of the build, so only one layer will be appended to the base image.
|
This flag takes a single snapshot of the filesystem at the end of the build, so only one layer will be appended to the base image.
|
||||||
|
|
||||||
|
|
||||||
#### --skip-tls-verify
|
#### --skip-tls-verify
|
||||||
|
|
||||||
Set this flag to skip TLS certificate validation when pushing to a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
Set this flag to skip TLS certificate validation when pushing to a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
|
@ -618,46 +653,48 @@ Set this flag to skip TLS certificate validation when pushing to a registry. It
|
||||||
|
|
||||||
Set this flag to skip TLS certificate validation when pulling from a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
Set this flag to skip TLS certificate validation when pulling from a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
|
||||||
|
#### --skip-tls-verify-registry
|
||||||
|
|
||||||
|
Set this flag to skip TLS certificate validation when accessing a registry. It is supposed to be used for testing purposes only and should not be used in production!
|
||||||
|
You can set it multiple times for multiple registries.
|
||||||
|
|
||||||
|
#### --skip-unused-stages
|
||||||
|
|
||||||
|
This flag builds only used stages if defined to `true`.
|
||||||
|
Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile
|
||||||
|
|
||||||
#### --snapshotMode
|
#### --snapshotMode
|
||||||
|
|
||||||
You can set the `--snapshotMode=<full (default), time>` flag to set how kaniko will snapshot the filesystem.
|
You can set the `--snapshotMode=<full (default), redo, time>` flag to set how kaniko will snapshot the filesystem.
|
||||||
If `--snapshotMode=time` is set, only file mtime will be considered when snapshotting (see
|
|
||||||
|
* If `--snapshot=full` is set, the full file contents and metadata are considered when snapshotting. This is the least performant option, but also the most robust.
|
||||||
|
|
||||||
|
* If `--snapshotMode=redo` is set, the file mtime, size, mode, owner uid and gid will be considered when snapshotting. This may be up to 50% faster than "full", particularly if your project has a large number files.
|
||||||
|
|
||||||
|
* If `--snapshotMode=time` is set, only file mtime will be considered when snapshotting (see
|
||||||
[limitations related to mtime](#mtime-and-snapshotting)).
|
[limitations related to mtime](#mtime-and-snapshotting)).
|
||||||
|
|
||||||
#### --target
|
|
||||||
|
|
||||||
Set this flag to indicate which build stage is the target build stage.
|
|
||||||
|
|
||||||
#### --tarPath
|
#### --tarPath
|
||||||
|
|
||||||
Set this flag as `--tarPath=<path>` to save the image as a tarball at path instead of pushing the image.
|
Set this flag as `--tarPath=<path>` to save the image as a tarball at path instead of pushing the image.
|
||||||
You need to set `--destination` as well (for example `--destination=image`).
|
You need to set `--destination` as well (for example `--destination=image`).
|
||||||
|
|
||||||
|
#### --target
|
||||||
|
|
||||||
|
Set this flag to indicate which build stage is the target build stage.
|
||||||
|
|
||||||
|
#### --use-new-run
|
||||||
|
|
||||||
|
Use the experimental run implementation for detecting changes without requiring file system snapshots. In some cases, this may improve build performance by 75%.
|
||||||
|
|
||||||
#### --verbosity
|
#### --verbosity
|
||||||
|
|
||||||
Set this flag as `--verbosity=<panic|fatal|error|warn|info|debug|trace>` to set the logging level. Defaults to `info`.
|
Set this flag as `--verbosity=<panic|fatal|error|warn|info|debug|trace>` to set the logging level. Defaults to `info`.
|
||||||
|
|
||||||
#### --log-format
|
|
||||||
|
|
||||||
Set this flag as `--log-format=<text|color|json>` to set the log format. Defaults to `color`.
|
|
||||||
|
|
||||||
#### --log-timestamp
|
|
||||||
|
|
||||||
Set this flag as `--log-timestamp=<true|false>` to add timestamps to `<text|color>` log format. Defaults to `false`.
|
|
||||||
|
|
||||||
#### --whitelist-var-run
|
#### --whitelist-var-run
|
||||||
|
|
||||||
Ignore /var/run when taking image snapshot. Set it to false to preserve /var/run/* in destination image. (Default true).
|
Ignore /var/run when taking image snapshot. Set it to false to preserve /var/run/* in destination image. (Default true).
|
||||||
|
|
||||||
#### --label
|
|
||||||
|
|
||||||
Set this flag as `--label key=value` to set some metadata to the final image. This is equivalent as using the `LABEL` within the Dockerfile.
|
|
||||||
|
|
||||||
#### --skip-unused-stages
|
|
||||||
|
|
||||||
This flag builds only used stages if defined to `true`.
|
|
||||||
Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile
|
|
||||||
|
|
||||||
### Debug Image
|
### Debug Image
|
||||||
|
|
||||||
The kaniko executor image is based on scratch and doesn't contain a shell.
|
The kaniko executor image is based on scratch and doesn't contain a shell.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue