Skip to content

Commit

Permalink
enh(logging): add VELA_LOG_FORMATTER documentation (#379)
Browse files Browse the repository at this point in the history
  • Loading branch information
KellyMerrick committed Oct 3, 2023
1 parent 32cb5b0 commit c651924
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions content/installation/server/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,18 +97,6 @@ The variable should be provided as a `string`.

This section contains a list of all variables that can be provided to the server.

### VELA_SECRET

This variable sets a shared secret with the Vela [worker](/docs/installation/worker/) for authenticating communication between workers and the server.

Only necessary to provide if utilizing the [server-worker trusted symmetric worker authentication method](/docs/installation/worker/docker/#worker-server-trusted-symmetric-token).

The variable should be provided as a `string`.

{{% alert title="Note:" color="primary" %}}
This variable should match [the `VELA_SERVER_SECRET` variable](/docs/installation/worker/reference/#vela_server_secret) provided to the worker.
{{% /alert %}}

### VELA_CLONE_IMAGE

This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler) for the server.
Expand Down Expand Up @@ -330,6 +318,16 @@ This variable should only be used for local development.
This variable has a default value of `true`.
{{% /alert %}}

### VELA_LOG_FORMATTER

This variable sets whether the logging formatter used for structured server logs is a standard JSON logger, or a custom Elasticsearch Common Schema (ECS) compatible JSON formatter.

The variable can be provided as a `string`.

{{% alert title="Note:" color="primary" %}}
This variable has a default value of `json`. Valid values are: `json`, and `ecs`.
{{% /alert %}}

### VELA_MAX_BUILD_LIMIT

This variable sets the maximum amount of concurrent builds a repo is allowed to run.
Expand Down Expand Up @@ -538,6 +536,18 @@ The variable can be provided as a `string`.
This variable has a default value of [the `VELA_ADDR` variable](/docs/installation/server/reference/#vela_addr) provided to the server.
{{% /alert %}}

### VELA_SECRET

This variable sets a shared secret with the Vela [worker](/docs/installation/worker/) for authenticating communication between workers and the server.

Only necessary to provide if utilizing the [server-worker trusted symmetric worker authentication method](/docs/installation/worker/docker/#worker-server-trusted-symmetric-token).

The variable should be provided as a `string`.

{{% alert title="Note:" color="primary" %}}
This variable should match [the `VELA_SERVER_SECRET` variable](/docs/installation/worker/reference/#vela_server_secret) provided to the worker.
{{% /alert %}}

### VELA_SECRET_VAULT

This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server.
Expand Down

0 comments on commit c651924

Please sign in to comment.