Home / ubuntu / Questions / 1130547
Accepted
smrt28
Asked: 2019-04-02 23:45:17 +0800 CST

Where to get kubectl man pages?

  • 772

Any suggestion where I can get and install kubectl man pages? Asking Google all the time is getting annoying.

I want to be able to see the man page from the command line like:

$ man kubectl pods

I obviously know about the documentation online on the internet.

Thanks

manpage doc kubernetes

2 Answers

  1. Best Answer

    The kubectl CLI is written in Golang, and use Cobra features to automatic generate documentation based on subcommands, flags, etc.

    So, you can use kubectl --help to see all the available options. Furthermore, you can dig into specific subcommands options (e.g., kubectl describe --help, kubectl get --help and so on).

    More than that, you can use kubectl explain to describe the fields associated with each supported API resources, which is very useful when writing templates. Examples:

      # Get the documentation of the resource and its fields
  kubectl explain pods

  # Get the documentation of a specific field of a resource
  kubectl explain pods.spec.containers
    • 3

  2. I don't think there is a man page for this. But the CLI reference is here and can be bookmarked:

    https://kubernetes.io/docs/reference/kubectl/kubectl/

    • 1