Get Started

Ready to get your hands dirty? Build a simple Kubernetes cluster that runs "Hello World" for Node.js.

Documentation

Learn how to use Kubernetes with conceptual, tutorial, and reference documentation. You can even help contribute to the docs!

Blog

Read the latest news for Kubernetes and the containers space in general, and get technical how-tos hot off the presses.

Interested in hacking on the core Kubernetes code base?

Explore the community

Home

Supported Versions of the Kubernetes Documentation

Getting started

Release notes and version skew

v1.17 Release Notes

Kubernetes version and version skew support policy

Learning environment

Installing Kubernetes with Minikube

Installing Kubernetes with Kind

Production environment

Container runtimes

Installing Kubernetes with deployment tools

Bootstrapping clusters with kubeadm

Installing kubeadm

Troubleshooting kubeadm

Creating a single control-plane cluster with kubeadm

Customizing control plane configuration with kubeadm

Options for Highly Available topology

Creating Highly Available clusters with kubeadm

Set up a High Availability etcd cluster with kubeadm

Configuring each kubelet in your cluster using kubeadm

Configuring your kubernetes cluster to self-host the control plane

Installing Kubernetes with kops

Installing Kubernetes with KRIB

Installing Kubernetes with Kubespray

Turnkey Cloud Solutions

Running Kubernetes on Alibaba Cloud

Running Kubernetes on AWS EC2

Running Kubernetes on Azure

Running Kubernetes on CenturyLink Cloud

Running Kubernetes on Google Compute Engine

Running Kubernetes on Multiple Clouds with IBM Cloud Private

Running Kubernetes on Tencent Kubernetes Engine

On-Premises VMs

Kubernetes on DC/OS

Windows in Kubernetes

Intro to Windows support in Kubernetes

Guide for adding Windows Nodes in Kubernetes

Guide for scheduling Windows containers in Kubernetes

Best practices

Running in multiple zones

Building large clusters

Validate node setup

PKI certificates and requirements

Concepts

Overview

What is Kubernetes

Kubernetes Components

The Kubernetes API

Working with Kubernetes Objects

Understanding Kubernetes Objects

Kubernetes Object Management

Object Names and IDs

Labels and Selectors

Field Selectors

Recommended Labels

Cluster Architecture

Master-Node Communication

Concepts Underlying the Cloud Controller Manager

Containers

Containers overview

Container Environment

Container Lifecycle Hooks

Workloads

Pods

Init Containers

Pod Topology Spread Constraints

Ephemeral Containers

Controllers

ReplicationController

Garbage Collection

TTL Controller for Finished Resources

Jobs - Run to Completion

Services, Load Balancing, and Networking

Service Topology

DNS for Services and Pods

Connecting Applications with Services

Ingress Controllers

Network Policies

Adding entries to Pod /etc/hosts with HostAliases

IPv4/IPv6 dual-stack

Storage

Persistent Volumes

Volume Snapshots

CSI Volume Cloning

Storage Classes

Volume Snapshot Classes

Dynamic Volume Provisioning

Node-specific Volume Limits

Configuration

Configuration Best Practices

Resource Bin Packing for Extended Resources

Managing Compute Resources for Containers

Assigning Pods to Nodes

Taints and Tolerations

Organizing Cluster Access Using kubeconfig Files

Pod Priority and Preemption

Scheduling Framework

Security

Overview of Cloud Native Security

Policies

Resource Quotas

Pod Security Policies

Scheduling

Kubernetes Scheduler

Scheduler Performance Tuning

Cluster Administration

Cluster Administration Overview

Cloud Providers

Managing Resources

Cluster Networking

Logging Architecture

Metrics For The Kubernetes Control Plane

Configuring kubelet Garbage Collection

Proxies in Kubernetes

Installing Addons

Extending Kubernetes

Extending your Kubernetes Cluster

Extending the Kubernetes API

Custom Resources

Extending the Kubernetes API with the aggregation layer

Compute, Storage, and Networking Extensions

Network Plugins

Operator pattern

Service Catalog

Poseidon-Firmament Scheduler

Tasks

Install Tools

Install and Set Up kubectl

Install Minikube

