From cfe6df5add635034f9093f745d3b8d5df4352899 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 20 Sep 2024 02:33:49 +0200 Subject: [PATCH] Docs: reference to built-in docker compose and remove deprecated version from compose examples (#4123) --- .../30-administration/00-getting-started.md | 6 +++--- .../05-deployment-methods/10-docker-compose.md | 18 +++--------------- docs/docs/30-administration/10-database.md | 2 -- .../docs/30-administration/10-server-config.md | 8 +++----- .../30-administration/11-forges/30-gitea.md | 2 -- .../11-forges/60-bitbucket_datacenter.md | 2 -- .../30-administration/40-advanced/10-proxy.md | 2 -- .../30-administration/40-advanced/20-ssl.md | 6 ------ .../40-advanced/30-autoscaler.md | 6 ++---- 9 files changed, 11 insertions(+), 41 deletions(-) diff --git a/docs/docs/30-administration/00-getting-started.md b/docs/docs/30-administration/00-getting-started.md index 8bb1b0a71..e5d573e56 100644 --- a/docs/docs/30-administration/00-getting-started.md +++ b/docs/docs/30-administration/00-getting-started.md @@ -32,9 +32,9 @@ In addition you need at least some kind of database which requires additional re ## Installation -You can install Woodpecker on multiple ways. If you are not sure which one to choose, we recommend using the [docker-compose](./05-deployment-methods/10-docker-compose.md) method for the beginning: +You can install Woodpecker on multiple ways. If you are not sure which one to choose, we recommend using the [docker compose](./05-deployment-methods/10-docker-compose.md) method for the beginning: -- Using [docker-compose](./05-deployment-methods/10-docker-compose.md) with the official [container images](./05-deployment-methods/10-docker-compose.md#docker-images) +- Using [docker compose](./05-deployment-methods/10-docker-compose.md) with the official [container images](./05-deployment-methods/10-docker-compose.md#docker-images) - Using [Kubernetes](./05-deployment-methods/20-kubernetes.md) via the Woodpecker Helm chart - Using binaries, DEBs or RPMs you can download from [latest release](https://github.com/woodpecker-ci/woodpecker/releases/latest) - Or using a [third-party installation method](./05-deployment-methods/30-third-party.md) @@ -55,5 +55,5 @@ Check the [server configuration](./10-server-config.md) and [agent configuration The agent is the worker which executes the [workflows](../20-usage/15-terminology/index.md). Woodpecker agents can execute work using a [backend](../20-usage/15-terminology/index.md) like [docker](./22-backends/10-docker.md) or [kubernetes](./22-backends/40-kubernetes.md). -By default if you choose to deploy an agent using [docker-compose](./05-deployment-methods/10-docker-compose.md) the agent simply use docker for the backend as well. +By default if you choose to deploy an agent using [docker compose](./05-deployment-methods/10-docker-compose.md) the agent simply use docker for the backend as well. So nothing to worry about here. If you still prefer to adjust the agent to your needs, check the [agent configuration](./15-agent-config.md) page. diff --git a/docs/docs/30-administration/05-deployment-methods/10-docker-compose.md b/docs/docs/30-administration/05-deployment-methods/10-docker-compose.md index 5af7e85fc..161e75bd8 100644 --- a/docs/docs/30-administration/05-deployment-methods/10-docker-compose.md +++ b/docs/docs/30-administration/05-deployment-methods/10-docker-compose.md @@ -1,12 +1,10 @@ -# docker-compose +# docker compose -The below [docker-compose](https://docs.docker.com/compose/) configuration can be used to start a Woodpecker server with a single agent. +The below [docker compose](https://docs.docker.com/compose/) configuration can be used to start a Woodpecker server with a single agent. -It relies on a number of environment variables that you must set before running `docker-compose up`. The variables are described below. +It relies on a number of environment variables that you must set before running `docker compose up`. The variables are described below. ```yaml title="docker-compose.yaml" -version: '3' - services: woodpecker-server: image: woodpeckerci/woodpecker-server:latest @@ -43,8 +41,6 @@ volumes: Woodpecker needs to know its own address. You must therefore provide the public address of it in `://` format. Please omit trailing slashes: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] @@ -57,7 +53,6 @@ Woodpecker can also have its port's configured. It uses a separate port for gRPC They can be configured with `*_ADDR` variables: ```diff title="docker-compose.yaml" - version: '3' services: woodpecker-server: [...] @@ -70,7 +65,6 @@ They can be configured with `*_ADDR` variables: Reverse proxying can also be [configured for gRPC](../40-advanced/10-proxy.md#caddy). If the agents are connecting over the internet, it should also be SSL encrypted. The agent then needs to be configured to be secure: ```diff title="docker-compose.yaml" - version: '3' services: woodpecker-server: [...] @@ -83,8 +77,6 @@ Reverse proxying can also be [configured for gRPC](../40-advanced/10-proxy.md#ca As agents run pipeline steps as docker containers they require access to the host machine's Docker daemon: ```diff title="docker-compose.yaml" - version: '3' - services: [...] woodpecker-agent: @@ -96,8 +88,6 @@ As agents run pipeline steps as docker containers they require access to the hos Agents require the server address for agent-to-server communication. The agent connects to the server's gRPC port: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-agent: [...] @@ -108,8 +98,6 @@ Agents require the server address for agent-to-server communication. The agent c The server and agents use a shared secret to authenticate communication. This should be a random string of your choosing and should be kept private. You can generate such string with `openssl rand -hex 32`: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] diff --git a/docs/docs/30-administration/10-database.md b/docs/docs/30-administration/10-database.md index e3e33ba7d..b1b5aa688 100644 --- a/docs/docs/30-administration/10-database.md +++ b/docs/docs/30-administration/10-database.md @@ -7,8 +7,6 @@ The default database engine of Woodpecker is an embedded SQLite database which r By default Woodpecker uses a SQLite database stored under `/var/lib/woodpecker/`. If using containers, you can mount a [data volume](https://docs.docker.com/storage/volumes/#create-and-manage-volumes) to persist the SQLite database. ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index c7f544e25..02fde63a0 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -63,17 +63,15 @@ Point it to your server's docker config. WOODPECKER_DOCKER_CONFIG=/root/.docker/config.json ``` -## Handling sensitive data in docker-compose and docker-swarm +## Handling sensitive data in **docker compose** and **docker swarm** -To handle sensitive data in docker-compose or docker-swarm configurations there are several options: +To handle sensitive data in `docker compose` or `docker swarm` configurations there are several options: -For docker-compose you can use a `.env` file next to your compose configuration to store the secrets outside of the compose file. While this separates configuration from secrets it is still not very secure. +For docker compose you can use a `.env` file next to your compose configuration to store the secrets outside of the compose file. While this separates configuration from secrets it is still not very secure. Alternatively use docker-secrets. As it may be difficult to use docker secrets for environment variables Woodpecker allows to read sensible data from files by providing a `*_FILE` option of all sensible configuration variables. Woodpecker will try to read the value directly from this file. Keep in mind that when the original environment variable gets specified at the same time it will override the value read from the file. ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] diff --git a/docs/docs/30-administration/11-forges/30-gitea.md b/docs/docs/30-administration/11-forges/30-gitea.md index 62fe40cb6..82d77a54a 100644 --- a/docs/docs/30-administration/11-forges/30-gitea.md +++ b/docs/docs/30-administration/11-forges/30-gitea.md @@ -22,8 +22,6 @@ Otherwise, the communication should go via the `docker0` gateway (usually 172.17 To configure the Docker network if the network's name is `gitea`, configure it like this: ```diff title="docker-compose.yaml" - version: '3' - services: [...] woodpecker-agent: diff --git a/docs/docs/30-administration/11-forges/60-bitbucket_datacenter.md b/docs/docs/30-administration/11-forges/60-bitbucket_datacenter.md index 53926fa73..742180008 100644 --- a/docs/docs/30-administration/11-forges/60-bitbucket_datacenter.md +++ b/docs/docs/30-administration/11-forges/60-bitbucket_datacenter.md @@ -11,8 +11,6 @@ Woodpecker comes with experimental support for Bitbucket Datacenter / Server, fo To enable Bitbucket Server you should configure the Woodpecker container using the following environment variables: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] diff --git a/docs/docs/30-administration/40-advanced/10-proxy.md b/docs/docs/30-administration/40-advanced/10-proxy.md index 2afcc778d..8771eed44 100644 --- a/docs/docs/30-administration/40-advanced/10-proxy.md +++ b/docs/docs/30-administration/40-advanced/10-proxy.md @@ -137,8 +137,6 @@ To install the Woodpecker server behind a [Traefik](https://traefik.io/) load ba ```yaml -version: '3.8' - services: server: image: woodpeckerci/woodpecker-server:latest diff --git a/docs/docs/30-administration/40-advanced/20-ssl.md b/docs/docs/30-administration/40-advanced/20-ssl.md index 755ba205d..6fda26d3d 100644 --- a/docs/docs/30-administration/40-advanced/20-ssl.md +++ b/docs/docs/30-administration/40-advanced/20-ssl.md @@ -52,8 +52,6 @@ SSL support is provided using the [ListenAndServeTLS](https://golang.org/pkg/net Update your configuration to expose the following ports: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] @@ -66,8 +64,6 @@ Update your configuration to expose the following ports: Update your configuration to mount your certificate and key: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] @@ -79,8 +75,6 @@ Update your configuration to mount your certificate and key: Update your configuration to provide the paths of your certificate and key: ```diff title="docker-compose.yaml" - version: '3' - services: woodpecker-server: [...] diff --git a/docs/docs/30-administration/40-advanced/30-autoscaler.md b/docs/docs/30-administration/40-advanced/30-autoscaler.md index ce9ee914a..0ad43a30b 100644 --- a/docs/docs/30-administration/40-advanced/30-autoscaler.md +++ b/docs/docs/30-administration/40-advanced/30-autoscaler.md @@ -6,13 +6,11 @@ Please note that the autoscaler is not feature-complete yet. You can follow the ## Setup -### docker-compose +### docker compose -If you are using docker-compose you can add the following to your `docker-compose.yaml` file: +If you are using docker compose you can add the following to your `docker-compose.yaml` file: ```yaml -version: '3' - services: woodpecker-server: image: woodpeckerci/woodpecker-server:next