Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 12 commits into from
Jan 9, 2024
42 changes: 28 additions & 14 deletions docs/docs/30-administration/22-backends/40-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,33 +18,47 @@ agent:
[...]
```

- `WOODPECKER_BACKEND_K8S_NAMESPACE` (default: `woodpecker`)
### `WOODPECKER_BACKEND_K8S_NAMESPACE`

The namespace to create worker pods in.
> Default: `woodpecker`

- `WOODPECKER_BACKEND_K8S_VOLUME_SIZE` (default: `10G`)
The namespace to create worker pods in.

The volume size of the pipeline volume.
### `WOODPECKER_BACKEND_K8S_VOLUME_SIZE`

- `WOODPECKER_BACKEND_K8S_STORAGE_CLASS` (default: empty)
> Default: `10G`

The storage class to use for the pipeline volume.
The volume size of the pipeline volume.

- `WOODPECKER_BACKEND_K8S_STORAGE_RWX` (default: `true`)
### `WOODPECKER_BACKEND_K8S_STORAGE_CLASS`

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.
> Default: empty

- `WOODPECKER_BACKEND_K8S_POD_LABELS` (default: empty)
The storage class to use for the pipeline volume.

Additional labels to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-label":"test-value"}`.
### `WOODPECKER_BACKEND_K8S_STORAGE_RWX`

- `WOODPECKER_BACKEND_K8S_POD_ANNOTATIONS` (default: empty)
> Default: `true`

Additional annotations to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-annotation":"test-value"}`.
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_SECCTX_NONROOT` (default: `false`)
### `WOODPECKER_BACKEND_K8S_POD_LABELS`

Determines if containers must be required to run as non-root users.
> 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`
qwerty287 marked this conversation as resolved.
Show resolved Hide resolved

Determines if containers must be required to run as non-root users.

## Job specific configuration

Expand Down