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 website is maintained by Kubernetes SIG Docs. The Kubernetes project welcomes help from all contributors, new or experienced! Kubernetes documentation contributors: Improve existing content Create new content Translate the documentation Manage and publish the documentation parts of the Kubernetes release cycle The blog team, part of SIG Docs, helps manage the official blogs. Read contributing to Kubernetes blogs to learn more. Note:To learn more about contributing to Kubernetes in general, see the general contributor documentation site.

kube-state-metrics, an add-on agent to generate and expose cluster-level metrics.

Kubernetes supports nodes that run Microsoft Windows.

This page explains how to enable a package repository for the desired Kubernetes minor release upon upgrading a cluster. This is only needed for users of the community-owned package repositories hosted at pkgs.k8s.io. Unlike the legacy package repositories, the community-owned package repositories are structured in a way that there's a dedicated package repository for each Kubernetes minor version. Note:This guide only covers a part of the Kubernetes upgrade process. Please see the upgrade guide for more information about upgrading Kubernetes clusters.

This page explains how to add Linux worker nodes to a kubeadm cluster. Before you begin Each joining worker node has installed the required components from Installing kubeadm, such as, kubeadm, the kubelet and a container runtime. A running kubeadm cluster created by kubeadm init and following the steps in the document Creating a cluster with kubeadm. You need superuser access to the node. Adding Linux worker nodes To add new Linux worker nodes to your cluster do the following for each machine:

The dockershim component of Kubernetes allows the use of Docker as a Kubernetes's container runtime. Kubernetes' built-in dockershim component was removed in release v1.24. This page explains how your cluster could be using Docker as a container runtime, provides details on the role that dockershim plays when in use, and shows steps you can take to check whether any workloads could be affected by dockershim removal. Finding if your app has a dependencies on Docker If you are using Docker for building your application containers, you can still run these containers on any container runtime.

Application logs can help you understand what is happening inside your application. The logs are particularly useful for debugging problems and monitoring cluster activity. Most modern applications have some kind of logging mechanism. Likewise, container engines are designed to support logging. The easiest and most adopted logging method for containerized applications is writing to standard output and standard error streams. However, the native functionality provided by a container engine or runtime is usually not enough for a complete logging solution.

Before you begin You must use a kubectl version that is within one minor version difference of your cluster. For example, a v1.35 client can communicate with v1.34, v1.35, and v1.36 control planes. Using the latest compatible version of kubectl helps avoid unforeseen issues. Install kubectl on Windows The following methods exist for installing kubectl on Windows: Install kubectl binary on Windows (via direct download or curl) Install on Windows using Chocolatey, Scoop, or winget Install kubectl binary on Windows (via direct download or curl) You have two options for installing kubectl on your Windows device

Before you begin Some steps in this page use the jq tool. If you don't have jq, you can install it via your operating system's software sources, or fetch it from https://jqlang.github.io/jq/. Some steps also involve installing curl, which can be installed via your operating system's software sources. A subset of the kubelet's configuration parameters may be set via an on-disk config file, as a substitute for command-line flags. Providing parameters via a config file is the recommended approach because it simplifies node deployment and configuration management.