github.com/argoproj/argo-cd/v3@v3.2.1/docs/user-guide/commands/argocd_cluster.md (about)

     1  # `argocd cluster` Command Reference
     2  
     3  ## argocd cluster
     4  
     5  Manage cluster credentials
     6  
     7  ```
     8  argocd cluster [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # List all known clusters in JSON format:
    15    argocd cluster list -o json
    16  
    17    # Add a target cluster configuration to ArgoCD. The context must exist in your kubectl config:
    18    argocd cluster add example-cluster
    19  
    20    # Get specific details about a cluster in plain text (wide) format:
    21    argocd cluster get example-cluster -o wide
    22  
    23    # Remove a target cluster context from ArgoCD
    24    argocd cluster rm example-cluster
    25  
    26    # Set a target cluster context from ArgoCD
    27    argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace '*'
    28    argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace namespace-one --namespace namespace-two
    29  ```
    30  
    31  ### Options
    32  
    33  ```
    34        --as string                      Username to impersonate for the operation
    35        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    36        --as-uid string                  UID to impersonate for the operation
    37        --certificate-authority string   Path to a cert file for the certificate authority
    38        --client-certificate string      Path to a client certificate file for TLS
    39        --client-key string              Path to a client key file for TLS
    40        --cluster string                 The name of the kubeconfig cluster to use
    41        --context string                 The name of the kubeconfig context to use
    42        --disable-compression            If true, opt-out of response compression for all requests to the server
    43    -h, --help                           help for cluster
    44        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    45        --kubeconfig string              Path to a kube config. Only required if out-of-cluster
    46    -n, --namespace string               If present, the namespace scope for this CLI request
    47        --password string                Password for basic authentication to the API server
    48        --proxy-url string               If provided, this URL will be used to connect via proxy
    49        --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")
    50        --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.
    51        --token string                   Bearer token for authentication to the API server
    52        --user string                    The name of the kubeconfig user to use
    53        --username string                Username for basic authentication to the API server
    54  ```
    55  
    56  ### Options inherited from parent commands
    57  
    58  ```
    59        --argocd-context string           The name of the Argo-CD server context to use
    60        --auth-token string               Authentication token; set this or the ARGOCD_AUTH_TOKEN environment variable
    61        --client-crt string               Client certificate file
    62        --client-crt-key string           Client certificate key file
    63        --config string                   Path to Argo CD config (default "/home/user/.config/argocd/config")
    64        --controller-name string          Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller")
    65        --core                            If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server
    66        --grpc-web                        Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2.
    67        --grpc-web-root-path string       Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root.
    68    -H, --header strings                  Sets additional header to all requests made by Argo CD CLI. (Can be repeated multiple times to add multiple headers, also supports comma separated headers)
    69        --http-retry-max int              Maximum number of retries to establish http connection to Argo CD server
    70        --insecure                        Skip server certificate and domain verification
    71        --kube-context string             Directs the command to the given kube-context
    72        --logformat string                Set the logging format. One of: json|text (default "json")
    73        --loglevel string                 Set the logging level. One of: debug|info|warn|error (default "info")
    74        --plaintext                       Disable TLS
    75        --port-forward                    Connect to a random argocd-server port using port forwarding
    76        --port-forward-namespace string   Namespace name which should be used for port forwarding
    77        --prompts-enabled                 Force optional interactive prompts to be enabled or disabled, overriding local configuration. If not specified, the local configuration value will be used, which is false by default.
    78        --redis-compress string           Enable this if the application controller is configured with redis compression enabled. (possible values: gzip, none) (default "gzip")
    79        --redis-haproxy-name string       Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy")
    80        --redis-name string               Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis")
    81        --repo-server-name string         Name of the Argo CD Repo server; set this or the ARGOCD_REPO_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-repo-server")
    82        --server string                   Argo CD server address
    83        --server-crt string               Server certificate file
    84        --server-name string              Name of the Argo CD API server; set this or the ARGOCD_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-server")
    85  ```
    86  
    87  ### SEE ALSO
    88  
    89  * [argocd](argocd.md)	 - argocd controls a Argo CD server
    90  * [argocd cluster add](argocd_cluster_add.md)	 - argocd cluster add CONTEXT
    91  * [argocd cluster get](argocd_cluster_get.md)	 - Get cluster information
    92  * [argocd cluster list](argocd_cluster_list.md)	 - List configured clusters
    93  * [argocd cluster rm](argocd_cluster_rm.md)	 - Remove cluster credentials
    94  * [argocd cluster rotate-auth](argocd_cluster_rotate-auth.md)	 - argocd cluster rotate-auth SERVER/NAME
    95  * [argocd cluster set](argocd_cluster_set.md)	 - Set cluster information
    96