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

     1  ---
     2  title: kbcli plugin describe
     3  ---
     4  
     5  Describe a plugin
     6  
     7  ```
     8  kbcli plugin describe [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # Describe a plugin
    15    kbcli plugin describe [PLUGIN]
    16    
    17    # Describe a plugin with index
    18    kbcli plugin describe [INDEX/PLUGIN]
    19  ```
    20  
    21  ### Options
    22  
    23  ```
    24    -h, --help   help for describe
    25  ```
    26  
    27  ### Options inherited from parent commands
    28  
    29  ```
    30        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    31        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    32        --as-uid string                  UID to impersonate for the operation.
    33        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    34        --certificate-authority string   Path to a cert file for the certificate authority
    35        --client-certificate string      Path to a client certificate file for TLS
    36        --client-key string              Path to a client key file for TLS
    37        --cluster string                 The name of the kubeconfig cluster to use
    38        --context string                 The name of the kubeconfig context to use
    39        --disable-compression            If true, opt-out of response compression for all requests to the server
    40        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    41        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    42        --match-server-version           Require server version to match client version
    43    -n, --namespace string               If present, the namespace scope for this CLI request
    44        --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")
    45    -s, --server string                  The address and port of the Kubernetes API server
    46        --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
    47        --token string                   Bearer token for authentication to the API server
    48        --user string                    The name of the kubeconfig user to use
    49  ```
    50  
    51  ### SEE ALSO
    52  
    53  * [kbcli plugin](kbcli_plugin.md)	 - Provides utilities for interacting with plugins.
    54  
    55  #### Go Back to [CLI Overview](cli.md) Homepage.
    56