0 | --- | # Секция мета-информации |
... | ||
1 | project: string ! | # Уникальное имя проекта приложения |
2 | configVersion: int ! | # Версия конфигурации. На данный момент поддерживается единственная версия 1 |
3 | build: | # Общие настройки сборки |
... | ||
4 | platform: [ string, ... ] | # Общий список целевых платформ для всех образов (например ['linux/amd64', 'linux/arm64', 'linux/arm/v8']) |
5 | deploy: | # Настройки выката |
... | ||
6 | helmChartDir: string |
#
Путь до директории helm чарта проекта (значение по умолчанию .helm )
|
7 | helmRelease: string |
#
Шаблон имени релиза (значение по умолчанию [[ project ]]-[[ env ]] )
|
8 | helmReleaseSlug: bool |
#
Слагификация имени релиза (значение по умолчанию true )
|
9 | namespace: string |
#
Шаблон Kubernetes namespace (значение по умолчанию [[ project ]]-[[ env ]] )
|
10 | namespaceSlug: bool |
#
Слагификация Kubernetes namespace (значение по умолчанию true )
|
11 | cleanup: | # Настройка удаления неактульных образов |
... | ||
12 | disableKubernetesBasedPolicy: bool | # Отключить политику очистки, которая позволяет не удалять запущенные в Kubernetes образы из container registry |
13 | disableGitHistoryBasedPolicy: bool | # Отключить политику очистки, которая позволяет не удалять образы с учётом пользовательских политик по истории Git (keepPolicies) |
14 | disableBuiltWithinLastNHoursPolicy: bool | # Отключить политику очистки, которая позволяет не удалять образы, собранные в рамках заданного периода времени (keepImagesBuiltWithinLastNHours) |
15 | keepImagesBuiltWithinLastNHours: uint |
#
Минимальное количество часов, которое должно пройти с момента сборки образа (значение по умолчанию 2 )
|
16 | keepPolicies: | # Набор политик для выборки актуальных образов, используя историю Git |
17 | - references: | # Набор references, который будет использоваться при сканировании |
18 | branch: string || /REGEXP/ | # Множество git origin веток |
19 | tag: string || /REGEXP/ | # Множество git origin тегов |
20 | limit: | # Набор правил, по которым можно ограничить описанное множество references, основываясь на времени создания git-тега или активности в git-ветке |
21 | last: int |
#
Выборка последних n references из определённого в branch/tag множества (значение по умолчанию -1 )
|
22 | in: duration string | # Выборка git-тегов, которые были созданы в указанный период, или git-веток с активностью в рамках периода. Также для определённого множества branch/tag |
23 | operator: And || Or |
#
Определяет какие references будут результатом политики, те которые удовлетворяют оба условия или любое из них (значение по умолчанию And )
|
24 | imagesPerReference: | # Лимит искомых образов для каждого reference из множества |
25 | last: int |
#
Количество искомых образов для каждого reference (значение по умолчанию -1 )
|
26 | in: duration string | # Период, в рамках которого необходимо выполнять поиск образов |
27 | gitWorktree: | # Настройки связанные с работой werf с рабочей директорией git проекта |
... | ||
28 | forceShallowClone: bool | # Принудительно позволить werf использовать shallow clone несмотря на ограничения данного подхода |
29 | allowUnshallow: bool |
#
Разрешить процессу werf автоматически преобразовать shallow clone проекта в полный clone в процессе сборки по необходимости (значение по умолчанию true )
|
30 | allowFetchOriginBranchesAndTags: bool |
#
Разрешить процессу werf автоматически скачать новые ветки и теги из origin в процессе cleanup по необходимости (значение по умолчанию true )
|
31 | --- | # Секция Dockerfile image: может использоваться произвольное количество секций |
... | ||
32 | image: string || [ string, ... ] ! | # Одно или несколько уникальных имён для образа |
33 | final: bool |
#
Пометить образ как финальный (значение по умолчанию true ). Подробнее здесь
|
34 | dockerfile: string ! | # Путь к Dockerfile относительно директории контекста |
35 | staged: bool | # Включить послойное кеширование Dockerfile-инструкций в container registry |
36 | context: string | # Путь к контексту внутри папки проекта |
37 | platform: [ string, ... ] | # Список целевых платформ для данного образа (например ['linux/amd64', 'linux/arm64', 'linux/arm/v8']) |
38 | contextAddFiles: [ string, ... ] | # Добавление нехранящихся в git файлов и директорий в сборочный контекст. Пути должны быть относительно директории контекста |
39 | target: string | # Конкретная стадия Dockerfile (по умолчанию — последняя, подобно docker build --target) |
40 | args: { name string: value string, ... } | # Переменные для ARG Dockerfile-инструкций (подобно docker build --build-arg) |
41 | addHost: [ string, ... ] | # Установить связь host-to-IP (host:ip) (подобно docker build --add-host) |
42 | network: string | # Сетевой режим для инструкций RUN во время сборки (подобно docker build --network) |
43 | ssh: string | # Сокет агента SSH или ключи для сборки (подобно docker build --ssh) |
44 | secrets: | # Секреты, используемые при сборке образа. В одном экземпляре можно использовать только одну из следующих опций: env, src или value. Подробнее здесь |
45 | - id: string | # Уникальный идентификатор секрета (обязателен только для секретов типа value) |
46 | env: string | # Секрет из переменной окружения |
47 | src: string | # Секрет из файла по указанному пути |
48 | value: string | # Произвольное строковое значение |
49 | dependencies: | # Образы-зависимости для текущего образа |
... | ||
50 | - image: string | # Имя зависимого образа, который должен быть собран до сборки текущего образа |
51 | imports: | # Определить аргументы для импорта информации о зависимом образе в текущий образ используя Dockerfile build-args (опционально) |
52 | - type: string | # Тип импортируемой информации об образе: ImageName, ImageDigest, ImageRepo или ImageTag |
53 | targetBuildArg: string | # Имя аргумента (Dockerfile build-args), который будет содержать указанный тип информации об образе |
54 | --- | # Секция Stapel image: может использоваться произвольное количество секций |
... | ||
55 | image: string || [ string, ... ] ! | # Одно или несколько уникальных имён для образа |
56 | artifact: string | # Уникальное имя артефакта (DEPRECATED). Подробнее здесь |
57 | final: bool |
#
Пометить образ как финальный (значение по умолчанию true ). Подробнее здесь
|
58 | platform: [ string, ... ] | # Список целевых платформ для данного образа (например ['linux/amd64', 'linux/arm64', 'linux/arm/v8']) |
59 | from: string | # Имя и тег базового образа. Подробнее здесь |
60 | fromLatest: bool | # Использование актуального базового образа (без кеширования). Подробнее здесь |
61 | fromImage: string | # Использование образа из werf.yaml в качестве базового. Подробнее здесь |
62 | fromArtifact: string | # Использование образа артефакта из werf.yaml в качестве базового (DEPRECATED) |
63 | fromCacheVersion: string | # Версия кеша. Подробнее здесь |
64 | disableGitAfterPatch: bool | # Отключение актуализации исходников Git (стадии gitCache, gitLatestPatch). Подробнее здесь |
65 | git: | # Набор директив для добавления исходных файлов из git-репозиториев (как репозитория проекта, так и любого другого). Подробнее здесь |
... | ||
66 | - url: string | # Адрес git-репозитория. Подробнее здесь |
67 | branch: string | # Имя ветки. Подробнее здесь |
68 | commit: string | # Коммит |
69 | tag: string | # Имя тега |
70 | add: string | # Исходный путь в репозитории. Подробнее здесь |
71 | to: string | # Путь назначения в образе. Подробнее здесь |
72 | owner: string | # Имя или UID владельца. Подробнее здесь |
73 | group: string | # Имя или GID группы. Подробнее здесь |
74 | includePaths: [ glob, ... ] | # Глобы добавления. Подробнее здесь |
75 | excludePaths: [ glob, ... ] | # Глобы исключения. Подробнее здесь |
76 | stageDependencies: | # Настройка перевыполнения сборочных инструкций при изменениях определённых файлов в репозитории. Подробнее здесь |
77 | install: [ glob, ... ] | # Глобы стадии install |
78 | beforeSetup: [ glob, ... ] | # Глобы стадии beforeSetup |
79 | setup: [ glob, ... ] | # Глобы стадии setup |
80 | secrets: | # Секреты, используемые при сборке образа. В одном экземпляре можно использовать только одну из следующих опций: env, src или value. Подробнее здесь |
81 | - id: string | # Уникальный идентификатор секрета (обязателен только для секретов типа value) |
82 | env: string | # Секрет из переменной окружения |
83 | src: string | # Секрет из файла по указанному пути |
84 | value: string | # Произвольное строковое значение |
85 | shell: | # Shell сборочные инструкции. Подробнее здесь |
... | ||
86 | beforeInstall: [ string, ... ] | # Команды для стадии beforeInstall. Подробнее здесь |
87 | install: [ string, ... ] | # Команды для стадии install. Подробнее здесь |
88 | beforeSetup: [ string, ... ] | # Команды для стадии beforeSetup. Подробнее здесь |
89 | setup: [ string, ... ] | # Команды для стадии setup. Подробнее здесь |
90 | cacheVersion: string | # Общая версия кеша. Подробнее здесь |
91 | beforeInstallCacheVersion: string | # Версия кеша для стадии beforeInstall. Подробнее здесь |
92 | installCacheVersion: string | # Версия кеша для стадии install. Подробнее здесь |
93 | beforeSetupCacheVersion: string | # Версия кеша для стадии beforeSetup. Подробнее здесь |
94 | setupCacheVersion: string | # Версия кеша для стадии setup. Подробнее здесь |
95 | ansible: | # Ansible сборочные инструкции. Подробнее здесь |
... | ||
96 | beforeInstall: [ task, ... ] | # Задания для стадии beforeInstall. Подробнее здесь |
97 | install: [ task, ... ] | # Задания для стадии install. Подробнее здесь |
98 | beforeSetup: [ task, ... ] | # Задания для стадии beforeSetup. Подробнее здесь |
99 | setup: [ task, ... ] | # Задания для стадии setup. Подробнее здесь |
100 | cacheVersion: string | # Общая версия кеша. Подробнее здесь |
101 | beforeInstallCacheVersion: string | # Версия кеша для стадии beforeInstall. Подробнее здесь |
102 | installCacheVersion: string | # Версия кеша для стадии install. Подробнее здесь |
103 | beforeSetupCacheVersion: string | # Версия кеша для стадии beforeSetup. Подробнее здесь |
104 | setupCacheVersion: string | # Версия кеша для стадии setup. Подробнее здесь |
105 | docker: | # Набор директив для изменения манифеста образа. Подробнее здесь |
... | ||
106 | exactValues: bool | # Включить использование незаэкранированных символов (например кавычки и пробелы) в значениях опций. Опция имеет действие только при использовании docker-server backend, и не влияет на работу buildah backend. |
107 | USER: string | # Имя пользователя (или UID) и опционально пользовательская группа (или GID). Подробнее здесь |
108 | WORKDIR: string | # Рабочая директория. Подробнее здесь |
109 | VOLUME: [ string, ... ] | # Точки монтирования. Подробнее здесь |
110 | ENV: { name string: value string, ... } | # Переменные окружения. Подробнее здесь |
111 | LABEL: { name string: value string, ... } | # Метаданные. Подробнее здесь |
112 | EXPOSE: [ string, ... ] | # Описание сетевых портов, которые будут прослушиваться в запущенном контейнере. Подробнее здесь |
113 | ENTRYPOINT: string | [ string, ... ] | # Команда по умолчанию, которая будет выполнена при запуске контейнера (форма записи shell или exec). Подробнее здесь |
114 | CMD: string | [ string, ... ] | # Аргументы по умолчанию для ENTRYPOINT (форма записи shell или exec). Подробнее здесь |
115 | HEALTHCHECK: string | # Инструкции, которые Docker может использовать для проверки работоспособности запущенного контейнера. Подробнее здесь |
116 | mount: | # Точки монтирования. Подробнее здесь |
... | ||
117 | - from: tmp_dir || build_dir | # Имя служебной директории |
118 | fromPath: string | # Абсолютный или относительный путь до произвольного файла на хосте |
119 | to: string | # Абсолютный путь в образе |
120 | import: | # Импортирование из образов. Подробнее здесь |
... | ||
121 | - artifact: string | # Имя артефакта, из которого выполнять копирование файлов (DEPRECATED) |
122 | image: string | # Имя образа, из которого выполнять копирование файлов |
123 | stage: string | # Имя стадии, из которой выполнять копирование файлов (по умолчанию последняя) |
124 | before: string | # Выбор стадии импортирования файлов при сборке, до стадии install или setup |
125 | after: string | # Выбор стадии импортирования файлов при сборке, после стадии install или setup |
126 | add: string | # Абсолютный путь до файла или директории в выбранном образе |
127 | to: string | # Абсолютный путь в конечном образе. По умолчанию соответствует пути add |
128 | owner: string | # Имя или UID владельца |
129 | group: string | # Имя или GID группы |
130 | includePaths: [ glob, ... ] | # Глобы добавления |
131 | excludePaths: [ glob, ... ] | # Глобы исключения |
132 | dependencies: | # Образы-зависимости для текущего образа |
... | ||
133 | - image: string | # Имя зависимого образа, который должен быть собран до сборки текущего образа |
134 | before: string | # Выбор стадии перед которой должна быть импортирована информация об образе (требуется указать install или setup). Указанные переменные окружения будут доступны в пользовательских стадиях после указанной данной директивой стадии. |
135 | after: string | # Выбор стадии после которой должна быть импортирована информация об образе (требуется указать install или setup). Указанные переменные окружения будут доступны в пользовательских стадиях после указанной данной директивой стадии. |
136 | imports: | # Определить аргументы для импорта информации о зависимом образе в текущий образ используя переменные окружения (опционально) |
137 | - type: string | # Тип импортируемой информации об образе: ImageName, ImageDigest, ImageRepo или ImageTag |
138 | targetEnv: string | # Имя переменной окружения, которая будет содержать указанный тип информации об образе |