hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity

Improve Woodpecker documentation regarding gRPC connections

Browse source 
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 <sergiodj@sergiodj.net>
This commit is contained in:
Sergio Durigan Junior 2024-03-07 10:42:49 -05:00
parent 2f096ab291
commit 38d447192a
No known key found for this signature in database
GPG key ID: D0EB762865FC5E36
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/services/woodpecker-ci.md
View file

@ -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. 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. Small installations which only run trusted CI jobs can afford to run an agent instance on the source-control server itself.
## Woodpecker CI Server ## Woodpecker CI Server
@ -123,16 +121,23 @@ devture_woodpecker_ci_agent_enabled: true
# #
# Otherwise, you'll need to configure the variables below: # Otherwise, you'll need to configure the variables below:
# This needs to point to the server's gRPC port. # This needs to point to the server's gRPC host:port.
# By default, this port is not exposed, so.. you may need to do some extra work, # If your Woodpecker CI Server is deployed using this playbook, its
# which possibly involves contributing a PR to the Woodpecker CI server role: # gRPC port will likely be 443. E.g., ci.example.com:443.
# https://github.com/devture/com.devture.ansible.role.woodpecker_ci_server
devture_woodpecker_ci_agent_config_server: '' devture_woodpecker_ci_agent_config_server: ''
# Enter your server's secret below. # Enter your server's secret below.
# This value must match the `devture_woodpecker_ci_server_config_agent_secret` variable. # This value must match the `devture_woodpecker_ci_server_config_agent_secret` variable.
devture_woodpecker_ci_agent_config_agent_secret: '' 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 # # /woodpecker-ci-agent #