From c7f0a641415a52aabbf7f895d06f6f751e00307c Mon Sep 17 00:00:00 2001 From: Izaak Lauer <8404559+izaaklauer@users.noreply.github.com> Date: Wed, 23 Jun 2021 11:14:44 -0400 Subject: [PATCH] Not being unnecessarily perscriptive about truthiness, per Rae's suggestion --- website/content/docs/automating-execution/index.mdx | 6 +++--- website/content/docs/entrypoint/disable.mdx | 4 ++-- website/content/docs/runner/run-manual.mdx | 8 +++++--- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/website/content/docs/automating-execution/index.mdx b/website/content/docs/automating-execution/index.mdx index c79d7518caa..65219f19e38 100644 --- a/website/content/docs/automating-execution/index.mdx +++ b/website/content/docs/automating-execution/index.mdx @@ -43,9 +43,9 @@ configure the Waypoint CLI for communication with the Waypoint server. - `WAYPOINT_SERVER_TOKEN`. Must be set to a Waypoint token, created with [`waypoint token new`](/commands/token-new) - `WAYPOINT_SERVER_ADDR`. The address to the Waypoint server gRPC address. This must be accessible from the network that the client is running on. -- `WAYPOINT_SERVER_TLS`. Should be set to `1` to configure the client to use TLS when +- `WAYPOINT_SERVER_TLS`. Should be set to a truthy value (e.g. "1") to configure the client to use TLS when connecting to the server. -- `WAYPOINT_SERVER_TLS_SKIP_VERIFY`. Current must be set to `1` to disable TLS verification +- `WAYPOINT_SERVER_TLS_SKIP_VERIFY`. Current must be set to truthy value (e.g. "1") to disable TLS verification when communicating with the server. ~> The Waypoint server token is sensitive and should be @@ -71,7 +71,7 @@ If Waypoint detects that the terminal does not support interactivity it will out simpler "non-interactive" output mode. This output is easier to consume in a CI/CD systems logging views, or through log archiving systems. This is automatic and does not need to be explicitly configured, but can be forced by setting -the environment variable `WAYPOINT_PLAIN` to `1`. +the environment variable `WAYPOINT_PLAIN` to a truthy value (e.g. "1"). ## Workspaces diff --git a/website/content/docs/entrypoint/disable.mdx b/website/content/docs/entrypoint/disable.mdx index 6ae77e4a5d0..ef95ff39d6d 100644 --- a/website/content/docs/entrypoint/disable.mdx +++ b/website/content/docs/entrypoint/disable.mdx @@ -22,10 +22,10 @@ deployments and apps. ## Disable at Runtime You can disable the entrypoint at runtime by setting the `WAYPOINT_CEB_DISABLE` -environment variable to 1. +environment variable to a truthy value (e.g. "1"). This environment variable is checked immediately on entrypoint startup. If -it is set to 1 then the entrypoint will immediately execute the +the value is true, then the entrypoint will immediately execute the child process. The entrypoint **will not** attempt to even connect to the server and will not use any network or disk resources. diff --git a/website/content/docs/runner/run-manual.mdx b/website/content/docs/runner/run-manual.mdx index 6790bf0134c..39d5cf19b6d 100644 --- a/website/content/docs/runner/run-manual.mdx +++ b/website/content/docs/runner/run-manual.mdx @@ -42,9 +42,11 @@ The environment variables specify how to connect to the server: that the runner can reach. The port should be for the gRPC API, and is typically 9701. -- `WAYPOINT_SERVER_TLS` should be set to 1 if the server is listening - on TLS. You may additionally set `WAYPOINT_SERVER_TLS_SKIP_VERIFY` to - 1 if the TLS cert is invalid and can be safely ignored +- `WAYPOINT_SERVER_TLS` should be set to a truthy value (e.g. "1") if + the server is listening on TLS. + +- `WAYPOINT_SERVER_TLS_SKIP_VERIFY` should be set to a truthy value + (e.g. "1") if the TLS cert is invalid and can be safely ignored, such as in a development environment. - `WAYPOINT_SERVER_TOKEN` should be an [auth token](/docs/server/auth)