ccictl explain

Scenario

Describe the fields and structures of various resources.

This command describes the fields associated with each supported API resource. These fields are identified by a simple JSONPath identifier:

<type>.<field name>[.<field name>]

The information about each field is retrieved from the server in OpenAPI format.

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

ccictl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [-o|--output=plaintext|plaintext-openapiv2]

Examples

# Obtain the document of the resource and its fields.
ccictl explain pods

# Obtain all fields in the resource.
ccictl explain pods --recursive

# Obtain the description of Deployment in the supported API version.
ccictl explain deployments --api-version=apps/v1

# Obtain the documentation of a specific field of a resource.
ccictl explain pods.spec.containers

Options

--api-version string

API version (group/version) of the resource

-h, --help

Help information for explain

--recursive

If the value is true, the names of all fields are printed recursively. Otherwise, the available fields and their descriptions are printed.

The following ccictl options can also be used in subcommands:

Parent command options