Administer a Cluster

Administration with kubeadm

Certificate Management with kubeadm

Upgrading kubeadm clusters

Manage Memory, CPU, and API Resources

Configure Default Memory Requests and Limits for a Namespace

Configure Default CPU Requests and Limits for a Namespace

Configure Minimum and Maximum Memory Constraints for a Namespace

Configure Minimum and Maximum CPU Constraints for a Namespace

Configure Memory and CPU Quotas for a Namespace

Configure a Pod Quota for a Namespace

Install a Network Policy Provider

Use Calico for NetworkPolicy

Use Cilium for NetworkPolicy

Use Kube-router for NetworkPolicy

Romana for NetworkPolicy

Weave Net for NetworkPolicy

Access Clusters Using the Kubernetes API

Access Services Running on Clusters

Advertise Extended Resources for a Node

Autoscale the DNS Service in a Cluster

Change the default StorageClass

Change the Reclaim Policy of a PersistentVolume

Cluster Management

Configure Multiple Schedulers

Configure Out of Resource Handling

Configure Quotas for API Objects

Control CPU Management Policies on the Node

Control Topology Management Policies on a node

Customizing DNS Service

Debugging DNS Resolution

Declare Network Policy

Developing Cloud Controller Manager

Enabling EndpointSlices

Enabling Service Topology

Encrypting Secret Data at Rest

Guaranteed Scheduling For Critical Add-On Pods

IP Masquerade Agent User Guide

Kubernetes Cloud Controller Manager

Limit Storage Consumption

Namespaces Walkthrough

Operating etcd clusters for Kubernetes

Reconfigure a Node's Kubelet in a Live Cluster

Reserve Compute Resources for System Daemons

Safely Drain a Node while Respecting the PodDisruptionBudget

Securing a Cluster

Set Kubelet parameters via a config file

Set up High-Availability Kubernetes Masters

Share a Cluster with Namespaces

Using a KMS provider for data encryption

Using CoreDNS for Service Discovery

Using NodeLocal DNSCache in Kubernetes clusters

Using sysctls in a Kubernetes Cluster

Configure Pods and Containers

Assign Memory Resources to Containers and Pods

Assign CPU Resources to Containers and Pods

Configure GMSA for Windows Pods and containers

Configure RunAsUserName for Windows pods and containers

Configure Quality of Service for Pods

Assign Extended Resources to a Container

Configure a Pod to Use a Volume for Storage

Configure a Pod to Use a PersistentVolume for Storage

Configure a Pod to Use a Projected Volume for Storage

Configure a Security Context for a Pod or Container

Configure Service Accounts for Pods

Pull an Image from a Private Registry

Configure Liveness, Readiness and Startup Probes

Assign Pods to Nodes

Configure Pod Initialization

Attach Handlers to Container Lifecycle Events

Configure a Pod to Use a ConfigMap

Share Process Namespace between Containers in a Pod

Create static Pods

Translate a Docker Compose File to Kubernetes Resources

Manage Kubernetes Objects

Declarative Management of Kubernetes Objects Using Configuration Files

Declarative Management of Kubernetes Objects Using Kustomize

Managing Kubernetes Objects Using Imperative Commands

Imperative Management of Kubernetes Objects Using Configuration Files

Inject Data Into Applications

Define a Command and Arguments for a Container

Define Environment Variables for a Container

Expose Pod Information to Containers Through Environment Variables

Expose Pod Information to Containers Through Files

Distribute Credentials Securely Using Secrets

Inject Information into Pods Using a PodPreset

Run Applications

Run a Stateless Application Using a Deployment

Run a Single-Instance Stateful Application

Run a Replicated Stateful Application

Update API Objects in Place Using kubectl patch

Scale a StatefulSet

Delete a StatefulSet

Force Delete StatefulSet Pods

Perform Rolling Update Using a Replication Controller

Horizontal Pod Autoscaler

Horizontal Pod Autoscaler Walkthrough

Specifying a Disruption Budget for your Application

Run Jobs

Running Automated Tasks with a CronJob

Parallel Processing using Expansions

Coarse Parallel Processing Using a Work Queue

Fine Parallel Processing Using a Work Queue

