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

     1  ---
     2  title: kbcli report cluster
     3  ---
     4  
     5  Report Cluster information
     6  
     7  ```
     8  kbcli report cluster NAME [-f file] [-with-logs] [-mask] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # report KubeBlocks status
    15    kbcli report cluster mycluster
    16    
    17    # report KubeBlocks cluster information to file
    18    kbcli report cluster mycluster -f filename
    19    
    20    # report KubeBlocks cluster information with logs
    21    kbcli report cluster mycluster --with-logs
    22    
    23    # report KubeBlocks cluster information with logs and mask sensitive info
    24    kbcli report cluster mycluster --with-logs --mask
    25    
    26    # report KubeBlocks cluster information with logs since 1 hour ago
    27    kbcli report cluster mycluster --with-logs --since 1h
    28    
    29    # report KubeBlocks cluster information with logs since given time
    30    kbcli report cluster mycluster --with-logs --since-time 2023-05-23T00:00:00Z
    31    
    32    # report KubeBlocks cluster information with logs for all containers
    33    kbcli report cluster mycluster --with-logs --all-containers
    34  ```
    35  
    36  ### Options
    37  
    38  ```
    39        --all-containers      Get all containers' logs in the pod(s). Byt default, only the main container (the first container) will have logs recorded.
    40    -f, --file string         zip file for output
    41    -h, --help                help for cluster
    42        --mask                mask sensitive info for secrets and configmaps (default true)
    43    -o, --output string       Output format. One of: json|yaml. (default "json")
    44        --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.
    45        --since-time string   Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
    46        --with-logs           include pod logs
    47  ```
    48  
    49  ### Options inherited from parent commands
    50  
    51  ```
    52        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    53        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    54        --as-uid string                  UID to impersonate for the operation.
    55        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    56        --certificate-authority string   Path to a cert file for the certificate authority
    57        --client-certificate string      Path to a client certificate file for TLS
    58        --client-key string              Path to a client key file for TLS
    59        --cluster string                 The name of the kubeconfig cluster to use
    60        --context string                 The name of the kubeconfig context to use
    61        --disable-compression            If true, opt-out of response compression for all requests to the server
    62        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    63        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    64        --match-server-version           Require server version to match client version
    65    -n, --namespace string               If present, the namespace scope for this CLI request
    66        --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")
    67    -s, --server string                  The address and port of the Kubernetes API server
    68        --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
    69        --token string                   Bearer token for authentication to the API server
    70        --user string                    The name of the kubeconfig user to use
    71  ```
    72  
    73  ### SEE ALSO
    74  
    75  * [kbcli report](kbcli_report.md)	 - report kubeblocks or cluster info.
    76  
    77  #### Go Back to [CLI Overview](cli.md) Homepage.
    78