From 66680f1c9bca8b47c40ce918b5d16714058647cb Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Sun, 11 Feb 2024 16:17:14 -0500 Subject: [PATCH] fix(build): check for env vars in all dirs (#12652) Signed-off-by: Anton Gilgur --- cmd/argo/commands/client/conn.go | 2 +- cmd/argo/commands/server.go | 16 +------ docs/cli/argo.md | 2 +- docs/cli/argo_archive.md | 2 +- docs/cli/argo_archive_delete.md | 2 +- docs/cli/argo_archive_get.md | 2 +- docs/cli/argo_archive_list-label-keys.md | 2 +- docs/cli/argo_archive_list-label-values.md | 2 +- docs/cli/argo_archive_list.md | 2 +- docs/cli/argo_archive_resubmit.md | 2 +- docs/cli/argo_archive_retry.md | 2 +- docs/cli/argo_auth.md | 2 +- docs/cli/argo_auth_token.md | 2 +- docs/cli/argo_cluster-template.md | 2 +- docs/cli/argo_cluster-template_create.md | 2 +- docs/cli/argo_cluster-template_delete.md | 2 +- docs/cli/argo_cluster-template_get.md | 2 +- docs/cli/argo_cluster-template_lint.md | 2 +- docs/cli/argo_cluster-template_list.md | 2 +- docs/cli/argo_completion.md | 2 +- docs/cli/argo_cp.md | 2 +- docs/cli/argo_cron.md | 2 +- docs/cli/argo_cron_create.md | 2 +- docs/cli/argo_cron_delete.md | 2 +- docs/cli/argo_cron_get.md | 2 +- docs/cli/argo_cron_lint.md | 2 +- docs/cli/argo_cron_list.md | 2 +- docs/cli/argo_cron_resume.md | 2 +- docs/cli/argo_cron_suspend.md | 2 +- docs/cli/argo_delete.md | 2 +- docs/cli/argo_executor-plugin.md | 2 +- docs/cli/argo_executor-plugin_build.md | 2 +- docs/cli/argo_get.md | 2 +- docs/cli/argo_lint.md | 2 +- docs/cli/argo_list.md | 2 +- docs/cli/argo_logs.md | 2 +- docs/cli/argo_node.md | 2 +- docs/cli/argo_resubmit.md | 2 +- docs/cli/argo_resume.md | 2 +- docs/cli/argo_retry.md | 2 +- docs/cli/argo_server.md | 4 +- docs/cli/argo_stop.md | 2 +- docs/cli/argo_submit.md | 2 +- docs/cli/argo_suspend.md | 2 +- docs/cli/argo_template.md | 2 +- docs/cli/argo_template_create.md | 2 +- docs/cli/argo_template_delete.md | 2 +- docs/cli/argo_template_get.md | 2 +- docs/cli/argo_template_lint.md | 2 +- docs/cli/argo_template_list.md | 2 +- docs/cli/argo_terminate.md | 2 +- docs/cli/argo_version.md | 2 +- docs/cli/argo_wait.md | 2 +- docs/cli/argo_watch.md | 2 +- docs/environment-variables.md | 12 ++++- hack/check-env-doc.sh | 56 +++++++++++++--------- 56 files changed, 98 insertions(+), 94 deletions(-) diff --git a/cmd/argo/commands/client/conn.go b/cmd/argo/commands/client/conn.go index 8d92587bbcab..995c9ee76a57 100644 --- a/cmd/argo/commands/client/conn.go +++ b/cmd/argo/commands/client/conn.go @@ -45,7 +45,7 @@ func AddAPIClientFlagsToCmd(cmd *cobra.Command) { cmd.PersistentFlags().StringVar(&instanceID, "instanceid", os.Getenv("ARGO_INSTANCEID"), "submit with a specific controller's instance id label. Default to the ARGO_INSTANCEID environment variable.") // "-s" like kubectl cmd.PersistentFlags().StringVarP(&ArgoServerOpts.URL, "argo-server", "s", os.Getenv("ARGO_SERVER"), "API server `host:port`. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable.") - cmd.PersistentFlags().StringVar(&ArgoServerOpts.Path, "argo-base-href", os.Getenv("ARGO_BASE_HREF"), "An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable.") + cmd.PersistentFlags().StringVar(&ArgoServerOpts.Path, "argo-base-href", os.Getenv("ARGO_BASE_HREF"), "Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable.") cmd.PersistentFlags().BoolVar(&ArgoServerOpts.HTTP1, "argo-http1", os.Getenv("ARGO_HTTP1") == "true", "If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable.") cmd.PersistentFlags().StringSliceVarP(&ArgoServerOpts.Headers, "header", "H", []string{}, "Sets additional header to all requests made by Argo CLI. (Can be repeated multiple times to add multiple headers, also supports comma separated headers) Used only when either ARGO_HTTP1 or --argo-http1 is set to true.") // "-e" for encrypted - like zip diff --git a/cmd/argo/commands/server.go b/cmd/argo/commands/server.go index ec3c62c875eb..d9860b30ea69 100644 --- a/cmd/argo/commands/server.go +++ b/cmd/argo/commands/server.go @@ -4,10 +4,8 @@ import ( "context" "crypto/tls" "fmt" - "net/http" "os" "reflect" - "strconv" "strings" "time" @@ -188,18 +186,6 @@ See %s`, help.ArgoServer), return err } - // disabled by default, for security - if x, enabled := os.LookupEnv("ARGO_SERVER_PPROF"); enabled { - port, err := strconv.Atoi(x) - if err != nil { - return err - } - go func() { - log.Infof("starting server for pprof on :%d, see https://golang.org/pkg/net/http/pprof/", port) - log.Println(http.ListenAndServe(fmt.Sprintf(":%d", port), nil)) - }() - } - server.Run(ctx, port, browserOpenFunc) return nil }, @@ -232,7 +218,7 @@ See %s`, help.ArgoServer), command.Flags().StringVar(&frameOptions, "x-frame-options", "DENY", "Set X-Frame-Options header in HTTP responses.") command.Flags().StringVar(&accessControlAllowOrigin, "access-control-allow-origin", "", "Set Access-Control-Allow-Origin header in HTTP responses.") command.Flags().Uint64Var(&apiRateLimit, "api-rate-limit", 1000, "Set limit per IP for api ratelimiter") - command.Flags().StringArrayVar(&allowedLinkProtocol, "allowed-link-protocol", defaultAllowedLinkProtocol, "Allowed link protocol in configMap. Used if the allowed configMap links protocol are different from http,https. Defaults to the environment variable ALLOWED_LINK_PROTOCOL") + command.Flags().StringArrayVar(&allowedLinkProtocol, "allowed-link-protocol", defaultAllowedLinkProtocol, "Allowed protocols for links feature. Defaults to the environment variable ALLOWED_LINK_PROTOCOL: http,https") command.Flags().StringVar(&logFormat, "log-format", "text", "The formatter to use for logs. One of: text|json") command.Flags().Float32Var(&kubeAPIQPS, "kube-api-qps", 20.0, "QPS to use while talking with kube-apiserver.") command.Flags().IntVar(&kubeAPIBurst, "kube-api-burst", 30, "Burst to use while talking with kube-apiserver.") diff --git a/docs/cli/argo.md b/docs/cli/argo.md index 3574319e4f89..1ba356e2dce2 100644 --- a/docs/cli/argo.md +++ b/docs/cli/argo.md @@ -69,7 +69,7 @@ argo [flags] ### Options ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive.md b/docs/cli/argo_archive.md index 2375b7ff3a3f..ee5ab574fea1 100644 --- a/docs/cli/argo_archive.md +++ b/docs/cli/argo_archive.md @@ -15,7 +15,7 @@ argo archive [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_delete.md b/docs/cli/argo_archive_delete.md index 8381976b866a..ca56e7a932ec 100644 --- a/docs/cli/argo_archive_delete.md +++ b/docs/cli/argo_archive_delete.md @@ -15,7 +15,7 @@ argo archive delete UID... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_get.md b/docs/cli/argo_archive_get.md index 9568d375eca8..9f767f5be44a 100644 --- a/docs/cli/argo_archive_get.md +++ b/docs/cli/argo_archive_get.md @@ -16,7 +16,7 @@ argo archive get UID [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_list-label-keys.md b/docs/cli/argo_archive_list-label-keys.md index f46da1a97622..e5edfb28efc1 100644 --- a/docs/cli/argo_archive_list-label-keys.md +++ b/docs/cli/argo_archive_list-label-keys.md @@ -15,7 +15,7 @@ argo archive list-label-keys [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_list-label-values.md b/docs/cli/argo_archive_list-label-values.md index e41582333515..3251f3797f15 100644 --- a/docs/cli/argo_archive_list-label-values.md +++ b/docs/cli/argo_archive_list-label-values.md @@ -16,7 +16,7 @@ argo archive list-label-values [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_list.md b/docs/cli/argo_archive_list.md index f02e35109ff7..6bbf283d335f 100644 --- a/docs/cli/argo_archive_list.md +++ b/docs/cli/argo_archive_list.md @@ -18,7 +18,7 @@ argo archive list [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_resubmit.md b/docs/cli/argo_archive_resubmit.md index 0ce78536b3c9..4fb78fe85e74 100644 --- a/docs/cli/argo_archive_resubmit.md +++ b/docs/cli/argo_archive_resubmit.md @@ -57,7 +57,7 @@ argo archive resubmit [WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_archive_retry.md b/docs/cli/argo_archive_retry.md index 710bdbbbda9f..1dbc9c7a1f65 100644 --- a/docs/cli/argo_archive_retry.md +++ b/docs/cli/argo_archive_retry.md @@ -57,7 +57,7 @@ argo archive retry [WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_auth.md b/docs/cli/argo_auth.md index e7ca7f211418..5b5e9b60a740 100644 --- a/docs/cli/argo_auth.md +++ b/docs/cli/argo_auth.md @@ -15,7 +15,7 @@ argo auth [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_auth_token.md b/docs/cli/argo_auth_token.md index 28c320441e6c..ec0c33901833 100644 --- a/docs/cli/argo_auth_token.md +++ b/docs/cli/argo_auth_token.md @@ -15,7 +15,7 @@ argo auth token [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template.md b/docs/cli/argo_cluster-template.md index 5c6c8a5405c9..9419675090d6 100644 --- a/docs/cli/argo_cluster-template.md +++ b/docs/cli/argo_cluster-template.md @@ -15,7 +15,7 @@ argo cluster-template [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template_create.md b/docs/cli/argo_cluster-template_create.md index 78620dcf92e3..5841af4a707e 100644 --- a/docs/cli/argo_cluster-template_create.md +++ b/docs/cli/argo_cluster-template_create.md @@ -31,7 +31,7 @@ argo cluster-template create FILE1 FILE2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template_delete.md b/docs/cli/argo_cluster-template_delete.md index 99c8c2f9c5bc..140aee41f2b0 100644 --- a/docs/cli/argo_cluster-template_delete.md +++ b/docs/cli/argo_cluster-template_delete.md @@ -16,7 +16,7 @@ argo cluster-template delete WORKFLOW_TEMPLATE [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template_get.md b/docs/cli/argo_cluster-template_get.md index 89c297589cb9..5ed1f7767a59 100644 --- a/docs/cli/argo_cluster-template_get.md +++ b/docs/cli/argo_cluster-template_get.md @@ -16,7 +16,7 @@ argo cluster-template get CLUSTER WORKFLOW_TEMPLATE... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template_lint.md b/docs/cli/argo_cluster-template_lint.md index 49b6a79ad9c5..0c5b2947283e 100644 --- a/docs/cli/argo_cluster-template_lint.md +++ b/docs/cli/argo_cluster-template_lint.md @@ -17,7 +17,7 @@ argo cluster-template lint FILE... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cluster-template_list.md b/docs/cli/argo_cluster-template_list.md index 71068b735c77..9623938fc810 100644 --- a/docs/cli/argo_cluster-template_list.md +++ b/docs/cli/argo_cluster-template_list.md @@ -30,7 +30,7 @@ argo cluster-template list [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_completion.md b/docs/cli/argo_completion.md index 136e4abdb49e..4470f00ca393 100644 --- a/docs/cli/argo_completion.md +++ b/docs/cli/argo_completion.md @@ -28,7 +28,7 @@ argo completion SHELL [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cp.md b/docs/cli/argo_cp.md index 4deabf3cd0e9..d3a5305fd942 100644 --- a/docs/cli/argo_cp.md +++ b/docs/cli/argo_cp.md @@ -33,7 +33,7 @@ argo cp my-wf output-directory ... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron.md b/docs/cli/argo_cron.md index b4807f0382da..880b011562b0 100644 --- a/docs/cli/argo_cron.md +++ b/docs/cli/argo_cron.md @@ -19,7 +19,7 @@ argo cron [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_create.md b/docs/cli/argo_cron_create.md index 4964e04ef43b..024440fbe698 100644 --- a/docs/cli/argo_cron_create.md +++ b/docs/cli/argo_cron_create.md @@ -25,7 +25,7 @@ argo cron create FILE1 FILE2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_delete.md b/docs/cli/argo_cron_delete.md index 14352346708f..cecfb07b81ef 100644 --- a/docs/cli/argo_cron_delete.md +++ b/docs/cli/argo_cron_delete.md @@ -16,7 +16,7 @@ argo cron delete [CRON_WORKFLOW... | --all] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_get.md b/docs/cli/argo_cron_get.md index 73badb4f7af9..6c4516a7ddfd 100644 --- a/docs/cli/argo_cron_get.md +++ b/docs/cli/argo_cron_get.md @@ -16,7 +16,7 @@ argo cron get CRON_WORKFLOW... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_lint.md b/docs/cli/argo_cron_lint.md index 85768db3cc27..311007b60102 100644 --- a/docs/cli/argo_cron_lint.md +++ b/docs/cli/argo_cron_lint.md @@ -17,7 +17,7 @@ argo cron lint FILE... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_list.md b/docs/cli/argo_cron_list.md index 7a89024cb911..e719b8246044 100644 --- a/docs/cli/argo_cron_list.md +++ b/docs/cli/argo_cron_list.md @@ -18,7 +18,7 @@ argo cron list [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_resume.md b/docs/cli/argo_cron_resume.md index d02698edef36..6b02799cad5a 100644 --- a/docs/cli/argo_cron_resume.md +++ b/docs/cli/argo_cron_resume.md @@ -15,7 +15,7 @@ argo cron resume [CRON_WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_cron_suspend.md b/docs/cli/argo_cron_suspend.md index 78ccaf259cf5..3f592bbfb98e 100644 --- a/docs/cli/argo_cron_suspend.md +++ b/docs/cli/argo_cron_suspend.md @@ -15,7 +15,7 @@ argo cron suspend CRON_WORKFLOW... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_delete.md b/docs/cli/argo_delete.md index 0f71b297a920..8ae752e1b568 100644 --- a/docs/cli/argo_delete.md +++ b/docs/cli/argo_delete.md @@ -40,7 +40,7 @@ argo delete [--dry-run] [WORKFLOW...|[--all] [--older] [--completed] [--resubmit ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_executor-plugin.md b/docs/cli/argo_executor-plugin.md index df57b63e03cc..63461a85976d 100644 --- a/docs/cli/argo_executor-plugin.md +++ b/docs/cli/argo_executor-plugin.md @@ -15,7 +15,7 @@ argo executor-plugin [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_executor-plugin_build.md b/docs/cli/argo_executor-plugin_build.md index 6134508d21ac..27e4216db55a 100644 --- a/docs/cli/argo_executor-plugin_build.md +++ b/docs/cli/argo_executor-plugin_build.md @@ -15,7 +15,7 @@ argo executor-plugin build DIR [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_get.md b/docs/cli/argo_get.md index 72fc870492d3..8509a6a3b385 100644 --- a/docs/cli/argo_get.md +++ b/docs/cli/argo_get.md @@ -32,7 +32,7 @@ argo get WORKFLOW... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_lint.md b/docs/cli/argo_lint.md index 426d8b928710..2a4cf53aad61 100644 --- a/docs/cli/argo_lint.md +++ b/docs/cli/argo_lint.md @@ -32,7 +32,7 @@ argo lint FILE... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_list.md b/docs/cli/argo_list.md index 75ae807ae652..e384c46dccb1 100644 --- a/docs/cli/argo_list.md +++ b/docs/cli/argo_list.md @@ -60,7 +60,7 @@ argo list [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_logs.md b/docs/cli/argo_logs.md index fc9f9ffb8a64..530b9d8d7202 100644 --- a/docs/cli/argo_logs.md +++ b/docs/cli/argo_logs.md @@ -57,7 +57,7 @@ argo logs WORKFLOW [POD] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_node.md b/docs/cli/argo_node.md index d291e1eccf19..df7120ef3bcb 100644 --- a/docs/cli/argo_node.md +++ b/docs/cli/argo_node.md @@ -32,7 +32,7 @@ argo node ACTION WORKFLOW FLAGS [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_resubmit.md b/docs/cli/argo_resubmit.md index 0aa383f8be8e..1173a2c520c7 100644 --- a/docs/cli/argo_resubmit.md +++ b/docs/cli/argo_resubmit.md @@ -65,7 +65,7 @@ argo resubmit [WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_resume.md b/docs/cli/argo_resume.md index 8cb905ad3958..74e01d5de1cd 100644 --- a/docs/cli/argo_resume.md +++ b/docs/cli/argo_resume.md @@ -37,7 +37,7 @@ argo resume WORKFLOW1 WORKFLOW2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_retry.md b/docs/cli/argo_retry.md index 5007f620e1d7..54c9266cb3af 100644 --- a/docs/cli/argo_retry.md +++ b/docs/cli/argo_retry.md @@ -68,7 +68,7 @@ argo retry [WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_server.md b/docs/cli/argo_server.md index 1876fc108d11..f702272249ce 100644 --- a/docs/cli/argo_server.md +++ b/docs/cli/argo_server.md @@ -17,7 +17,7 @@ See https://argo-workflows.readthedocs.io/en/latest/argo-server/ ``` --access-control-allow-origin string Set Access-Control-Allow-Origin header in HTTP responses. - --allowed-link-protocol stringArray Allowed link protocol in configMap. Used if the allowed configMap links protocol are different from http,https. Defaults to the environment variable ALLOWED_LINK_PROTOCOL (default [http,https]) + --allowed-link-protocol stringArray Allowed protocols for links feature. Defaults to the environment variable ALLOWED_LINK_PROTOCOL: http,https (default [http,https]) --api-rate-limit uint Set limit per IP for api ratelimiter (default 1000) --auth-mode stringArray API server authentication mode. Any 1 or more length permutation of: client,server,sso (default [client]) --basehref string Value for base href in index.html. Used if the server is running behind reverse proxy under subpath different from /. Defaults to the environment variable BASE_HREF. (default "/") @@ -42,7 +42,7 @@ See https://argo-workflows.readthedocs.io/en/latest/argo-server/ ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_stop.md b/docs/cli/argo_stop.md index 33807197bdb3..3e00d790684f 100644 --- a/docs/cli/argo_stop.md +++ b/docs/cli/argo_stop.md @@ -45,7 +45,7 @@ argo stop WORKFLOW WORKFLOW2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_submit.md b/docs/cli/argo_submit.md index 823c427efa6b..3c1aa1cdbacd 100644 --- a/docs/cli/argo_submit.md +++ b/docs/cli/argo_submit.md @@ -59,7 +59,7 @@ argo submit [FILE... | --from `kind/name] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_suspend.md b/docs/cli/argo_suspend.md index bb06db3a0f54..6032872f78ba 100644 --- a/docs/cli/argo_suspend.md +++ b/docs/cli/argo_suspend.md @@ -27,7 +27,7 @@ argo suspend WORKFLOW1 WORKFLOW2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template.md b/docs/cli/argo_template.md index bbfc6a438c8d..7c1f6629bd53 100644 --- a/docs/cli/argo_template.md +++ b/docs/cli/argo_template.md @@ -15,7 +15,7 @@ argo template [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template_create.md b/docs/cli/argo_template_create.md index 953f408f3be8..45d64999f571 100644 --- a/docs/cli/argo_template_create.md +++ b/docs/cli/argo_template_create.md @@ -17,7 +17,7 @@ argo template create FILE1 FILE2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template_delete.md b/docs/cli/argo_template_delete.md index 74c8077b4494..4ff7ade0d8de 100644 --- a/docs/cli/argo_template_delete.md +++ b/docs/cli/argo_template_delete.md @@ -16,7 +16,7 @@ argo template delete WORKFLOW_TEMPLATE [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template_get.md b/docs/cli/argo_template_get.md index ee0f42f4751c..09a23f7c1e31 100644 --- a/docs/cli/argo_template_get.md +++ b/docs/cli/argo_template_get.md @@ -16,7 +16,7 @@ argo template get WORKFLOW_TEMPLATE... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template_lint.md b/docs/cli/argo_template_lint.md index 65ac604d8a77..f59c2a26bd34 100644 --- a/docs/cli/argo_template_lint.md +++ b/docs/cli/argo_template_lint.md @@ -17,7 +17,7 @@ argo template lint (DIRECTORY | FILE1 FILE2 FILE3...) [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_template_list.md b/docs/cli/argo_template_list.md index a1dbf6aa5397..5bc5940a4aed 100644 --- a/docs/cli/argo_template_list.md +++ b/docs/cli/argo_template_list.md @@ -17,7 +17,7 @@ argo template list [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_terminate.md b/docs/cli/argo_terminate.md index 9f3530709571..c7dcfa168ff3 100644 --- a/docs/cli/argo_terminate.md +++ b/docs/cli/argo_terminate.md @@ -43,7 +43,7 @@ argo terminate WORKFLOW WORKFLOW2... [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_version.md b/docs/cli/argo_version.md index a780cc7483d6..0651ec3eaf63 100644 --- a/docs/cli/argo_version.md +++ b/docs/cli/argo_version.md @@ -16,7 +16,7 @@ argo version [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_wait.md b/docs/cli/argo_wait.md index 76d5d459afc6..040406eafb59 100644 --- a/docs/cli/argo_wait.md +++ b/docs/cli/argo_wait.md @@ -29,7 +29,7 @@ argo wait [WORKFLOW...] [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/cli/argo_watch.md b/docs/cli/argo_watch.md index 3ff9c999a5c6..842fc024c66c 100644 --- a/docs/cli/argo_watch.md +++ b/docs/cli/argo_watch.md @@ -30,7 +30,7 @@ argo watch WORKFLOW [flags] ### Options inherited from parent commands ``` - --argo-base-href string An path to use with HTTP client (e.g. due to BASE_HREF). Defaults to the ARGO_BASE_HREF environment variable. + --argo-base-href string Path to use with HTTP client due to BASE_HREF. Defaults to the ARGO_BASE_HREF environment variable. --argo-http1 If true, use the HTTP client. Defaults to the ARGO_HTTP1 environment variable. -s, --argo-server host:port API server host:port. e.g. localhost:2746. Defaults to the ARGO_SERVER environment variable. --as string Username to impersonate for the operation diff --git a/docs/environment-variables.md b/docs/environment-variables.md index 37ca7cf7969a..8237692361b3 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -14,7 +14,7 @@ This document outlines environment variables that can be used to customize behav | `ALL_POD_CHANGES_SIGNIFICANT` | `bool` | `false` | Whether to consider all pod changes as significant during pod reconciliation. | | `ALWAYS_OFFLOAD_NODE_STATUS` | `bool` | `false` | Whether to always offload the node status. | | `ARCHIVED_WORKFLOW_GC_PERIOD` | `time.Duration` | `24h` | The periodicity for GC of archived workflows. | -| `ARGO_PPROF` | `bool` | `false` | Enable `pprof` endpoints | +| `ARGO_PPROF` | `bool` | `false` | Enable [`pprof`](https://go.dev/blog/pprof) endpoints | | `ARGO_PROGRESS_PATCH_TICK_DURATION` | `time.Duration` | `1m` | How often self reported progress is patched into the pod annotations which means how long it takes until the controller picks up the progress change. Set to 0 to disable self reporting progress. | | `ARGO_PROGRESS_FILE_TICK_DURATION` | `time.Duration` | `3s` | How often the progress file is read by the executor. Set to 0 to disable self reporting progress. | | `ARGO_REMOVE_PVC_PROTECTION_FINALIZER` | `bool` | `true` | Remove the `kubernetes.io/pvc-protection` finalizer from persistent volume claims (PVC) after marking PVCs created for the workflow for deletion, so deleted is not blocked until the pods are deleted. [#6629](https://github.com/argoproj/argo-workflows/issues/6629) | @@ -94,6 +94,8 @@ spec: | Name | Type | Default | Description | |----------------------------------------|-----------------|---------|--------------------------------------------------------------------------------------------------------| +| `ARGO_DEBUG_PAUSE_AFTER` | `bool` | `false` | Enable [Debug Pause](debug-pause.md) after step execution +| `ARGO_DEBUG_PAUSE_BEFORE` | `bool` | `false` | Enable [Debug Pause](debug-pause.md) before step execution | `EXECUTOR_RETRY_BACKOFF_DURATION` | `time.Duration` | `1s` | The retry back-off duration when the workflow executor performs retries. | | `EXECUTOR_RETRY_BACKOFF_FACTOR` | `float` | `1.6` | The retry back-off factor when the workflow executor performs retries. | | `EXECUTOR_RETRY_BACKOFF_JITTER` | `float` | `0.5` | The retry back-off jitter when the workflow executor performs retries. | @@ -121,13 +123,19 @@ data: | Name | Type | Default | Description | |--------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------| +| `ALLOWED_LINK_PROTOCOL` | `string` | `http,https` | List of comma separated protocols allowed for the [Links feature](links.md) +| `ARGO_ARTIFACT_SERVER` | `bool` | `true` | Enable [Workflow Archive](workflow-archive.md) endpoints +| `ARGO_PPROF` | `bool` | `false` | Enable [`pprof`](https://go.dev/blog/pprof) endpoints +| `ARGO_SERVER_METRICS_AUTH` | `bool` | `true` | Enable auth on the `/metrics` endpoint +| `BASE_HREF` | `string` | `/` | [Base HREF](argo-server.md#base-href) of the Server | `DISABLE_VALUE_LIST_RETRIEVAL_KEY_PATTERN` | `string` | `""` | Disable the retrieval of the list of label values for keys based on this regular expression. | | `FIRST_TIME_USER_MODAL` | `bool` | `true` | Show this modal. | | `FEEDBACK_MODAL` | `bool` | `true` | Show this modal. | +| `GRPC_MESSAGE_SIZE` | `string` | `104857600` | Use different GRPC Max message size for Server (supporting huge workflows). | | `IP_KEY_FUNC_HEADERS` | `string` | `""` | List of comma separated request headers containing IPs to use for rate limiting. For example, "X-Forwarded-For,X-Real-IP". By default, uses the request's remote IP address. | | `NEW_VERSION_MODAL` | `bool` | `true` | Show this modal. | | `POD_NAMES` | `string` | `v2` | Whether to have pod names contain the template name (v2) or be the node id (v1) - should be set the same for Controller | -| `GRPC_MESSAGE_SIZE` | `string` | `104857600` | Use different GRPC Max message size for Server (supporting huge workflows). | +| `SSO_DELEGATE_RBAC_TO_NAMESPACE` | `bool` | `false` | Enable [SSO RBAC Namespace Delegation](argo-server-sso.md#sso-rbac-namespace-delegation) CLI parameters of the Server can be specified as environment variables with the `ARGO_` prefix. For example: diff --git a/hack/check-env-doc.sh b/hack/check-env-doc.sh index bbb7b8fa1335..88738de349ef 100755 --- a/hack/check-env-doc.sh +++ b/hack/check-env-doc.sh @@ -2,32 +2,42 @@ echo "Checking docs/environment-variables.md for completeness..." +# Directories to check. For cmd/, only check Controller, Executor, and Server. The CLI has generated docs +dirs=(./workflow ./persist ./util ./server ./cmd/argo/commands/server.go ./cmd/argoexec ./cmd/workflow-controller) +not_found="false" + function check-used { - grep "| \`" < ./docs/environment-variables.md \ - | awk '{gsub(/\`/, "", $2); print $2; }' \ - | while read -r x; do - var="${x%\`}"; - var="${var#\`}"; - if ! grep -qR --exclude="*_test.go" "$var" ./cmd/workflow-controller ./workflow ./persist ./util ./server ; then - echo "❌ Documented variable $var in docs/environment-variables.md is not used anywhere" >&2; - exit 1; - fi; - done + mapfile -t check < <(grep "| \`" < ./docs/environment-variables.md \ + | awk '{gsub(/\`/, "", $2); print $2; }') + + for x in "${check[@]}"; do + var="${x%\`}"; + var="${var#\`}"; + if ! grep -qR --exclude="*_test.go" "$var" "${dirs[@]}" ; then + echo "❌ Documented variable $var in docs/environment-variables.md is not used anywhere" >&2; + not_found="true"; + fi + done } function check-documented { - grep -REh --exclude="*_test.go" "Getenv.*?\(|LookupEnv.*?\(" ./workflow ./persist ./util \ - | grep -Eo "\"[A-Z_]+?\"" \ - | sort \ - | uniq \ - | while read -r x; do - var="${x%\"}"; - var="${var#\"}"; - if ! grep -q "$var" docs/environment-variables.md; then - echo "❌ Variable $var not documented in docs/environment-variables.md" >&2; - exit 1; - fi; - done + mapfile -t check < <(grep -REh --exclude="*_test.go" "Getenv.*?\(|LookupEnv.*?\(|env.Get*?\(" "${dirs[@]}" \ + | grep -Eo "\"[A-Z_]+?\"" \ + | sort \ + | uniq) + + for x in "${check[@]}"; do + var="${x%\"}"; + var="${var#\"}"; + if ! grep -q "$var" docs/environment-variables.md; then + echo "❌ Variable $var not documented in docs/environment-variables.md" >&2; + not_found="true"; + fi + done } -check-used && check-documented && echo "✅ Success - all environment variables appear to be documented" +check-used && check-documented; +if [[ "$not_found" == "true" ]]; then + exit 1; +fi +echo "✅ Success - all environment variables appear to be documented"