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

     1  ---
     2  title: kbcli cluster configure
     3  ---
     4  
     5  Configure parameters with the specified components in the cluster.
     6  
     7  ```
     8  kbcli cluster configure NAME --set key=value[,key=value] [--component=component-name] [--config-spec=config-spec-name] [--config-file=config-file] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # update component params
    15    kbcli cluster configure mycluster --component=mysql --config-spec=mysql-3node-tpl --config-file=my.cnf --set max_connections=1000,general_log=OFF
    16    
    17    # if only one component, and one config spec, and one config file, simplify the searching process of configure. e.g:
    18    # update mysql max_connections, cluster name is mycluster
    19    kbcli cluster configure mycluster --set max_connections=2000
    20  ```
    21  
    22  ### Options
    23  
    24  ```
    25        --auto-approve                   Skip interactive approval before reconfiguring the cluster
    26        --component string               Specify the name of Component to be updated. If the cluster has only one component, unset the parameter.
    27        --config-file string             Specify the name of the configuration file to be updated (e.g. for mysql: --config-file=my.cnf). For available templates and configs, refer to: 'kbcli cluster describe-config'.
    28        --config-spec string             Specify the name of the configuration template to be updated (e.g. for apecloud-mysql: --config-spec=mysql-3node-tpl). For available templates and configs, refer to: 'kbcli cluster describe-config'.
    29        --dry-run string[="unchanged"]   Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
    30        --force-restart                  Boolean flag to restart component. Default with false.
    31    -h, --help                           help for configure
    32        --local-file string              Specify the local configuration file to be updated.
    33        --name string                    OpsRequest name. if not specified, it will be randomly generated 
    34    -o, --output format                  Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
    35        --replace                        Boolean flag to enable replacing config file. Default with false.
    36        --set strings                    Specify parameters list to be updated. For more details, refer to 'kbcli cluster describe-config'.
    37        --ttlSecondsAfterSucceed int     Time to live after the OpsRequest succeed
    38  ```
    39  
    40  ### Options inherited from parent commands
    41  
    42  ```
    43        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    44        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    45        --as-uid string                  UID to impersonate for the operation.
    46        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    47        --certificate-authority string   Path to a cert file for the certificate authority
    48        --client-certificate string      Path to a client certificate file for TLS
    49        --client-key string              Path to a client key file for TLS
    50        --cluster string                 The name of the kubeconfig cluster to use
    51        --context string                 The name of the kubeconfig context to use
    52        --disable-compression            If true, opt-out of response compression for all requests to the server
    53        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    54        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    55        --match-server-version           Require server version to match client version
    56    -n, --namespace string               If present, the namespace scope for this CLI request
    57        --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")
    58    -s, --server string                  The address and port of the Kubernetes API server
    59        --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
    60        --token string                   Bearer token for authentication to the API server
    61        --user string                    The name of the kubeconfig user to use
    62  ```
    63  
    64  ### SEE ALSO
    65  
    66  * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
    67  
    68  #### Go Back to [CLI Overview](cli.md) Homepage.
    69