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