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

     1  ---
     2  title: kbcli kubeblocks install
     3  ---
     4  
     5  Install KubeBlocks.
     6  
     7  ```
     8  kbcli kubeblocks install [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # Install KubeBlocks, the default version is same with the kbcli version, the default namespace is kb-system
    15    kbcli kubeblocks install
    16    
    17    # Install KubeBlocks with specified version
    18    kbcli kubeblocks install --version=0.4.0
    19    
    20    # Install KubeBlocks with ignoring preflight checks
    21    kbcli kubeblocks install --force
    22    
    23    # Install KubeBlocks with specified namespace, if the namespace is not present, it will be created
    24    kbcli kubeblocks install --namespace=my-namespace --create-namespace
    25    
    26    # Install KubeBlocks with other settings, for example, set replicaCount to 3
    27    kbcli kubeblocks install --set replicaCount=3
    28  ```
    29  
    30  ### Options
    31  
    32  ```
    33        --check                        Check kubernetes environment before installation (default true)
    34        --create-namespace             Create the namespace if not present
    35        --force                        If present, just print fail item and continue with the following steps
    36    -h, --help                         help for install
    37        --node-labels stringToString   Node label selector (default [])
    38        --pod-anti-affinity string     Pod anti-affinity type, one of: (Preferred, Required)
    39        --set stringArray              Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
    40        --set-file stringArray         Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
    41        --set-json stringArray         Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)
    42        --set-string stringArray       Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
    43        --timeout duration             Time to wait for installing KubeBlocks, such as --timeout=10m (default 5m0s)
    44        --tolerations strings          Tolerations for Kubeblocks, such as '"dev=true:NoSchedule,large=true:NoSchedule"'
    45        --topology-keys stringArray    Topology keys for affinity
    46    -f, --values strings               Specify values in a YAML file or a URL (can specify multiple)
    47        --version string               KubeBlocks version
    48        --wait                         Wait for KubeBlocks to be ready, including all the auto installed add-ons. It will wait for a --timeout period (default true)
    49  ```
    50  
    51  ### Options inherited from parent commands
    52  
    53  ```
    54        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    55        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    56        --as-uid string                  UID to impersonate for the operation.
    57        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    58        --certificate-authority string   Path to a cert file for the certificate authority
    59        --client-certificate string      Path to a client certificate file for TLS
    60        --client-key string              Path to a client key file for TLS
    61        --cluster string                 The name of the kubeconfig cluster to use
    62        --context string                 The name of the kubeconfig context to use
    63        --disable-compression            If true, opt-out of response compression for all requests to the server
    64        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    65        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    66        --match-server-version           Require server version to match client version
    67    -n, --namespace string               If present, the namespace scope for this CLI request
    68        --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")
    69    -s, --server string                  The address and port of the Kubernetes API server
    70        --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
    71        --token string                   Bearer token for authentication to the API server
    72        --user string                    The name of the kubeconfig user to use
    73  ```
    74  
    75  ### SEE ALSO
    76  
    77  * [kbcli kubeblocks](kbcli_kubeblocks.md)	 - KubeBlocks operation commands.
    78  
    79  #### Go Back to [CLI Overview](cli.md) Homepage.
    80