This page shows how to create a new topic for the Kubernetes docs. Before you begin Create a fork of the Kubernetes documentation repository as described in Open a PR. Choosing a page type As you prepare to write a new topic, think about the page type that would fit your content the best: Guidelines for choosing a page type Type Description Concept A concept page explains some aspect of Kubernetes.

This site uses Hugo. In Hugo, content organization is a core concept. Note:Hugo Tip: Start Hugo with hugo server --navigateToChanged for content edit-sessions. Page Lists Page Order The documentation side menu, the documentation page browser etc. are listed using Hugo's default sort order, which sorts by weight (from 1), date (newest first), and finally by the link title. Given that, if you want to move a page or a section up, set a weight in the page's front matter:

Resource Types Preference Preference Preference stores elements of KubeRC configuration file FieldDescription apiVersionstringkubectl.config.k8s.io/v1alpha1 kindstringPreference overrides [Required] []CommandDefaults overrides allows changing default flag values of commands. This is especially useful, when user doesn't want to explicitly set flags each time. aliases [Required] []AliasOverride aliases allow defining command aliases for existing kubectl commands, with optional default flag values. If the alias name collides with a built-in command, built-in command always takes precedence. Flag overrides defined in the overrides section do NOT apply to aliases for the same command.

Package v1 is the v1 version of the API. Resource Types WebhookAdmission WebhookAdmission WebhookAdmission provides configuration for the webhook admission controller. FieldDescription apiVersionstringapiserver.config.k8s.io/v1 kindstringWebhookAdmission kubeConfigFile [Required] string KubeConfigFile is the path to the kubeconfig file.

Production-Grade Container Orchestration

This page shows how to contribute to the upstream kubernetes/kubernetes project. You can fix bugs found in the Kubernetes API documentation or the content of the Kubernetes components such as kubeadm, kube-apiserver, and kube-controller-manager. If you instead want to regenerate the reference documentation for the Kubernetes API or the kube-* components from the upstream code, see the following instructions: Generating Reference Documentation for the Kubernetes API Generating Reference Documentation for the Kubernetes Components and Tools Before you begin You need to have these tools installed:

FEATURE STATE: Kubernetes v1.26 [stable] Windows HostProcess containers enable you to run containerized workloads on a Windows host. These containers operate as normal processes but have access to the host network namespace, storage, and devices when given the appropriate user privileges. HostProcess containers can be used to deploy network plugins, storage configurations, device plugins, kube-proxy, and other components to Windows nodes without the need for dedicated proxies or the direct installation of host services.

FEATURE STATE: Kubernetes v1.34 [beta](enabled by default) This page shows how to specify CPU and memory resources for a Pod at pod-level in addition to container-level resource specifications. A Kubernetes node allocates resources to a pod based on the pod's resource requests. These requests can be defined at the pod level or individually for containers within the pod. When both are present, the pod-level requests take precedence. Similarly, a pod's resource usage is restricted by limits, which can also be set at the pod-level or individually for containers within the pod.

This page shows how a Pod can use environment variables to expose information about itself to containers running in the Pod, using the downward API. You can use environment variables to expose Pod fields, container fields, or both. In Kubernetes, there are two ways to expose Pod and container fields to a running container: Environment variables, as explained in this task Volume files Together, these two ways of exposing Pod and container fields are called the downward API.

In this example, you will run a Job in Indexed completion mode configured such that the pods created by the Job can communicate with each other using pod hostnames rather than pod IP addresses. Pods within a Job might need to communicate among themselves. The user workload running in each pod could query the Kubernetes API server to learn the IPs of the other Pods, but it's much simpler to rely on Kubernetes' built-in DNS resolution.