Deploy application into Kubernetes.
Command will create Helm Release and wait until all resources of the release are become ready.
Deploy needs the same parameters as push to construct image names: repo and tags. Docker images
names are constructed from parameters as IMAGES_REPO/IMAGE_NAME:TAG. Deploy will fetch built image
ids from Docker repo. So images should be published prior running deploy.
Helm chart directory .helm should exists and contain valid Helm chart.
Environment is a required param for the deploy by default, because it is needed to construct Helm
Release name and Kubernetes Namespace. Either –env or $WERF_ENV should be specified for command
Syntax
werf deploy [options]
Examples
# Deploy project named 'myproject' into 'dev' environment using images from registry.mydomain.com/myproject tagged as mytag with git-tag tagging strategy; helm release name and namespace will be named as 'myproject-dev'
$ werf deploy --stages-storage :local --env dev --images-repo registry.mydomain.com/myproject --tag-git-tag mytag
# Deploy project using specified helm release name and namespace using images from registry.mydomain.com/myproject tagged with docker tag 'myversion'
$ werf deploy --stages-storage :local --release myrelease --namespace myns --images-repo registry.mydomain.com/myproject --tag-custom myversion
Environments
$WERF_SECRET_KEY Use specified secret key to extract secrets for the deploy. Recommended way to
set secret key in CI-system.
Secret key also can be defined in files:
* ~/.werf/global_secret_key (globally),
* .werf_secret_key (per project)
Options
--add-annotation=[]
Add annotation to deploying resources (can specify multiple).
Format: annoName=annoValue.
Also, can be specified with $WERF_ADD_ANNOTATION_* (e.g.
$WERF_ADD_ANNOTATION_1=annoName1=annoValue1",
$WERF_ADD_ANNOTATION_2=annoName2=annoValue2")
--add-label=[]
Add label to deploying resources (can specify multiple).
Format: labelName=labelValue.
Also, can be specified with $WERF_ADD_LABEL_* (e.g.
$WERF_ADD_LABEL_1=labelName1=labelValue1", $WERF_ADD_LABEL_2=labelName2=labelValue2")
--allow-git-shallow-clone=false
Sign the intention of using shallow clone despite restrictions (default
$WERF_ALLOW_GIT_SHALLOW_CLONE)
--config=''
Use custom configuration file (default $WERF_CONFIG or werf.yaml in working directory)
--config-templates-dir=''
Change to the custom configuration templates directory (default
$WERF_CONFIG_TEMPLATES_DIR or .werf in working directory)
--dir=''
Use custom working directory (default $WERF_DIR or current directory)
--docker-config=''
Specify docker config directory path. Default $WERF_DOCKER_CONFIG or $DOCKER_CONFIG or
~/.docker (in the order of priority)
Command needs granted permissions to read and pull images from the specified stages
storage and images repo
--env=''
Use specified environment (default $WERF_ENV)
--git-unshallow=false
Convert project git clone to full one (default $WERF_GIT_UNSHALLOW)
--helm-chart-dir=''
Use custom helm chart dir (default $WERF_HELM_CHART_DIR or .helm in working directory)
--helm-release-storage-namespace='kube-system'
Helm release storage namespace (same as --tiller-namespace for regular helm, default
$WERF_HELM_RELEASE_STORAGE_NAMESPACE, $TILLER_NAMESPACE or 'kube-system')
--helm-release-storage-type='configmap'
helm storage driver to use. One of 'configmap' or 'secret' (default
$WERF_HELM_RELEASE_STORAGE_TYPE or 'configmap')
-h, --help=false
help for deploy
--home-dir=''
Use specified dir to store werf cache files and dirs (default $WERF_HOME or ~/.werf)
--hooks-status-progress-period=5
Hooks status progress period in seconds. Set 0 to stop showing hooks status progress.
Defaults to $WERF_HOOKS_STATUS_PROGRESS_PERIOD_SECONDS or status progress period value
--ignore-secret-key=false
Disable secrets decryption (default $WERF_IGNORE_SECRET_KEY)
-i, --images-repo=''
Docker Repo to store images (default $WERF_IMAGES_REPO)
--images-repo-docker-hub-password=''
Docker Hub password for images repo (default $WERF_IMAGES_REPO_DOCKER_HUB_PASSWORD,
$WERF_REPO_DOCKER_HUB_PASSWORD)
--images-repo-docker-hub-token=''
Docker Hub token for images repo (default $WERF_IMAGES_REPO_DOCKER_HUB_TOKEN,
$WERF_REPO_DOCKER_HUB_TOKEN)
--images-repo-docker-hub-username=''
Docker Hub username for images repo (default $WERF_IMAGES_REPO_DOCKER_HUB_USERNAME,
$WERF_REPO_DOCKER_HUB_USERNAME)
--images-repo-github-token=''
GitHub token for images repo (default $WERF_IMAGES_REPO_GITHUB_TOKEN,
$WERF_REPO_GITHUB_TOKEN)
--images-repo-implementation=''
Choose repo implementation for images repo.
The following docker registry implementations are supported: ecr, acr, default,
dockerhub, gcr, github, gitlab, harbor, quay.
Default $WERF_IMAGES_REPO_IMPLEMENTATION, $WERF_REPO_IMPLEMENTATION or auto mode
(detect implementation by a registry).
--images-repo-mode='auto'
Define how to store in images repo: multirepo or monorepo.
Default $WERF_IMAGES_REPO_MODE or auto mode
--insecure-registry=false
Use plain HTTP requests when accessing a registry (default $WERF_INSECURE_REGISTRY)
--kube-config=''
Kubernetes config file path (default $WERF_KUBE_CONFIG, or $WERF_KUBECONFIG, or
$KUBECONFIG)
--kube-config-base64=''
Kubernetes config data as base64 string (default $WERF_KUBE_CONFIG_BASE64 or
$WERF_KUBECONFIG_BASE64 or $KUBECONFIG_BASE64)
--kube-context=''
Kubernetes config context (default $WERF_KUBE_CONTEXT)
--log-color-mode='auto'
Set log color mode.
Supported on, off and auto (based on the stdout’s file descriptor referring to a
terminal) modes.
Default $WERF_LOG_COLOR_MODE or auto mode.
--log-debug=false
Enable debug (default $WERF_LOG_DEBUG).
--log-pretty=true
Enable emojis, auto line wrapping and log process border (default $WERF_LOG_PRETTY or
true).
--log-project-dir=false
Print current project directory path (default $WERF_LOG_PROJECT_DIR)
--log-quiet=false
Disable explanatory output (default $WERF_LOG_QUIET).
--log-terminal-width=-1
Set log terminal width.
Defaults to:
* $WERF_LOG_TERMINAL_WIDTH
* interactive terminal width or 140
--log-verbose=false
Enable verbose output (default $WERF_LOG_VERBOSE).
--namespace=''
Use specified Kubernetes namespace (default [[ project ]]-[[ env ]] template or
deploy.namespace custom template from werf.yaml or $WERF_NAMESPACE)
--release=''
Use specified Helm release name (default [[ project ]]-[[ env ]] template or
deploy.helmRelease custom template from werf.yaml or $WERF_RELEASE)
--releases-history-max=0
Max releases to keep in release storage. Can be set by environment variable
$WERF_RELEASES_HISTORY_MAX. By default werf keeps all releases.
--repo-docker-hub-password=''
Common Docker Hub password for any stages storage or images repo specified for the
command (default $WERF_REPO_DOCKER_HUB_PASSWORD)
--repo-docker-hub-token=''
Common Docker Hub token for any stages storage or images repo specified for the command
(default $WERF_REPO_DOCKER_HUB_TOKEN)
--repo-docker-hub-username=''
Common Docker Hub username for any stages storage or images repo specified for the
command (default $WERF_REPO_DOCKER_HUB_USERNAME)
--repo-github-token=''
Common GitHub token for any stages storage or images repo specified for the command
(default $WERF_REPO_GITHUB_TOKEN)
--repo-implementation=''
Choose common repo implementation for any stages storage or images repo specified for
the command.
The following docker registry implementations are supported: ecr, acr, default,
dockerhub, gcr, github, gitlab, harbor, quay.
Default $WERF_REPO_IMPLEMENTATION or auto mode (detect implementation by a registry).
--secret-values=[]
Specify helm secret values in a YAML file (can specify multiple).
Also, can be defined with $WERF_SECRET_VALUES_* (e.g.
$WERF_SECRET_VALUES_ENV=.helm/secret_values_test.yaml,
$WERF_SECRET_VALUES_DB=.helm/secret_values_db.yaml)
--set=[]
Set helm values on the command line (can specify multiple or separate values with
commas: key1=val1,key2=val2).
Also, can be defined with $WERF_SET_* (e.g. $WERF_SET_1=key1=val1,
$WERF_SET_2=key2=val2)
--set-string=[]
Set STRING helm values on the command line (can specify multiple or separate values
with commas: key1=val1,key2=val2).
Also, can be defined with $WERF_SET_STRING_* (e.g. $WERF_SET_STRING_1=key1=val1,
$WERF_SET_STRING_2=key2=val2)
--skip-tls-verify-registry=false
Skip TLS certificate validation when accessing a registry (default
$WERF_SKIP_TLS_VERIFY_REGISTRY)
--ssh-key=[]
Use only specific ssh key(s).
Can be specified with $WERF_SSH_KEY_* (e.g. $WERF_SSH_KEY_REPO=~/.ssh/repo_rsa",
$WERF_SSH_KEY_NODEJS=~/.ssh/nodejs_rsa").
Defaults to $WERF_SSH_KEY_*, system ssh-agent or ~/.ssh/{id_rsa|id_dsa}
-s, --stages-storage=''
Docker Repo to store stages or :local for non-distributed build (only :local is
supported for now; default $WERF_STAGES_STORAGE environment)
--stages-storage-repo-docker-hub-password=''
Docker Hub password for stages storage (default
$WERF_STAGES_STORAGE_REPO_DOCKER_HUB_PASSWORD, $WERF_REPO_DOCKER_HUB_PASSWORD)
--stages-storage-repo-docker-hub-token=''
Docker Hub token for stages storage (default
$WERF_STAGES_STORAGE_REPO_DOCKER_HUB_TOKEN, $WERF_REPO_DOCKER_HUB_TOKEN)
--stages-storage-repo-docker-hub-username=''
Docker Hub username for stages storage (default
$WERF_STAGES_STORAGE_REPO_DOCKER_HUB_USERNAME, $WERF_REPO_DOCKER_HUB_USERNAME)
--stages-storage-repo-github-token=''
GitHub token for stages storage (default $WERF_STAGES_STORAGE_REPO_GITHUB_TOKEN,
$WERF_REPO_GITHUB_TOKEN)
--stages-storage-repo-implementation=''
Choose repo implementation for stages storage.
The following docker registry implementations are supported: ecr, acr, default,
dockerhub, gcr, github, gitlab, harbor, quay.
Default $WERF_STAGES_STORAGE_REPO_IMPLEMENTATION, $WERF_REPO_IMPLEMENTATION or auto
mode (detect implementation by a registry).
--status-progress-period=5
Status progress period in seconds. Set -1 to stop showing status progress. Defaults to
$WERF_STATUS_PROGRESS_PERIOD_SECONDS or 5 seconds
-S, --synchronization=''
Address of synchronizer for multiple werf processes to work with a single stages
storage (default :local if --stages-storage=:local or kubernetes://werf-synchronization
if non-local stages-storage specified or $WERF_SYNCHRONIZATION if set). The same
address should be specified for all werf processes that work with a single stages
storage. :local address allows execution of werf processes from a single host only.
--tag-by-stages-signature=false
Use stages-signature tagging strategy and tag each image by the corresponding signature
of last image stage (option can be enabled by specifying
$WERF_TAG_BY_STAGES_SIGNATURE=true)
--tag-custom=[]
Use custom tagging strategy and tag by the specified arbitrary tags.
Option can be used multiple times to produce multiple images with the specified tags.
Also can be specified in $WERF_TAG_CUSTOM_* (e.g. $WERF_TAG_CUSTOM_TAG1=tag1,
$WERF_TAG_CUSTOM_TAG2=tag2)
--tag-git-branch=''
Use git-branch tagging strategy and tag by the specified git branch (option can be
enabled by specifying git branch in the $WERF_TAG_GIT_BRANCH)
--tag-git-commit=''
Use git-commit tagging strategy and tag by the specified git commit hash (option can be
enabled by specifying git commit hash in the $WERF_TAG_GIT_COMMIT)
--tag-git-tag=''
Use git-tag tagging strategy and tag by the specified git tag (option can be enabled by
specifying git tag in the $WERF_TAG_GIT_TAG)
--three-way-merge-mode=''
Set three way merge mode for release.
Supported 'enabled', 'disabled' and 'onlyNewReleases'
-t, --timeout=0
Resources tracking timeout in seconds
--tmp-dir=''
Use specified dir to store tmp files and dirs (default $WERF_TMP_DIR or system tmp dir)
--values=[]
Specify helm values in a YAML file or a URL (can specify multiple).
Also, can be defined with $WERF_VALUES_* (e.g. $WERF_VALUES_ENV=.helm/values_test.yaml,
$WERF_VALUES_DB=.helm/values_db.yaml)
--virtual-merge=false
Enable virtual/ephemeral merge commit mode when building current application state
($WERF_VIRTUAL_MERGE by default)
--virtual-merge-from-commit=''
Commit hash for virtual/ephemeral merge commit with new changes introduced in the pull
request ($WERF_VIRTUAL_MERGE_FROM_COMMIT by default)
--virtual-merge-into-commit=''
Commit hash for virtual/ephemeral merge commit which is base for changes introduced in
the pull request ($WERF_VIRTUAL_MERGE_INTO_COMMIT by default)
