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.

This page shows how to use the update-imported-docs.py script to generate the Kubernetes reference documentation. The script automates the build setup and generates the reference documentation for a release. Before you begin Requirements: You need a machine that is running Linux or macOS. You need to have these tools installed: Python v3.7.x+ Git Golang version 1.13+ Pip used to install PyYAML PyYAML v5.1.2 make gcc compiler/linker Docker (Required only for kubectl command reference) Your PATH environment variable must include the required build tools, such as the Go binary and python.

Production-Grade Container Orchestration

This page demonstrates the generation of metrics reference documentation. Before you begin Requirements: You need a machine that is running Linux or macOS. You need to have these tools installed: Python v3.7.x+ Git Golang version 1.13+ Pip used to install PyYAML PyYAML v5.1.2 make gcc compiler/linker Docker (Required only for kubectl command reference) Your PATH environment variable must include the required build tools, such as the Go binary and python.

Resource Types CredentialProviderConfig KubeletConfiguration SerializedNodeConfigSource FormatOptions Appears in: LoggingConfiguration FormatOptions contains options for the different logging formats. FieldDescription text [Required] TextOptions [Alpha] Text contains options for logging format "text". Only available when the LoggingAlphaOptions feature gate is enabled. json [Required] JSONOptions [Alpha] JSON contains options for logging format "json". Only available when the LoggingAlphaOptions feature gate is enabled. JSONOptions Appears in: FormatOptions JSONOptions contains options for logging format "json". FieldDescription OutputRoutingOptions [Required] OutputRoutingOptions (Members of OutputRoutingOptions are embedded into this type.

Package v1beta1 is the v1beta1 version of the metrics API. Resource Types NodeMetrics NodeMetricsList PodMetrics PodMetricsList NodeMetrics Appears in: NodeMetricsList NodeMetrics sets resource usage metrics of a node. FieldDescription apiVersionstringmetrics.k8s.io/v1beta1 kindstringNodeMetrics metadata meta/v1.ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of the metadata field. timestamp [Required] meta/v1.Time The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].

When using client certificate authentication, you can generate certificates manually through easyrsa, openssl or cfssl. easyrsa easyrsa can manually generate certificates for your cluster. Download, unpack, and initialize the patched version of easyrsa3. curl -LO https://dl.k8s.io/easy-rsa/easy-rsa.tar.gz tar xzf easy-rsa.tar.gz cd easy-rsa-master/easyrsa3 ./easyrsa init-pki Generate a new certificate authority (CA). --batch sets automatic mode; --req-cn specifies the Common Name (CN) for the CA's new root certificate. ./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca nopass Generate server certificate and key.

FEATURE STATE: Kubernetes v1.26 [alpha] (enabled by default: false) This page shows how to migrate nodes to use event based updates for container status. The event-based implementation reduces node resource consumption by the kubelet, compared to the legacy approach that relies on polling. You may know this feature as evented Pod lifecycle event generator (PLEG). That's the name used internally within the Kubernetes project for a key implementation detail.

This page explains how to configure the kubelet's cgroup driver to match the container runtime cgroup driver for kubeadm clusters. Before you begin You should be familiar with the Kubernetes container runtime requirements. Configuring the container runtime cgroup driver The Container runtimes page explains that the systemd driver is recommended for kubeadm based setups instead of the kubelet's default cgroupfs driver, because kubeadm manages the kubelet as a systemd service.

This page shows how to configure access to multiple clusters by using configuration files. After your clusters, users, and contexts are defined in one or more configuration files, you can quickly switch between clusters by using the kubectl config use-context command. Note:A file that is used to configure access to a cluster is sometimes called a kubeconfig file. This is a generic way of referring to configuration files. It does not mean that there is a file named kubeconfig.