Skip to content

Commit

Permalink
chore(installation): add drop capabilities flag docs (#355)
Browse files Browse the repository at this point in the history
Co-authored-by: David May <49894298+wass3rw3rk@users.noreply.github.com>
  • Loading branch information
ecrupper and wass3rw3rk committed Apr 25, 2023
1 parent c479b4a commit ef23e0f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
8 changes: 8 additions & 0 deletions content/installation/worker/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,14 @@ The variable can be provided as a comma-separated `list` (i.e. `myImage1,myImage
Please use with caution. This setting essentially grants any defined image root access to the host machine.
{{% /alert %}}

### VELA_RUNTIME_DROP_CAPABILITIES

This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker.

This variable leverages the [`--cap-drop` Docker run flag](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) to disable certain kernel capabilities given to the container by default.

This variable can be provided as a comma-separated `list` (e.g. `CAP_CHOWN,CAP_DAC_OVERRIDE`). There is some validation in place to ensure accurate capabilities are provided.

### VELA_RUNTIME_VOLUMES

This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker.
Expand Down
1 change: 1 addition & 0 deletions content/installation/worker/reference/runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The following options are used to configure the component:
| `runtime.pods-template-name` | name of the PipelinePodsTemplate to retrieve from the `runtime.namespace` (only for kubernetes) | `false` | `N/A` | `RUNTIME_PODS_TEMPLATE_NAME`<br>`VELA_RUNTIME_PODS_TEMPLATE_NAME` |
| `runtime.pods-template-file` | path to local fallback file containing a PipelinePodsTemplate in YAML (only for kubernetes) | `false` | `N/A` | `RUNTIME_PODS_TEMPLATE_FILE`<br>`VELA_RUNTIME_PODS_TEMPLATE_FILE` |
| `runtime.privileged-images` | images allowed to run in privileged mode for the runtime | `false` | `[ ]` | `RUNTIME_PRIVILEGED_IMAGES`<br>`VELA_RUNTIME_PRIVILEGED_IMAGES` |
| `runtime.drop-capabilities` | kernel capabilities to be dropped from each running container | `false` | `N/A` | `RUNTIME_DROP_CAPABILITIES`<br>`VELA_RUNTIME_DROP_CAPABILITIES` |
| `runtime.volumes` | path to host volumes to mount into resources for the runtime | `false` | `N/A` | `RUNTIME_VOLUMES`<br>`VELA_RUNTIME_VOLUMES` |

{{% alert title="Note:" color="primary" %}}
Expand Down

0 comments on commit ef23e0f

Please sign in to comment.