From feaed7ac8cf8a0667fc20b8be5bd590bef4da42a Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Mon, 20 Nov 2023 15:10:28 -0500 Subject: [PATCH] docs(cli): correct headings in `argo` command's `Long` description (#11980) Signed-off-by: Anton Gilgur Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> --- cmd/argo/commands/root.go | 14 +++++++------- docs/cli/argo.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/cmd/argo/commands/root.go b/cmd/argo/commands/root.go index 4571545b0afc..687b61f85702 100644 --- a/cmd/argo/commands/root.go +++ b/cmd/argo/commands/root.go @@ -34,7 +34,7 @@ func NewCommand() *cobra.Command { Long: ` You can use the CLI in the following modes: -# Kubernetes API Mode (default) +#### Kubernetes API Mode (default) Requests are sent directly to the Kubernetes API. No Argo Server is needed. Large workflows and the workflow archive are not supported. @@ -44,9 +44,9 @@ If you're using instance ID (which is very unlikely), you'll need to set it: ARGO_INSTANCEID=your-instanceid -# Argo Server GRPC Mode +#### Argo Server GRPC Mode -Requests are sent to the Argo Server API via GRPC (using HTTP/2). Large workflows and the workflow archive are supported. Network load-balancers that do not support HTTP/2 are not supported. +Requests are sent to the Argo Server API via GRPC (using HTTP/2). Large workflows and the workflow archive are supported. Network load-balancers that do not support HTTP/2 are not supported. Use if you do not have access to the Kubernetes API (e.g. you're in another cluster), and you're running the Argo Server using a network load-balancer that support HTTP/2. @@ -67,14 +67,14 @@ By default, the CLI uses your KUBECONFIG to determine default for ARGO_TOKEN and KUBECONFIG=/dev/null You will then need to set: - - ARGO_NAMESPACE=argo + + ARGO_NAMESPACE=argo And: - ARGO_TOKEN='Bearer ******' ;# Should always start with "Bearer " or "Basic ". + ARGO_TOKEN='Bearer ******' ;# Should always start with "Bearer " or "Basic ". -# Argo Server HTTP1 Mode +#### Argo Server HTTP1 Mode As per GRPC mode, but uses HTTP. Can be used with ALB that does not support HTTP/2. The command "argo logs --since-time=2020...." will not work (due to time-type). diff --git a/docs/cli/argo.md b/docs/cli/argo.md index 9723e6af8d33..3574319e4f89 100644 --- a/docs/cli/argo.md +++ b/docs/cli/argo.md @@ -7,7 +7,7 @@ argo is the command line interface to Argo You can use the CLI in the following modes: -# Kubernetes API Mode (default) +#### Kubernetes API Mode (default) Requests are sent directly to the Kubernetes API. No Argo Server is needed. Large workflows and the workflow archive are not supported. @@ -17,9 +17,9 @@ If you're using instance ID (which is very unlikely), you'll need to set it: ARGO_INSTANCEID=your-instanceid -# Argo Server GRPC Mode +#### Argo Server GRPC Mode -Requests are sent to the Argo Server API via GRPC (using HTTP/2). Large workflows and the workflow archive are supported. Network load-balancers that do not support HTTP/2 are not supported. +Requests are sent to the Argo Server API via GRPC (using HTTP/2). Large workflows and the workflow archive are supported. Network load-balancers that do not support HTTP/2 are not supported. Use if you do not have access to the Kubernetes API (e.g. you're in another cluster), and you're running the Argo Server using a network load-balancer that support HTTP/2. @@ -40,14 +40,14 @@ By default, the CLI uses your KUBECONFIG to determine default for ARGO_TOKEN and KUBECONFIG=/dev/null You will then need to set: - - ARGO_NAMESPACE=argo + + ARGO_NAMESPACE=argo And: - ARGO_TOKEN='Bearer ******' ;# Should always start with "Bearer " or "Basic ". + ARGO_TOKEN='Bearer ******' ;# Should always start with "Bearer " or "Basic ". -# Argo Server HTTP1 Mode +#### Argo Server HTTP1 Mode As per GRPC mode, but uses HTTP. Can be used with ALB that does not support HTTP/2. The command "argo logs --since-time=2020...." will not work (due to time-type).