Skip to content

kbcli_cluster_explain-config.md

Latest commit

 

History

History
67 lines (52 loc) · 3.69 KB

kbcli_cluster_explain-config.md

File metadata and controls

67 lines (52 loc) · 3.69 KB
title kbcli cluster explain-config

List the constraint for supported configuration params.

kbcli cluster explain-config [flags]

Examples

  # explain a cluster, e.g. cluster name is mycluster
  kbcli cluster explain-config mycluster
  
  # explain a specified configure template, e.g. cluster name is mycluster
  kbcli cluster explain-config mycluster --component=mysql --config-specs=mysql-3node-tpl
  
  # explain a specified configure template, e.g. cluster name is mycluster
  kbcli cluster explain-config mycluster --component=mysql --config-specs=mysql-3node-tpl --trunc-document=false --trunc-enum=false
  
  # explain a specified parameters, e.g. cluster name is mycluster
  kbcli cluster explain-config mycluster --param=sql_mode

Options

      --components strings     Specify the name of Component to describe (e.g. for apecloud-mysql: --component=mysql). If the cluster has only one component, unset the parameter."
      --config-specs strings   Specify the name of the configuration template to describe. (e.g. for apecloud-mysql: --config-specs=mysql-3node-tpl)
  -h, --help                   help for explain-config
      --param string           Specify the name of parameter to be query. It clearly display the details of the parameter.
      --trunc-document         If the document length of the parameter is greater than 100, it will be truncated.
      --trunc-enum             If the value list length of the parameter is greater than 20, it will be truncated. (default true)

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

Go Back to CLI Overview Homepage.