mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-09-27 14:10:17 +00:00
Code Issues Projects Releases Wiki Activity

Make k8s backend configuration docs in the same format as others (#3081)

Browse source 
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
This commit is contained in:
Micash 2024-01-09 08:28:35 +01:00 committed by GitHub
parent 1ee2b8c41c
commit a1c9c3dfe4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
docs/docs/30-administration/22-backends/40-kubernetes.md
View file

@ -1,55 +1,11 @@
---
toc_max_heading_level: 3
toc_max_heading_level: 2
---
# Kubernetes backend
The kubernetes backend executes steps inside standalone pods. A temporary PVC is created for the lifetime of the pipeline to transfer files between steps.
## General Configuration
These env vars can be set in the `env:` sections of both `server` and `agent`.
They do not need to be set for both but only for the part to which it is relevant to.
```yaml
server:
env:
WOODPECKER_SESSION_EXPIRES: "300h"
[...]
agent:
env:
[...]
```
- `WOODPECKER_BACKEND_K8S_NAMESPACE` (default: `woodpecker`)
The namespace to create worker pods in.
- `WOODPECKER_BACKEND_K8S_VOLUME_SIZE` (default: `10G`)
The volume size of the pipeline volume.
- `WOODPECKER_BACKEND_K8S_STORAGE_CLASS` (default: empty)
The storage class to use for the pipeline volume.
- `WOODPECKER_BACKEND_K8S_STORAGE_RWX` (default: `true`)
Determines if `RWX` should be used for the pipeline volume's [access mode](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes). If false, `RWO` is used instead.
- `WOODPECKER_BACKEND_K8S_POD_LABELS` (default: empty)
Additional labels to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-label":"test-value"}`.
- `WOODPECKER_BACKEND_K8S_POD_ANNOTATIONS` (default: empty)
Additional annotations to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-annotation":"test-value"}`.
- `WOODPECKER_BACKEND_K8S_SECCTX_NONROOT` (default: `false`)
Determines if containers must be required to run as non-root users.
## Job specific configuration
### Resources
@ -213,3 +169,49 @@ workspace:
```
See [this issue](https://github.com/woodpecker-ci/woodpecker/issues/2510) for more details.
## Configuration
These env vars can be set in the `env:` sections of the agent.
### `WOODPECKER_BACKEND_K8S_NAMESPACE`
> Default: `woodpecker`
The namespace to create worker pods in.
### `WOODPECKER_BACKEND_K8S_VOLUME_SIZE`
> Default: `10G`
The volume size of the pipeline volume.
### `WOODPECKER_BACKEND_K8S_STORAGE_CLASS`
> Default: empty
The storage class to use for the pipeline volume.
### `WOODPECKER_BACKEND_K8S_STORAGE_RWX`
> Default: `true`
Determines if `RWX` should be used for the pipeline volume's [access mode](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes). If false, `RWO` is used instead.
### `WOODPECKER_BACKEND_K8S_POD_LABELS`
> Default: empty
Additional labels to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-label":"test-value"}`.
### `WOODPECKER_BACKEND_K8S_POD_ANNOTATIONS`
> Default: empty
Additional annotations to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-annotation":"test-value"}`.
### `WOODPECKER_BACKEND_K8S_SECCTX_NONROOT`
> Default: `false`
Determines if containers must be required to run as non-root users.