argo is the command line interface to Argo
You can use the CLI in the following modes:
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.
Use when you have direct access to the Kubernetes API, and don't need large workflow or workflow archive support.
If you're using instance ID (which is very unlikely), you'll need to set it:
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.
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.
To enable, set ARGO_SERVER:
ARGO_SERVER=localhost:2746 ;# The format is "host:port" - do not prefix with "http" or "https"
If you're have transport-layer security (TLS) enabled (i.e. you are running "argo server --secure" and therefore has HTTPS):
If your server is running with self-signed certificates. Do not use in production:
By default, the CLI uses your KUBECONFIG to determine default for ARGO_TOKEN and ARGO_NAMESPACE. You probably error with "no configuration has been provided". To prevent it:
You will then need to set:
ARGO_TOKEN='Bearer ******' ;# Should always start with "Bearer " or "Basic ".
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).
Use this when your network load-balancer does not support HTTP/2.
Use the same configuration as GRPC mode, but also set:
If your server is behind an ingress with a path (you'll be running "argo server --basehref /...) or "BASE_HREF=/... argo server"):
--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-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 --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. --as-uid string UID to impersonate for the operation --certificate-authority string Path to a cert file for the certificate authority --client-certificate string Path to a client certificate file for TLS --client-key string Path to a client key file for TLS --cluster string The name of the kubeconfig cluster to use --context string The name of the kubeconfig context to use --gloglevel int Set the glog logging level -H, --header strings 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. -h, --help help for argo --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure -k, --insecure-skip-verify If true, the Argo Server's certificate will not be checked for validity. This will make your HTTPS connections insecure. Defaults to the ARGO_INSECURE_SKIP_VERIFY environment variable. --instanceid string submit with a specific controller's instance id label. Default to the ARGO_INSTANCEID environment variable. --kubeconfig string Path to a kube config. Only required if out-of-cluster --loglevel string Set the logging level. One of: debug|info|warn|error (default "info") -n, --namespace string If present, the namespace scope for this CLI request --password string Password for basic authentication to the API server --proxy-url string If provided, this URL will be used to connect via proxy --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -e, --secure Whether or not the server is using TLS with the Argo Server. Defaults to the ARGO_SECURE environment variable. (default true) --server string The address and port of the Kubernetes API server --tls-server-name string If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used. --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use --username string Username for basic authentication to the API server -v, --verbose Enabled verbose logging, i.e. --loglevel debug
- argo archive - manage the workflow archive
- argo auth - manage authentication settings
- argo cluster-template - manipulate cluster workflow templates
- argo completion - output shell completion code for the specified shell (bash or zsh)
- argo cp - copy artifacts from workflow
- argo cron - manage cron workflows
- argo delete - delete workflows
- argo executor-plugin - manage executor plugins
- argo get - display details about a workflow
- argo lint - validate files or directories of manifests
- argo list - list workflows
- argo logs - view logs of a pod or workflow
- argo node - perform action on a node in a workflow
- argo resubmit - resubmit one or more workflows
- argo resume - resume zero or more workflows
- argo retry - retry zero or more workflows
- argo server - start the Argo Server
- argo stop - stop zero or more workflows allowing all exit handlers to run
- argo submit - submit a workflow
- argo suspend - suspend zero or more workflow
- argo template - manipulate workflow templates
- argo terminate - terminate zero or more workflows immediately
- argo version - print version information
- argo wait - waits for workflows to complete
- argo watch - watch a workflow until it completes