werf.yaml | Reference

0	---	# Meta section
	...
1	project: string !	# Unique project name
2	configVersion: int !	# Config syntax version. It should always be 1 for now
3	build:	# Common build settings
	...
4	cacheVersion: string	# Cache version
5	platform: [ string, ... ]	# Common list of target platforms for all images (for example ['linux/amd64', 'linux/arm64', 'linux/arm/v8'])
6	staged: bool	# Enable layer-by-layer caching of Dockerfile instructions in container registry globally for all images
7	imageSpec:	# Global image configuration options according to the OCI specification, which will be applied to all images. More details here
	...
8	author: string	# Author of the image
9	clearHistory: bool	# Remove all image build history
10	config:	# Common image configuration
	...
11	labels: { name string: value string, ... }	# List of labels to add
12	removeLabels: [ string \|\| /REGEXP/, ... ]	# List of labels to remove
13	keepEssentialWerfLabels: bool	# Do not remove werf labels necessary for normal operation
14	deploy:	# Settings for deployment
	...
15	helmChartDir: string	# Path to the helm chart directory of the project (default `.helm`)
16	helmChartConfig:	# Override Chart.yaml configuration
	...
17	appVersion: string	# Override appVersion in Chart.yaml
18	helmRelease: string	# Release name template (default `[[ project ]]-[[ env ]]`)
19	helmReleaseSlug: bool	# Release name slugification (default `true`)
20	namespace: string	# Kubernetes namespace template (default `[[ project ]]-[[ env ]]`)
21	namespaceSlug: bool	# Kubernetes namespace slugification (default `true`)
22	cleanup:	# Settings for cleaning up irrelevant images
	...
23	disableKubernetesBasedPolicy: bool	# Disable a cleanup policy that allows not to remove images deployed in Kubernetes from the container registry
24	disableGitHistoryBasedPolicy: bool	# Disable a cleanup policy that allows not to remove images taking into account user-defined policies by the Git history (keepPolicies)
25	disableBuiltWithinLastNHoursPolicy: bool	# Disable a cleanup policy that allows not to remove images built in last hours (keepImagesBuiltWithinLastNHours)
26	keepImagesBuiltWithinLastNHours: uint	# The minimum number of hours that must elapse since the image is built (default `2`)
27	keepPolicies:	# Set of policies to select relevant image versions using the Git history
28	- references:	# References to perform scanning on
29	branch: string \|\| /REGEXP/	# One or more git origin branches
30	tag: string \|\| /REGEXP/	# One or more git origin tags
31	limit:	# The set of rules to limit references on the basis of the date when the git tag was created or the activity in the git branch
32	last: int	# To select n last references last n references from those defined in the branch or tag (default `-1`)
33	in: duration string	# To select git tags that were created during the specified period or git branches that were active during the period
34	operator: And \|\| Or	# Check both conditions or any of them (default `And`)
35	imagesPerReference:	# The limit on the number of image versions for each reference contained in the set
36	last: int	# The number of image versions to search for each reference (default `-1`)
37	in: duration string	# The time frame in which werf searches for images
38	gitWorktree:	# Configure how werf handles git worktree of the project
	...
39	forceShallowClone: bool	# Force werf to use shallow clone despite restrictions
40	allowUnshallow: bool	# Allow werf to automatically convert project shallow git clone to full one during build process when needed (default `true`)
41	allowFetchOriginBranchesAndTags: bool	# Allow werf to synchronize git branches and tags with remote origin during cleanup process when needed (default `true`)
42	---	# Dockerfile image section: optional, define as many image sections as you need
	...
43	image: string \|\| [ string, ... ] !	# One or more unique names for image
44	final: bool	# Mark image as final (default `true`). More details here
45	dockerfile: string !	# Dockerfile path relative to the context PATH
46	staged: bool	# Enable layer-by-layer caching of Dockerfile instructions in container registry
47	cacheVersion: string	# Cache version
48	context: string	# Build context PATH inside project directory
49	platform: [ string, ... ]	# List of target platforms for this image (for example ['linux/amd64', 'linux/arm64', 'linux/arm/v8'])
50	contextAddFiles: [ string, ... ]	# Untracked files and directories for adding to build context. The paths must be relative to context PATH
51	target: string	# Specific Dockerfile stage (last one by default, similar to the docker build --target option)
52	args: { name string: value string, ... }	# Variables for ARG dockerfile instructions (similar to the docker build --build-arg option)
53	addHost: [ string, ... ]	# Custom host-to-IP mapping (host:ip) (similar to the docker build --add-host option)
54	network: string	# The networking mode for the RUN instructions during build (similar to the docker build --network option)
55	ssh: string	# SSH agent socket or keys to the build (similar to the docker build --ssh option) (DEPRECATED). More details here
56	secrets:	# Secrets used in image build. Only one of the following options can be used in a single instance: env, src, or value. More details here
57	- id: string	# Secret unique identifier (mandatory only for the value type)
58	env: string	# A secret from an environment variable
59	src: string	# A secret from a file at the given path
60	value: string	# Custom string value
61	dependencies:	# Dependencies images for current image
	...
