From 38d447192a18bcfb01857cfd86d37b15d53ecb24 Mon Sep 17 00:00:00 2001 From: Sergio Durigan Junior Date: Thu, 7 Mar 2024 10:42:49 -0500 Subject: [PATCH] Improve Woodpecker documentation regarding gRPC connections Remove the (now unnecessary) warning saying that gRPC connections don't work, and provide a better example on how to configure the agent. Signed-off-by: Sergio Durigan Junior --- docs/services/woodpecker-ci.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/services/woodpecker-ci.md b/docs/services/woodpecker-ci.md index 7ecca06..6cd880e 100644 --- a/docs/services/woodpecker-ci.md +++ b/docs/services/woodpecker-ci.md @@ -11,8 +11,6 @@ A Woodpecker CI installation contains 2 components: It's better to run the **agent** instances elsewhere (not on the source-control server or a server serving anything of value) - on a machine that doesn't contain sensitive data. -**Warning**: At the moment, running the **server** and **agent** on different machines cannot be done due to the server's gRPC port not being exposed publicly (at the Traefik level). If you need to do this, consider submitting a PR to the [Woodpecker CI server role](https://github.com/devture/com.devture.ansible.role.woodpecker_ci_server) to add support for this. - Small installations which only run trusted CI jobs can afford to run an agent instance on the source-control server itself. ## Woodpecker CI Server @@ -123,16 +121,23 @@ devture_woodpecker_ci_agent_enabled: true # # Otherwise, you'll need to configure the variables below: -# This needs to point to the server's gRPC port. -# By default, this port is not exposed, so.. you may need to do some extra work, -# which possibly involves contributing a PR to the Woodpecker CI server role: -# https://github.com/devture/com.devture.ansible.role.woodpecker_ci_server +# This needs to point to the server's gRPC host:port. +# If your Woodpecker CI Server is deployed using this playbook, its +# 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: '' +# Uncomment the line below if you want the agent to connect to the +# server over a secure gRPC channel (recommended). +#devture_woodpecker_ci_agent_config_grpc_secure: true + +# Uncomment the line below if you want the agent to verify the +# server's TLS certificate when connecting over a secure gRPC channel. +#devture_woodpecker_ci_agent_config_grpc_verify: true + ######################################################################## # # # /woodpecker-ci-agent #