Updated on 2025-04-18 GMT+08:00

ccictl describe

Scenario

Show details of a specific resource or group of resources.

Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. The following is an example:

ccictl describe TYPE NAME_PREFIX

This command first checks for an exact match with TYPE and NAME_PREFIX. If no such resource exists, it outputs the details of all resources whose names are prefixed with NAME_PREFIX.

Use ccictl api-resources to obtain a complete list of supported resources.

ccictl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

Examples

# Describe a node.
ccictl describe deploy example-deploy

# Describe a pod.
ccictl describe pods/nginx

# Describe the pods identified by type and name in pod.json.
ccictl describe -f pod.json

# Describe all pods.
ccictl describe pods

# Describe the pod with the name=myLabel label.
ccictl describe pods -l name=myLabel

# Describe all pods for the frontend Deployment.
ccictl describe pods frontend

Options

-A, --all-namespaces

If this flag exists, the requested object is listed across all namespaces. Even if a namespace is specified using --namespace, the namespace in the current context is ignored.

--chunk-size int     Default: 500

Return large lists in chunks rather than all at once. The value 0 indicates that the function is disabled.

-f, --filename strings

List of file names, directories, or file URLs that contain the resources to be described.

-h, --help

Help information for describe

-R, --recursive

Process the directory used in -f or --filename recursively. This option is useful when you want to manage related manifests organized within the same directory.

-l, --selector string

Selector used for filtering (label query). The value can be =, ==, or !=, for example, -l key1=value1,key2=value2. Matched objects must meet all specified label constraints.

The following ccictl options can also be used in subcommands:

Parent command options