Recommended usage conventions for kubectl
.
kubectl
in Reusable ScriptsFor a stable output in a script:
-o name
, -o json
, -o yaml
, -o go-template
, or -o jsonpath
.jobs.v1.batch/myjob
. This will ensure that kubectl does not use its default version that can change over time.kubectl run
For kubectl run
to satisfy infrastructure as code:
:v1234
, v1.2.3
, r03062016-1-4
, rather than :latest
(For more information, see Best Practices for Configuration).--record
to annotate the created objects with the command line for an image that is lightly parameterized.kubectl run
flags.Resource | API group | kubectl command |
---|---|---|
Pod | v1 | |
ReplicationController (deprecated) | v1 | |
Deployment (deprecated) | extensions/v1beta1 | |
Deployment (deprecated) | apps/v1beta1 | |
Job (deprecated) | batch/v1 | |
CronJob (deprecated) | batch/v2alpha1 | |
CronJob (deprecated) | batch/v1beta1 |
Note: Generators other thanrun-pod/v1
are deprecated.
Flag | Generated Resource |
---|---|
--schedule=<schedule> |
CronJob |
--restart=Always |
Deployment |
--restart=OnFailure |
Job |
--restart=Never |
Pod |
--schedule
--restart
You can use the --dry-run
flag to preview the object that would be sent to your cluster, without really submitting it.
kubectl apply
kubectl apply
to create or update resources. For more information about using kubectl apply to update resources, see Kubectl Book.Was this page helpful?
Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.