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

     1  ---
     2  title: kbcli cluster promote
     3  ---
     4  
     5  Promote a non-primary or non-leader instance as the new primary or leader of the cluster
     6  
     7  ```
     8  kbcli cluster promote NAME [--component=<comp-name>] [--instance <instance-name>] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # Promote the instance mycluster-mysql-1 as the new primary or leader.
    15    kbcli cluster promote mycluster --instance mycluster-mysql-1
    16    
    17    # Promote a non-primary or non-leader instance as the new primary or leader, the new primary or leader is determined by the system.
    18    kbcli cluster promote mycluster
    19    
    20    # If the cluster has multiple components, you need to specify a component, otherwise an error will be reported.
    21    kbcli cluster promote mycluster --component=mysql --instance mycluster-mysql-1
    22  ```
    23  
    24  ### Options
    25  
    26  ```
    27        --auto-approve                   Skip interactive approval before promote the instance
    28        --component string               Specify the component name of the cluster, if the cluster has multiple components, you need to specify a component
    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    -h, --help                           help for promote
    31        --instance string                Specify the instance name as the new primary or leader of the cluster, you can get the instance name by running "kbcli cluster list-instances"
    32        --name string                    OpsRequest name. if not specified, it will be randomly generated 
    33    -o, --output format                  Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
    34        --ttlSecondsAfterSucceed int     Time to live after the OpsRequest succeed
    35  ```
    36  
    37  ### Options inherited from parent commands
    38  
    39  ```
    40        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    41        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    42        --as-uid string                  UID to impersonate for the operation.
    43        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    44        --certificate-authority string   Path to a cert file for the certificate authority
    45        --client-certificate string      Path to a client certificate file for TLS
    46        --client-key string              Path to a client key file for TLS
    47        --cluster string                 The name of the kubeconfig cluster to use
    48        --context string                 The name of the kubeconfig context to use
    49        --disable-compression            If true, opt-out of response compression for all requests to the server
    50        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    51        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    52        --match-server-version           Require server version to match client version
    53    -n, --namespace string               If present, the namespace scope for this CLI request
    54        --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")
    55    -s, --server string                  The address and port of the Kubernetes API server
    56        --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
    57        --token string                   Bearer token for authentication to the API server
    58        --user string                    The name of the kubeconfig user to use
    59  ```
    60  
    61  ### SEE ALSO
    62  
    63  * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
    64  
    65  #### Go Back to [CLI Overview](cli.md) Homepage.
    66