Access Applications in a Cluster

Web UI (Dashboard)

Accessing Clusters

Configure Access to Multiple Clusters

Use Port Forwarding to Access Applications in a Cluster

Use a Service to Access an Application in a Cluster

Connect a Front End to a Back End Using a Service

Create an External Load Balancer

Configure Your Cloud Provider's Firewalls

List All Container Images Running in a Cluster

Set up Ingress on Minikube with the NGINX Ingress Controller

Communicate Between Containers in the Same Pod Using a Shared Volume

Configure DNS for a Cluster

Extend Kubernetes

Configure the Aggregation Layer

Use Custom Resources

Extend the Kubernetes API with CustomResourceDefinitions

Versions in CustomResourceDefinitions

Setup an Extension API Server

Use an HTTP Proxy to Access the Kubernetes API

TLS

Certificate Rotation

Manage TLS Certificates in a Cluster

Manage Cluster Daemons

Perform a Rolling Update on a DaemonSet

Perform a Rollback on a DaemonSet

Install Service Catalog

Install Service Catalog using Helm

Install Service Catalog using SC

Network

Validate IPv4/IPv6 dual-stack

Extend kubectl with plugins

Manage HugePages

Tutorials

Learn Kubernetes Basics

Learn Kubernetes Basics

Create a Cluster

Using Minikube to Create a Cluster

Interactive Tutorial - Creating a Cluster

Deploy an App

Using kubectl to Create a Deployment

Interactive Tutorial - Deploying an App

Explore Your App

Viewing Pods and Nodes

Interactive Tutorial - Exploring Your App

Expose Your App Publicly

Using a Service to Expose Your App

Interactive Tutorial - Exposing Your App

Scale Your App

Running Multiple Instances of Your App

Interactive Tutorial - Scaling Your App

Update Your App

Performing a Rolling Update

Interactive Tutorial - Updating Your App

Configuration

Configuring Redis using a ConfigMap

Stateless Applications

Exposing an External IP Address to Access an Application in a Cluster

Example: Deploying PHP Guestbook application with Redis

Example: Add logging and metrics to the PHP / Redis Guestbook example

Stateful Applications

StatefulSet Basics

Example: Deploying WordPress and MySQL with Persistent Volumes

Example: Deploying Cassandra with Stateful Sets

Running ZooKeeper, A Distributed System Coordinator

Clusters

Services

Using Source IP

Reference

Standardized Glossary

Kubernetes Issues and Security

Kubernetes Issue Tracker

Kubernetes Security and Disclosure Information

Using the Kubernetes API

Kubernetes API Overview

Kubernetes API Concepts

Client Libraries

Kubernetes Deprecation Policy

Accessing the API

Controlling Access to the Kubernetes API

Authenticating with Bootstrap Tokens

Using Admission Controllers

Dynamic Admission Control

Managing Service Accounts

Authorization Overview

Using RBAC Authorization

Using ABAC Authorization

Using Node Authorization

API Reference

Well-Known Labels, Annotations and Taints

Setup tools reference

Kubeadm

Overview of kubeadm

kubeadm upgrade

kubeadm version

kubeadm init phase

kubeadm join phase

kubeadm reset phase

kubeadm upgrade phase

Implementation details

Command line tools reference

cloud-controller-manager

kube-controller-manager

Kubelet authentication/authorization

TLS bootstrapping

kubectl CLI

Overview of kubectl

JSONPath Support

kubectl Cheat Sheet

kubectl Commands

kubectl for Docker Users

kubectl Usage Conventions

Contribute

Start contributing

Intermediate contributing

Advanced contributing

Documentation style overview

Documentation style overview

Writing a new topic

Using Page Templates

Content organization

Custom Hugo Shortcodes

Reference Docs Overview

Reference Docs Overview

Contributing to the Upstream Kubernetes Code

Generating Reference Documentation for the Kubernetes API

Generating Reference Documentation for kubectl Commands

Generating Reference Pages for Kubernetes Components and Tools

Localizing Kubernetes Documentation

Participating in SIG Docs

Docs smoke test page

Kubernetes Documentation

Feedback

Was this page helpful?

Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.