From e1748606e02793fa1fb4e27742d8ee0dfce81ba3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oto=20=C5=A0=C5=A5=C3=A1va?= Date: Wed, 16 Apr 2025 14:06:19 +0200 Subject: [PATCH] Mention `backend_options` in workflow syntax docs (#5096) Co-authored-by: Robert Kaussow --- docs/docs/20-usage/20-workflow-syntax.md | 9 +++++++++ .../version-3.5/20-usage/20-workflow-syntax.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/docs/20-usage/20-workflow-syntax.md b/docs/docs/20-usage/20-workflow-syntax.md index 03673b318..dae9d476b 100644 --- a/docs/docs/20-usage/20-workflow-syntax.md +++ b/docs/docs/20-usage/20-workflow-syntax.md @@ -510,6 +510,15 @@ For more details check the [service docs](./60-services.md#detachment). Using `directory`, you can set a subdirectory of your repository or an absolute path inside the Docker container in which your commands will run. +### `backend_options` + +With `backend_options` you can define options that are specific to the respective backend that is used to execute the steps. For example, you can specify the user and/or group used in a Docker container or you can specify the service account for Kubernetes. + +Further details can be found in the documentation of the used backend: + +- [Docker](../30-administration/10-configuration/11-backends/10-docker.md#step-specific-configuration) +- [Kubernetes](../30-administration/10-configuration/11-backends/20-kubernetes.md#step-specific-configuration) + ## `services` Woodpecker can provide service containers. They can for example be used to run databases or cache containers during the execution of workflow. diff --git a/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md b/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md index 03673b318..dae9d476b 100644 --- a/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md +++ b/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md @@ -510,6 +510,15 @@ For more details check the [service docs](./60-services.md#detachment). Using `directory`, you can set a subdirectory of your repository or an absolute path inside the Docker container in which your commands will run. +### `backend_options` + +With `backend_options` you can define options that are specific to the respective backend that is used to execute the steps. For example, you can specify the user and/or group used in a Docker container or you can specify the service account for Kubernetes. + +Further details can be found in the documentation of the used backend: + +- [Docker](../30-administration/10-configuration/11-backends/10-docker.md#step-specific-configuration) +- [Kubernetes](../30-administration/10-configuration/11-backends/20-kubernetes.md#step-specific-configuration) + ## `services` Woodpecker can provide service containers. They can for example be used to run databases or cache containers during the execution of workflow.