62	- image: string	# Dependency image name, which should be built before building current image
63	imports:	# Define target build args to import image information into current image (optional)
64	- type: string	# Type of image info: ImageName, ImageDigest, ImageRepo or ImageTag
65	targetBuildArg: string	# Name of build argument which will contain specified type of information about image
66	imageSpec:	# Image configuration according to the OCI specification. More details here
67	author: string	# Author of the image
68	clearHistory: bool	# Remove all image build history
69	config:	# Common image configuration
	...
70	volumes: [string, ...]	# List of volumes to add. More details here
71	removeVolumes: [string, ...]	# List of volumes to remove
72	env: { name string: value string, ... }	# List of environment variables to add. More details here
73	removeEnv: [string, ...]	# List of environment variables to remove
74	labels: { name string: value string, ... }	# List of labels to add
75	removeLabels: [ string \|\| /REGEXP/, ... ]	# List of labels to remove
76	keepEssentialWerfLabels: bool	# Do not remove werf labels necessary for normal operation
77	expose: [string, ...]	# Set exposed ports. More details here
78	user: string	# Set user. More details here
79	cmd: [string, ...]	# Set CMD. More details here
80	clearCmd: bool	# Remove CMD
81	entrypoint: [string, ...]	# Set ENTRYPOINT. More details here
82	clearEntrypoint: bool	# Remove ENTRYPOINT
83	workingDir: string	# Set WORKDIR. More details here
84	stopSignal: string	# Set STOPSIGNAL. More details here
85	healthcheck: { test: [string, ...], interval: string, retries: int }	# Healthcheck configuration. Intervals are in seconds.. More details here
86	---	# Stapel image section: optional, define as many image sections as you need
	...
87	image: string \|\| [ string, ... ] !	# One or more unique names for image
88	artifact: string	# The unique name for artifact (DEPRECATED). More details here
89	final: bool	# Mark image as final (default `true`). More details here
90	cacheVersion: string	# Cache version
91	platform: [ string, ... ]	# List of target platforms for this image (for example ['linux/amd64', 'linux/arm64', 'linux/arm/v8'])
92	from: string	# The name of a base image. More details here
93	fromLatest: bool	# To use actual base image without caching. More details here
94	fromImage: string	# To use image as base image by image name. More details here
95	fromArtifact: string	# To use artifact as base image by artifact name (DEPRECATED)
96	fromCacheVersion: string	# Cache version. More details here
97	disableGitAfterPatch: bool	# Disable updating git sources (gitCache, gitLatestPatch stages). More details here
98	git:	# Set of directives to add source files from git repositories (both the project repository and any other). More details here
	...
99	- url: string	# The address of the remote repository. More details here
100	branch: string	# The branch name. More details here
101	commit: string	# The commit
102	tag: string	# The tag name
103	add: string	# A source path in a repository. More details here
104	to: string	# A destination path in image. More details here
105	owner: string	# The name or UID of the owner. More details here
106	group: string	# The name or GID of the owner’s group. More details here
107	includePaths: [ glob, ... ]	# Globs for including. More details here
108	excludePaths: [ glob, ... ]	# Globs for excluding. More details here
109	stageDependencies:	# The organization of restarting assembly instructions when defined changes occur in the git repository. More details here
110	install: [ glob, ... ]	# Globs for install stage
111	beforeSetup: [ glob, ... ]	# Globs for beforeSetup stage
112	setup: [ glob, ... ]	# Globs for setup stage
113	secrets:	# Secrets used in image build. Only one of the following options can be used in a single instance: env, src, or value. More details here
114	- id: string	# Secret unique identifier (mandatory only for the value type)
115	env: string	# A secret from an environment variable
116	src: string	# A secret from a file at the given path
117	value: string	# Custom string value
118	shell:	# Shell assembly instructions. More details here
	...
119	beforeInstall: [ string, ... ]	# Commands for beforeInstall stage. More details here
120	install: [ string, ... ]	# Commands for install stage. More details here
121	beforeSetup: [ string, ... ]	# Commands for beforeSetup stage. More details here
122	setup: [ string, ... ]	# Commands for setup stage. More details here
123	cacheVersion: string	# Common cache version. More details here
124	beforeInstallCacheVersion: string	# Cache version for beforeInstall stage. More details here
125	installCacheVersion: string	# Cache version for install stage. More details here
126	beforeSetupCacheVersion: string	# Cache version for beforeSetup stage. More details here
127	setupCacheVersion: string	# Cache version for setup stage. More details here
128	ansible:	# Ansible assembly instructions. More details here
	...
