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.

Sign up for GitHub

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

Jump to bottom

feat: document executor.log_streaming_timeout worker arg #337

Merged
merged 2 commits into from
Dec 16, 2022
Merged

feat: document executor.log_streaming_timeout worker arg #337

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33fad0b
document executor.log_streaming_timeout
cognifloyd Dec 14, 2022
a81f51d
Merge branch 'main' into log-timeout
wass3r Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions content/installation/worker/reference/executor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ Throughout the lifecycle of these resources, this component will track and repor

The following options are used to configure the component:

| Name | Description | Required | Default | Environment Variables |
| ----------------------- | ------------------------------------------------- | -------- | -------------- | ------------------------------------------------------- |
| `executor.driver` | type of client to control and operate executor | `true` | `linux` | `EXECUTOR_DRIVER`<br>`VELA_EXECUTOR_DRIVER` |
| `executor.log_method` | method used to publish logs back to the server | `true` | `byte-chunks` | `EXECUTOR_LOG_METHOD`<br>`VELA_EXECUTOR_LOG_METHOD` |
| `executor.max_log_size` | maximum log size (in bytes) | `false` | `0` (no limit) | `EXECUTOR_MAX_LOG_SIZE`<br>`VELA_EXECUTOR_MAX_LOG_SIZE` |
| Name | Description | Required | Default | Environment Variables |
| -------------------------------- | -------------------------------------------------------------------------- | -------- | -------------- | ------------------------------------------------------------------------- |
| `executor.driver` | type of client to control and operate executor | `true` | `linux` | `EXECUTOR_DRIVER`<br>`VELA_EXECUTOR_DRIVER` |
| `executor.log_method` | method used to publish logs back to the server | `true` | `byte-chunks` | `EXECUTOR_LOG_METHOD`<br>`VELA_EXECUTOR_LOG_METHOD` |
| `executor.max_log_size` | maximum log size (in bytes) | `false` | `0` (no limit) | `EXECUTOR_MAX_LOG_SIZE`<br>`VELA_EXECUTOR_MAX_LOG_SIZE` |
| `executor.log_streaming_timeout` | maximum time to wait, after build completion, for logs to finish streaming | `false` | `5m` | `EXECUTOR_LOG_STREAMING_TIMEOUT`<br>`VELA_EXECUTOR_LOG_STREAMING_TIMEOUT` |

{{% alert title="Note:" color="primary" %}}
For more information on these configuration options, please see the [worker reference](/docs/installation/worker/reference/).
Expand Down