Learn Kubernetes Basics

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?

View On Github

Explore the community

Reference

Kubernetes v1.13 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Edit This Page

Reference

This section of the Kubernetes documentation contains references.

API Reference
API Client Libraries
CLI Reference
Config Reference
Design Docs

API Reference

Kubernetes API Overview - Overview of the API for Kubernetes.
Kubernetes API Versions
- 1.13
- 1.12
- 1.11
- 1.10
- 1.9

API Client Libraries

To call the Kubernetes API from a programming language, you can use client libraries. Officially supported client libraries:

CLI Reference

kubectl - Main CLI tool for running commands and managing Kubernetes clusters.
- JSONPath - Syntax guide for using JSONPath expressions with kubectl.
kubeadm - CLI tool to easily provision a secure Kubernetes cluster.
kubefed - CLI tool to help you administrate your federated clusters.

Config Reference

kubelet - The primary node agent that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy.
kube-apiserver - REST API that validates and configures data for API objects such as pods, services, replication controllers.
kube-controller-manager - Daemon that embeds the core control loops shipped with Kubernetes.
kube-proxy - Can do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across a set of back-ends.
kube-scheduler - Scheduler that manages availability, performance, and capacity.
federation-apiserver - API server for federated clusters.
federation-controller-manager - Daemon that embeds the core control loops shipped with Kubernetes federation.

Design Docs

An archive of the design docs for Kubernetes functionality. Good starting points are Kubernetes Architecture and Kubernetes Design Overview.

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.