doctl-kubernetes-options
Show options for Kubernetes versions with doctl
TLDR
List regions that support Kubernetes clusters
List machine sizes that can be used in a Kubernetes cluster
List Kubernetes versions that can be used with DigitalOcean clusters
SYNOPSIS
This man page describes options used with doctl kubernetes subcommands.
Usage pattern:
doctl kubernetes <subcommand> [options]
To view this document:
man doctl-kubernetes-options
PARAMETERS
--cluster-id
Specifies the unique ID of the Kubernetes cluster.
--cluster-name
References the Kubernetes cluster by its human-readable name.
--format
Sets the output format (e.g., json, yaml, text, csv).
--output
Alias for --format.
--no-header
Suppresses column headers in table output.
--kubeconfig
Specifies an alternative path to the Kubernetes configuration file.
--context
Defines the Kubernetes context to use for the operation.
--region
Specifies the DigitalOcean datacenter region for the cluster (often used with creation/listing).
DESCRIPTION
The doctl-kubernetes-options document is a man page (manual page) within the DigitalOcean CLI (doctl) that serves as a comprehensive reference for common command-line options available when interacting with DigitalOcean Kubernetes Service (DOKS). It is not an executable command itself, but rather a guide detailing flags and arguments that can be appended to various doctl kubernetes subcommands, such as create, get, list, delete, and kubeconfig operations.
These options allow users to specify crucial parameters like cluster identifiers, names, output formats, and authentication contexts, streamlining the management of Kubernetes clusters directly from the command line. By providing a centralized overview of these options, doctl-kubernetes-options helps users understand and effectively utilize the full capabilities of doctl for DOKS.
CAVEATS
The doctl-kubernetes-options is a reference document, not an executable command itself.
The options described within are primarily applicable to commands under the doctl kubernetes family.
Not all options are relevant or available for every single doctl kubernetes subcommand; users should refer to the specific subcommand's help output (e.g., doctl kubernetes create --help) for exact applicability.
ACCESSING THE DOCUMENT
To view the full doctl-kubernetes-options manual page on a Linux system, use the man command:
man doctl-kubernetes-options
HISTORY
The doctl CLI, including its Kubernetes-related capabilities and associated man pages like doctl-kubernetes-options, has evolved significantly since DigitalOcean introduced its managed Kubernetes service (DOKS). Its development parallels the growth of DOKS, providing comprehensive command-line tooling for managing cluster lifecycle, node pools, and integrations. This specific man page was created to centralize and document the consistent set of options available across various doctl kubernetes operations, improving user experience and documentation.