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

     1  ---
     2  title: kbcli report kubeblocks
     3  ---
     4  
     5  Report KubeBlocks information, including deployments, events, logs, etc.
     6  
     7  ```
     8  kbcli report kubeblocks [-f file] [--with-logs] [--mask] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # report KubeBlocks status
    15    kbcli report kubeblocks
    16    
    17    # report KubeBlocks information to file
    18    kbcli report kubeblocks -f filename
    19    
    20    # report KubeBlocks information with logs
    21    kbcli report kubeblocks --with-logs
    22    
    23    # report KubeBlocks information with logs and mask sensitive info
    24    kbcli report kubeblocks --with-logs --mask
    25  ```
    26  
    27  ### Options
    28  
    29  ```
    30        --all-containers      Get all containers' logs in the pod(s). Byt default, only the main container (the first container) will have logs recorded.
    31    -f, --file string         zip file for output
    32    -h, --help                help for kubeblocks
    33        --mask                mask sensitive info for secrets and configmaps (default true)
    34    -o, --output string       Output format. One of: json|yaml. (default "json")
    35        --since duration      Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.
    36        --since-time string   Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
    37        --with-logs           include pod logs
    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 report](kbcli_report.md)	 - report kubeblocks or cluster info.
    67  
    68  #### Go Back to [CLI Overview](cli.md) Homepage.
    69