From 9679f92ceca301372f4ef63dbdb5fab4e2435ec8 Mon Sep 17 00:00:00 2001 From: Kelly Merrick Date: Mon, 2 Oct 2023 09:54:59 -0500 Subject: [PATCH 1/2] enh(logging): add VELA_LOG_FORMATTER documentation --- content/installation/server/reference/_index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/content/installation/server/reference/_index.md b/content/installation/server/reference/_index.md index 5dd52ad3e..060bea408 100644 --- a/content/installation/server/reference/_index.md +++ b/content/installation/server/reference/_index.md @@ -330,6 +330,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. From 8e32a43b85fea4c406fe6cd72cb4f0fef33ee9ec Mon Sep 17 00:00:00 2001 From: Kelly Merrick Date: Mon, 2 Oct 2023 10:25:35 -0500 Subject: [PATCH 2/2] enh(logging): alphabetize optional server env vars --- .../installation/server/reference/_index.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/installation/server/reference/_index.md b/content/installation/server/reference/_index.md index 060bea408..5789fc958 100644 --- a/content/installation/server/reference/_index.md +++ b/content/installation/server/reference/_index.md @@ -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. @@ -548,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.