使用示例
[root@k8s-master01 ~]# kubectl explain deployment.spec
GROUP: apps
KIND: Deployment
VERSION: v1
FIELD: spec <DeploymentSpec>
DESCRIPTION:
Specification of the desired behavior of the Deployment.
DeploymentSpec is the specification of the desired behavior of the
Deployment.
FIELDS:
minReadySeconds <integer>
Minimum number of seconds for which a newly created pod should be ready
without any of its container crashing, for it to be considered available.
Defaults to 0 (pod will be considered available as soon as it is ready)
paused <boolean>
Indicates that the deployment is paused.
progressDeadlineSeconds <integer>
The maximum time in seconds for a deployment to make progress before it is
considered to be failed. The deployment controller will continue to process
failed deployments and a condition with a ProgressDeadlineExceeded reason
will be surfaced in the deployment status. Note that progress will not be
estimated during the time a deployment is paused. Defaults to 600s.
replicas <integer>
Number of desired pods. This is a pointer to distinguish between explicit
zero and not specified. Defaults to 1.
revisionHistoryLimit <integer>
The number of old ReplicaSets to retain to allow rollback. This is a pointer
to distinguish between explicit zero and not specified. Defaults to 10.
selector <LabelSelector> -required-
Label selector for pods. Existing ReplicaSets whose pods are selected by
this will be the ones affected by this deployment. It must match the pod
template's labels.
strategy <DeploymentStrategy>
The deployment strategy to use to replace existing pods with new ones.
template <PodTemplateSpec> -required-
Template describes the pods that will be created. The only allowed
template.spec.restartPolicy value is "Always".
使用说明
kubectl explain
命令用于获取 Kubernetes API 资源的详细说明。以下是一些示例 kubectl explain
命令的用法:
- 获取 Pod 的说明:
kubectl explain pod
这将显示有关 Pod 资源的详细说明,包括支持的字段、字段类型、默认值等。
- 获取 Deployment 的说明:
kubectl explain deployment
这将显示有关 Deployment 资源的详细说明,包括支持的字段、字段类型、默认值等。
- 获取 Service 的说明:
kubectl explain service
这将显示有关 Service 资源的详细说明,包括支持的字段、字段类型、默认值等。
- 获取特定字段的说明:
kubectl explain pod.spec.containers
这将显示有关 Pod 规范中 containers
字段的详细说明,包括该字段的类型、子字段、默认值等。
- 获取扩展资源(Custom Resource Definition)的说明:
kubectl explain crd
这将显示有关扩展资源(Custom Resource Definition)的详细说明,包括支持的字段、字段类型、默认值等。
通过使用 kubectl explain
命令,您可以获取各种 Kubernetes 资源(包括核心和自定义资源)的详细说明,以便更好地了解它们的属性和用法。