kbcli cluster connect

Connect to a cluster or instance.

kbcli cluster connect (NAME | -i INSTANCE-NAME) [flags]

Examples

  # connect to a specified cluster, default connect to the leader/primary instance
  kbcli cluster connect mycluster
  
  # connect to cluster as user
  kbcli cluster connect mycluster --as-user myuser
  
  # connect to a specified instance
  kbcli cluster connect -i mycluster-instance-0
  
  # connect to a specified component
  kbcli cluster connect mycluster --component mycomponent
  
  # show cli connection example with password mask
  kbcli cluster connect mycluster --show-example --client=cli
  
  # show java connection example with password mask
  kbcli cluster connect mycluster --show-example --client=java
  
  # show all connection examples with password mask
  kbcli cluster connect mycluster --show-example
  
  # show cli connection examples with real password
  kbcli cluster connect mycluster --show-example --client=cli --show-password

Options

      --as-user string     Connect to cluster as user
      --client string      Which client connection example should be output, only valid if --show-example is true.
      --component string   The component to connect. If not specified, pick up the first one.
  -h, --help               help for connect
  -i, --instance string    The instance name to connect.
      --show-example       Show how to connect to cluster/instance from different clients.
      --show-password      Show password in example.

Options inherited from parent commands

      --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
      --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.
      --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
      --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
      --disable-compression            If true, opt-out of response compression for all requests to the server
      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
      --match-server-version           Require server version to match client version
  -n, --namespace string               If present, the namespace scope for this CLI request
      --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")
  -s, --server string                  The address and port of the Kubernetes API server
      --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the 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

SEE ALSO

• kbcli cluster - Cluster command.

Go Back to CLI Overview Homepage.