github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_cluster_explain-config.md (about)

     1  ---
     2  title: kbcli cluster explain-config
     3  ---
     4  
     5  List the constraint for supported configuration params.
     6  
     7  ```
     8  kbcli cluster explain-config [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # explain a cluster, e.g. cluster name is mycluster
    15    kbcli cluster explain-config mycluster
    16    
    17    # explain a specified configure template, e.g. cluster name is mycluster
    18    kbcli cluster explain-config mycluster --component=mysql --config-specs=mysql-3node-tpl
    19    
    20    # explain a specified configure template, e.g. cluster name is mycluster
    21    kbcli cluster explain-config mycluster --component=mysql --config-specs=mysql-3node-tpl --trunc-document=false --trunc-enum=false
    22    
    23    # explain a specified parameters, e.g. cluster name is mycluster
    24    kbcli cluster explain-config mycluster --param=sql_mode
    25  ```
    26  
    27  ### Options
    28  
    29  ```
    30        --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."
    31        --config-specs strings   Specify the name of the configuration template to describe. (e.g. for apecloud-mysql: --config-specs=mysql-3node-tpl)
    32    -h, --help                   help for explain-config
    33        --param string           Specify the name of parameter to be query. It clearly display the details of the parameter.
    34        --trunc-document         If the document length of the parameter is greater than 100, it will be truncated.
    35        --trunc-enum             If the value list length of the parameter is greater than 20, it will be truncated. (default true)
    36  ```
    37  
    38  ### Options inherited from parent commands
    39  
    40  ```
    41        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    42        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    43        --as-uid string                  UID to impersonate for the operation.
    44        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    45        --certificate-authority string   Path to a cert file for the certificate authority
    46        --client-certificate string      Path to a client certificate file for TLS
    47        --client-key string              Path to a client key file for TLS
    48        --cluster string                 The name of the kubeconfig cluster to use
    49        --context string                 The name of the kubeconfig context to use
    50        --disable-compression            If true, opt-out of response compression for all requests to the server
    51        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    52        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    53        --match-server-version           Require server version to match client version
    54    -n, --namespace string               If present, the namespace scope for this CLI request
    55        --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")
    56    -s, --server string                  The address and port of the Kubernetes API server
    57        --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
    58        --token string                   Bearer token for authentication to the API server
    59        --user string                    The name of the kubeconfig user to use
    60  ```
    61  
    62  ### SEE ALSO
    63  
    64  * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
    65  
    66  #### Go Back to [CLI Overview](cli.md) Homepage.
    67