Skip to content

Commit

Permalink
docs(cli): correct headings in argo command's Long description (a…
Browse files Browse the repository at this point in the history
…rgoproj#11980)

Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Anton Gilgur <[email protected]>
  • Loading branch information
agilgur5 authored Nov 20, 2023
1 parent d7d0461 commit feaed7a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions cmd/argo/commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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).
Expand Down
14 changes: 7 additions & 7 deletions docs/cli/argo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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).

Expand Down

0 comments on commit feaed7a

Please sign in to comment.