129	beforeInstall: [ task, ... ]	# Tasks for beforeInstall stage. More details here
130	install: [ task, ... ]	# Tasks for install stage. More details here
131	beforeSetup: [ task, ... ]	# Tasks for beforeSetup stage. More details here
132	setup: [ task, ... ]	# Tasks for setup stage. More details here
133	cacheVersion: string	# Common cache version. More details here
134	beforeInstallCacheVersion: string	# Cache version for beforeInstall stage. More details here
135	installCacheVersion: string	# Cache version for install stage. More details here
136	beforeSetupCacheVersion: string	# Cache version for beforeSetup stage. More details here
137	setupCacheVersion: string	# Cache version for setup stage. More details here
138	imageSpec:	# Image configuration according to the OCI specification. More details here
139	author: string	# Author of the image
140	clearHistory: bool	# Remove all image build history
141	config:	# Common image configuration
	...
142	volumes: [string, ...]	# List of volumes to add. More details here
143	removeVolumes: [string, ...]	# List of volumes to remove
144	env: { name string: value string, ... }	# List of environment variables to add. More details here
145	removeEnv: [string, ...]	# List of environment variables to remove
146	labels: { name string: value string, ... }	# List of labels to add
147	removeLabels: [ string \|\| /REGEXP/, ... ]	# List of labels to remove
148	keepEssentialWerfLabels: bool	# Do not remove werf labels necessary for normal operation
149	expose: [string, ...]	# Set exposed ports. More details here
150	user: string	# Set user. More details here
151	cmd: [string, ...]	# Set CMD. More details here
152	clearCmd: bool	# Remove CMD
153	entrypoint: [string, ...]	# Set ENTRYPOINT. More details here
154	clearEntrypoint: bool	# Remove ENTRYPOINT
155	workingDir: string	# Set WORKDIR. More details here
156	stopSignal: string	# Set STOPSIGNAL. More details here
157	healthcheck: { test: [string, ...], interval: string, retries: int }	# Healthcheck configuration. Intervals are in seconds.. More details here
158	docker:	# Set of directives to change the image manifest (DEPRECATED). Incompatible with the imageSpec directive. More details here
	...
159	exactValues: bool	# Set specified options values as-is, including unescaped quotes and spaces. Option affects only docker-server backend and does not affect buildah backend.
160	USER: string	# The user name (or UID) and optionally the user group (or GID). More details here
161	WORKDIR: string	# The working directory. More details here
162	VOLUME: [ string, ... ]	# Mount points. More details here
163	ENV: { name string: value string, ... }	# The environment variables. More details here
164	LABEL: { name string: value string, ... }	# The metadata to an image. More details here
165	EXPOSE: [ string, ... ]	# To inform Docker that the container listens on the specified network ports at runtime. More details here
166	ENTRYPOINT: string \| [ string, ... ]	# To configure a container that will run as an executable. Shell and exec forms are supported. More details here
167	CMD: string \| [ string, ... ]	# To provide default arguments for the ENTRYPOINT to configure a container that will run as an executable. Shell and exec forms are supported. More details here
168	HEALTHCHECK: string	# To tell Docker how to test a container to check that it is still working. More details here
169	mount:	# Mount points. More details here
	...
170	- from: tmp_dir \|\| build_dir	# Service folder name
171	fromPath: string	# Absolute or relative path to an arbitrary file or folder on host
172	to: string	# Absolute path in image
173	import:	# Imports. More details here
	...
174	- artifact: string	# The artifact name from which you want to copy files (DEPRECATED)
175	image: string	# The image name from which you want to copy files
176	stage: string	# The stage name from which you want to copy files (the latest one by default)
177	before: string	# The stage name before which to perform importing files. At present, only install and setup stages are supported
178	after: string	# The stage name after which to perform importing files. At present, only install and setup stages are supported
179	add: string	# The absolute file or folder path in source image for copying
180	to: string	# The absolute path in destination image. In case of absence, destination path equals source path
181	owner: string	# The name or UID of the owner
182	group: string	# The name or GID of the owner’s group
183	includePaths: [ glob, ... ]	# Globs for including
184	excludePaths: [ glob, ... ]	# Globs for excluding
185	dependencies:	# Dependencies images for current image
	...
186	- image: string	# Dependency image name, which should be built before building current image
187	before: string	# The stage name before which image info should be imported (specify install or setup). Specified target env variables will be available at user stages after stage specified by this directive.
188	after: string	# The stage name after which image info should be imported (specify install or setup). Specified target env variables will be available at user stages after stage specified by this directive.
189	imports:	# Define target environment variables to import image information into current image (optional)
190	- type: string	# Type of image info: ImageName, ImageDigest, ImageRepo or ImageTag
191	targetEnv: string	# Name of environment variable which will contain specified type of information about image