diff --git a/docs/pages/configuration/introduction.md b/docs/pages/configuration/introduction.md index eecc402817..1da1caf7df 100644 --- a/docs/pages/configuration/introduction.md +++ b/docs/pages/configuration/introduction.md @@ -88,16 +88,9 @@ Config section with the key `artifact: IMAGE_NAME` is the artifact config sectio ### Minimal config example -Currently Werf requires to define meta config section and at least one image config section. Image config sections will be fully optional soon. - -Example of minimal werf config: - ```yaml project: my-project configVersion: 1 ---- -image: ~ -from: alpine:latest ``` ## Organizing configuration @@ -380,6 +373,12 @@ Go templates are available within YAML configuration. The following functions ar * `.Files.Get` function for getting project file content: +
+ Ansible + Shell +
+ +
{% raw %} ```yaml project: my-project @@ -397,3 +396,24 @@ Go templates are available within YAML configuration. The following functions ar dest: /etc/nginx/nginx.conf ``` {% endraw %} +
+ +
+ {% raw %} + ```yaml + project: my-project + configVersion: 1 + --- + + image: app + from: alpine + shell: + setup: + - | + head -c -1 < /etc/nginx/nginx.conf + {{ .Files.Get ".werf/nginx.conf" | indent 4 }} + EOF + ``` + {% endraw %} +
+ diff --git a/docs/pages/reference/deploy_process/deploy_into_kubernetes.md b/docs/pages/reference/deploy_process/deploy_into_kubernetes.md index 7c9747ad2b..dfd5bf48b6 100644 --- a/docs/pages/reference/deploy_process/deploy_into_kubernetes.md +++ b/docs/pages/reference/deploy_process/deploy_into_kubernetes.md @@ -312,7 +312,7 @@ There are following service values: * Git branch name or git tag name used: `.Values.global.werf.ci.is_branch`, `.Values.global.werf.ci.branch`, `.Values.global.werf.ci.is_tag`, `.Values.global.werf.ci.tag`. * `.Values.global.ci.ref` is set to either git branch name or git tag name. * Full docker images names and ids for each image from `werf.yaml` config: `.Values.global.werf.image.IMAGE_NAME.docker_image` and `.Values.global.werf.image.IMAGE_NAME.docker_image_id`. - * `.Values.global.werf.is_nameless_image` indicates whether there is a single image defined in the `werf.yaml` config. + * `.Values.global.werf.is_nameless_image` indicates whether there is the nameless image defined in the `werf.yaml` config. * Project name from `werf.yaml`: `.Values.global.werf.name`. * Docker tag being used during deploy for images from `werf.yaml` (accordingly to the selected tagging strategy): `.Values.global.werf.docker_tag`. * Images repo being used during deploy: `.Values.global.werf.repo`.