Skip to content
This repository was archived by the owner on Jan 27, 2025. It is now read-only.

docs(executor): document max log size #276

Merged
wass3r merged 1 commit into from
Feb 9, 2022
Merged

docs(executor): document max log size #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion content/administration/worker/reference/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,18 @@ The possible options to provide for this variable are:
* `time-chunks`
{{% /alert %}}

### VELA_EXECUTOR_MAX_LOG_SIZE

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

This variable sets the maximum number of bytes for logs allowed to be uploaded per step.

The variable can be provided as an `integer`.

{{% alert title="Note:" color="primary" %}}
This variable has a default value of `0`. No limit.
{{% /alert %}}

### VELA_QUEUE_CLUSTER

This configuration variable is used by the [queue component](/docs/administration/worker/reference/queue/) for the worker.
Expand Down Expand Up @@ -254,4 +266,4 @@ The variable can be provided as a `string`.

This variable sets a fully qualified system path to the TLS certificate key used for HTTPS for the worker.

The variable can be provided as a `string`.
The variable can be provided as a `string`.
11 changes: 6 additions & 5 deletions content/administration/worker/reference/executor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ 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` |
| 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` |

{{% alert title="Note:" color="primary" %}}
For more information on these configuration options, please see the [worker reference](/docs/administration/worker/reference/).
Expand Down Expand Up @@ -64,4 +65,4 @@ This Linux configuration is enabled by default and is not necessary to provide i

The `local` executor driver is only intended for use with the [Vela CLI](/docs/reference/cli/).

It's not recommended to run any workloads on a worker configured with this driver.
It's not recommended to run any workloads on a worker configured with this driver.