From f414a8e98560d493d98312239a6ad3910d419721 Mon Sep 17 00:00:00 2001 From: Hari Sekhon Date: Mon, 13 Jun 2022 15:37:43 +0100 Subject: [PATCH] docs: added environment variables documentation (#8680) * added environment variables page Signed-off-by: Hari Sekhon * added Environment Variables page to User Guide Signed-off-by: Hari Sekhon * reformatted table cells as multiline for clarity Signed-off-by: Hari Sekhon * fixed typo Co-authored-by: Michael Crenshaw Signed-off-by: Michael Crenshaw --- docs/user-guide/environment-variables.md | 9 +++++++++ mkdocs.yml | 1 + 2 files changed, 10 insertions(+) create mode 100644 docs/user-guide/environment-variables.md diff --git a/docs/user-guide/environment-variables.md b/docs/user-guide/environment-variables.md new file mode 100644 index 0000000000000..ceea5798e83a3 --- /dev/null +++ b/docs/user-guide/environment-variables.md @@ -0,0 +1,9 @@ +# Environment Variables + +The following environment variables can be used with `argocd` CLI: + +| Environment Variable | Description | +| --- | --- | +| `ARGOCD_SERVER` | the address of the ArgoCD server without `https://` prefix
(instead of specifying `--server` for every command)
eg. `ARGOCD_SERVER=argocd.mycompany.com` if served through an ingress with DNS | +| `ARGOCD_AUTH_TOKEN` | the ArgoCD `apiKey` for your ArgoCD user to be able to authenticate | +| `ARGOCD_OPTS` | command-line options to pass to `argocd` CLI
eg. `ARGOCD_OPTS="--grpc-web"` | diff --git a/mkdocs.yml b/mkdocs.yml index a545c873907ee..edc1eb9437d26 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -129,6 +129,7 @@ nav: - user-guide/compare-options.md - user-guide/sync-options.md - user-guide/parameters.md + - user-guide/environment-variables.md - user-guide/build-environment.md - user-guide/tracking_strategies.md - user-guide/resource_tracking.md