Worker options / v0.1.10
Choose the boundary.
The worker's defaults limit network access and privilege. Enable options only when a workflow needs them and the host operator accepts the added access.
| Option | Default and effect |
|---|---|
--network {bridge,none} | none. Bridge permits public internet access and service containers. |
--runner-image | Unset. Selects an operator-provided image digest only for eligible ubuntu-latest jobs when the submit has no image. |
--passwordless-sudo | Off. Allows passwordless sudo inside the job container, which can let job code become root there. |
--job-privileges | Off. Adds CAP_SYS_CHROOT and a restricted seccomp allowance for personality. |
--docker-socket | Off. Gives job code control of the host Docker engine. Treat this as host-level access. |
--secrets | Off. Enables eligible file-backed secrets; also requires --github-repository OWNER/NAME. |
--oidc-issuer URL | Unset. Enables the local OIDC token endpoint. See OIDC tokens. |
--oidc-pull-request | Off. Allows eligible same-repository pull requests to request OIDC tokens. |
--disk-budget-bytes N | Defaults to 10 GiB under the worker state directory. |
Exact worker synopsis
This synopsis is from the published v0.1.10 package's worker --help:
worker [-h] --repository REPOSITORY [--disk-budget-bytes DISK_BUDGET_BYTES] [--network {bridge,none}] [--docker-context DOCKER_CONTEXT] [--docker-socket] [--secrets] [--github-repository GITHUB_REPOSITORY] [--app-key APP_KEY] [--key-dir KEY_DIR] [--oidc-issuer OIDC_ISSUER] [--oidc-pull-request] [--api-base API_BASE] [--secret-ref SECRET_REF] [--secret-pusher SECRET_PUSHER] [--node24 NODE24] [--runner-image RUNNER_IMAGE] [--passwordless-sudo] [--job-privileges]
Read python -m execution_core worker --help for descriptions and option values. The global --state STATE must come before worker. Worker options affect all jobs assigned to that worker.