From 191806fa8f369d85ea98305f467c39316d811da5 Mon Sep 17 00:00:00 2001 From: Sergio Durigan Junior Date: Sun, 10 Mar 2024 21:52:34 -0400 Subject: [PATCH] Improve Woodpecker's main docs re. agent secrets This reflects the changes done at https://github.com/devture/com.devture.ansible.role.woodpecker_ci_agent/commit/8671cf01d1c5e2e7bacdf7708cc517029c771e36 Signed-off-by: Sergio Durigan Junior --- docs/services/woodpecker-ci.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/services/woodpecker-ci.md b/docs/services/woodpecker-ci.md index 6cd880e..dfab1db 100644 --- a/docs/services/woodpecker-ci.md +++ b/docs/services/woodpecker-ci.md @@ -40,6 +40,13 @@ devture_woodpecker_ci_server_hostname: mash.example.com devture_woodpecker_ci_server_path_prefix: /ci # Generate this secret with `openssl rand -hex 32` +# +# Note that this playbook only supports agent-specific secrets, which +# means that if you choose to share this secret with an agent, the +# server will register it as a non-persistent agent. +# +# See the definition of +# devture_woodpecker_ci_agent_config_agent_secret below for more details. devture_woodpecker_ci_server_config_agent_secret: '' devture_woodpecker_ci_server_config_admins: [YOUR_USERNAME_HERE] @@ -126,9 +133,15 @@ devture_woodpecker_ci_agent_enabled: true # gRPC port will likely be 443. E.g., ci.example.com:443. devture_woodpecker_ci_agent_config_server: '' -# Enter your server's secret below. -# This value must match the `devture_woodpecker_ci_server_config_agent_secret` variable. -devture_woodpecker_ci_agent_config_agent_secret: '' +# This playbook only supports agent-specific secrets, i.e., it is not recommended to use +# a shared secret between Woodpecker CI Server and all of its agents. Please refer to +# the following upstream documentation in order to learn how to register an agent and +# obtain a secret for it: +# +# https://woodpecker-ci.org/docs/administration/agent-config#using-agent-token +# +# then, when you have the agent secret, uncomment the following line. +#devture_woodpecker_ci_agent_config_agent_secret: '' # Uncomment the line below if you want the agent to connect to the # server over a secure gRPC channel (recommended).