Learn OpenShift
上QQ阅读APP看书,第一时间看更新

Getting help

kubectl has hundreds of different subcommands, options, and arguments. Luckily, kubectl has really good help options. The first one is man pages. If you are using macOS or Linux, you can run the man-f kubectl command to check kubectl-related man pages:

$ man -f kubectl
kubectl(1) - kubectl controls the Kubernetes cluster manager
kubectl-alpha(1), kubectl alpha(1) - Commands for features in alpha
kubectl-alpha-diff(1), kubectl alpha diff(1) - Diff different versions of configurations
...
<output omitted>
...

If for some reason you do not have man pages available on your system, you can just run the kubectl command without any options or arguments. It will show you a list of available subcommands:

$ kubectl
kubectl controls the Kubernetes cluster manager.
Find more information at https://github.com/kubernetes/kubernetes.
Basic Commands (Beginner):
create Create a resource from a file or from stdin.
expose Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
...
<output omitted>
...
Basic Commands (Intermediate):
get Display one or many resources
explain Documentation of resources
...
<output omitted>
...
Use "kubectl <command> --help" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands)

The next step is to check the list of available resources by running kubectl <command> or kubectl <command> --help commands, for example, kubectl get:

$ kubectl get
* all
* certificatesigningrequests (aka 'csr')
* clusterrolebindings
...
<output omitted>
...
Use "kubectl explain <resource>" for a detailed description of that resource (e.g. kubectl explain pods).
See 'kubectl get -h' for help and examples.

As you can see, you can also get kubectl get command examples by running kubectl get -h and a detailed resource explanation by running kubectl explain pods. The kubectl command is very easy to navigate and work with.