This page shows how to generate the kubectl command reference. Note:This topic shows how to generate reference documentation for kubectl commands like kubectl apply and kubectl taint. This topic does not show how to generate the kubectl options reference page. For instructions on how to generate the kubectl options reference page, see Generating Reference Pages for Kubernetes Components and Tools. Before you begin Requirements: You need a machine that is running Linux or macOS.

Production-Grade Container Orchestration

Synopsis Create a cluster role. kubectl create clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run=server|client|none] Examples # Create a cluster role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods # Create a cluster role named "pod-reader" with ResourceName specified kubectl create clusterrole pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod # Create a cluster role named "foo" with API Group specified kubectl create clusterrole foo --verb=get,list,watch --resource=rs.

Synopsis Dump cluster information out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default, only dumps things in the current namespace and 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.

Synopsis Set a context entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields. kubectl config set-context [NAME | --current] [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace] Examples # Set the user field on the gce context entry without touching other values kubectl config set-context gce --user=cluster-admin Options --cluster string cluster for the context entry in kubeconfig --current Modify the current context

Synopsis Unset an individual value in a kubeconfig file. PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. kubectl config unset PROPERTY_NAME Examples # Unset the current-context kubectl config unset current-context # Unset namespace in foo context kubectl config unset contexts.foo.namespace Options -h, --help help for unset Parent Options Inherited --as string Username to impersonate for the operation.

Synopsis Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects. Missing objects are created, and the containing namespace is created for namespaced objects, if required. Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified. Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified.

Synopsis View the latest last-applied-configuration annotations by type/name or file. The default output will be printed to stdout in YAML format. You can use the -o option to change the output format. kubectl apply view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME) Examples # View the last-applied-configuration annotations by type/name in YAML kubectl apply view-last-applied deployment/nginx # View the last-applied-configuration annotations by file in JSON kubectl apply view-last-applied -f deploy.

kubeadm upgrade apply phase Using the phases of kubeadm upgrade apply, you can choose to execute the separate steps of the initial upgrade of a control plane node. phase preflight control-plane upload-config kubelet-config bootstrap-token addon post-upgrade Use this command to invoke single phase of the "apply" workflow Synopsis Use this command to invoke single phase of the "apply" workflow kubeadm upgrade apply phase [flags] Options -h, --help help for phase

Performs a best effort revert of changes made by kubeadm init or kubeadm join. Performs a best effort revert of changes made to this host by 'kubeadm init' or 'kubeadm join' Synopsis Performs a best effort revert of changes made to this host by 'kubeadm init' or 'kubeadm join' The "reset" command executes the following phases: preflight Run reset pre-flight checks remove-etcd-member Remove a local etcd member. cleanup-node Run cleanup node.