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

     1  ---
     2  title: kbcli kubeblocks preflight
     3  ---
     4  
     5  Run and retrieve preflight checks for KubeBlocks.
     6  
     7  ```
     8  kbcli kubeblocks preflight [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # Run preflight provider checks against the default rules automatically
    15    kbcli kubeblocks preflight
    16    
    17    # Run preflight provider checks and output more verbose info
    18    kbcli kubeblocks preflight --verbose
    19    
    20    # Run preflight checks against the customized rules of preflight-check.yaml
    21    kbcli kubeblocks preflight preflight-check.yaml
    22    
    23    # Run preflight checks and display AnalyzeResults with interactive mode
    24    kbcli kubeblocks preflight preflight-check.yaml --interactive=true
    25  ```
    26  
    27  ### Options
    28  
    29  ```
    30        --collect-without-permissions   always run preflight checks even if some required permissions that preflight does not have (default true)
    31        --collector-image string        the full name of the collector image to use
    32        --collector-pullpolicy string   the pull policy of the collector image
    33        --debug                         enable debug logging
    34        --format string                 output format, one of json, yaml. only used when interactive is set to false, default format is yaml (default "yaml")
    35    -h, --help                          help for preflight
    36    -n, --namespace string              If present, the namespace scope for this CLI request
    37    -o, --output string                 specify the output file path for the preflight checks
    38        --selector string               selector (label query) to filter remote collection nodes on.
    39        --since string                  force pod logs collectors to return logs newer than a relative duration like 5s, 2m, or 3h.
    40        --since-time string             force pod logs collectors to return logs after a specific date (RFC3339)
    41        --verbose                       print more verbose logs, default value is false
    42  ```
    43  
    44  ### Options inherited from parent commands
    45  
    46  ```
    47        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    48        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    49        --as-uid string                  UID to impersonate for the operation.
    50        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    51        --certificate-authority string   Path to a cert file for the certificate authority
    52        --client-certificate string      Path to a client certificate file for TLS
    53        --client-key string              Path to a client key file for TLS
    54        --cluster string                 The name of the kubeconfig cluster to use
    55        --context string                 The name of the kubeconfig context to use
    56        --disable-compression            If true, opt-out of response compression for all requests to the server
    57        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    58        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    59        --match-server-version           Require server version to match client version
    60        --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")
    61    -s, --server string                  The address and port of the Kubernetes API server
    62        --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
    63        --token string                   Bearer token for authentication to the API server
    64        --user string                    The name of the kubeconfig user to use
    65  ```
    66  
    67  ### SEE ALSO
    68  
    69  * [kbcli kubeblocks](kbcli_kubeblocks.md)	 - KubeBlocks operation commands.
    70  
    71  #### Go Back to [CLI Overview](cli.md) Homepage.
    72