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.

Kubernetes contains several tools to help you work with the Kubernetes system. crictl crictl is a command-line interface for inspecting and debugging CRI-compatible container runtimes. Dashboard Dashboard, the web-based user interface of Kubernetes, allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. Helm 🛇 This item links to a third party project or product that is not part of Kubernetes itself.

Synopsis The kubelet is the primary "node agent" that runs on each node. It can register the node with the apiserver using one of: the hostname; a flag to override the hostname; or specific logic for a cloud provider. The kubelet works in terms of a PodSpec. A PodSpec is a YAML or JSON object that describes a pod. The kubelet takes a set of PodSpecs that are provided through various mechanisms (primarily through the apiserver) and ensures that the containers described in those PodSpecs are running and healthy.

Resource Types DefaultPreemptionArgs InterPodAffinityArgs KubeSchedulerConfiguration NodeAffinityArgs NodeResourcesBalancedAllocationArgs NodeResourcesFitArgs PodTopologySpreadArgs VolumeBindingArgs ClientConnectionConfiguration Appears in: KubeSchedulerConfiguration ClientConnectionConfiguration contains details for constructing a client. FieldDescription kubeconfig [Required] string kubeconfig is the path to a KubeConfig file. acceptContentTypes [Required] string acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client. contentType [Required] string contentType is the content type used when sending data to the server from this client.

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].

This page contains guidelines for Kubernetes documentation. If you have questions about what's allowed, join the #sig-docs channel in Kubernetes Slack and ask! You can register for Kubernetes Slack at https://slack.k8s.io/. For information on creating new content for the Kubernetes docs, follow the style guide. Overview Source for the Kubernetes website, including the docs, resides in the kubernetes/website repository. Located in the kubernetes/website/content/<language_code>/docs folder, the majority of Kubernetes documentation is specific to the Kubernetes project.

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.

In Kubernetes versions before v1.23, a scheduling policy can be used to specify the predicates and priorities process. For example, you can set a scheduling policy by running kube-scheduler --policy-config-file <filename> or kube-scheduler --policy-configmap <ConfigMap>. This scheduling policy is not supported since Kubernetes v1.23. Associated flags policy-config-file, policy-configmap, policy-configmap-namespace and use-legacy-policy-config are also not supported. Instead, use the Scheduler Configuration to achieve similar behavior. What's next Learn about scheduling Learn about kube-scheduler Configuration Read the kube-scheduler configuration reference (v1)

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.

Synopsis kubectl controls the Kubernetes cluster manager. Find more information in Command line tool (kubectl). kubectl [flags] Options --add-dir-header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files --as string Username to impersonate for the operation --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. --azure-container-registry-config string Path to the file containing Azure container registry configuration information.