The developer guide is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project. It assumes some familiarity with concepts in the User Guide and the Cluster Admin Guide.
Contributor Guide (Please start here) to learn about how to contribute to Kubernetes.
GitHub Issues (/contributors/guide/issue-triage.md): How incoming issues are triaged.
Pull Request Process (/contributors/guide/pull-requests.md): When and why pull requests are closed.
Getting Recent Builds (getting-builds.md): How to get recent builds including the latest builds that pass CI.
Automated Tools (automation.md): Descriptions of the automation that is running on our github repository.
Development Guide (development.md): Setting up your development environment.
Testing (testing.md): How to run unit, integration, and end-to-end tests in your development sandbox.
Conformance Testing (conformance-tests.md) What is conformance testing and how to create/manage them.
Hunting flaky tests (flaky-tests.md): We have a goal of 99.9% flake free tests. Here's how to run your tests many times.
Logging Conventions (logging.md): klog levels.
Profiling Kubernetes (profiling.md): How to plug in go pprof profiler to Kubernetes.
Instrumenting Kubernetes with a new metric (instrumentation.md): How to add a new metrics to the Kubernetes code base.
Coding Conventions (coding-conventions.md): Coding style advice for contributors.
Document Conventions (The Kubernetes documentation) Document style advice for contributors.
Running a cluster locally (running-locally.md): A fast and lightweight local cluster deployment for development.
The REST API documentation explains the REST API exposed by apiserver.
Annotations (Annotations): are for attaching arbitrary non-identifying metadata to objects. Programs that automate Kubernetes objects may use annotations to store small amounts of their state.
API Conventions (api-conventions.md): Defining the verbs and resources used in the Kubernetes API.
API Client Libraries (Client Libraries): A list of existing client libraries, both supported and user-contributed.
Authentication (Authentication): The current and planned states of authentication tokens.
Authorization Plugins (Authorization): Authorization applies to all HTTP requests on the main apiserver port. This doc explains the available authorization implementations.
Admission Control Plugins (admission_control)
See the kubernetes/release repository for details on creating releases and related tools and helper scripts.
Cherry Pickscherry-picks.md How cherry picks are managed on release branches within the
kubernetes/kubernetes
repository.Getting Kubernetes Buildsgetting-builds.md
Targeting enhancements, Issues and PRs to Release Milestonesrelease.md
Logging Conventionslogging.md
Event style guideevent-style-guide.md
Instrumenting Kubernetes with a new metricinstrumentation.md
Structured Logging migration instructionsmigration-to-structured-logging.md
NOTE Flexvolume is deprecated. Out-of-tree CSI driver is the recommended way to write volume drivers in Kubernetes. See this doc here for more information.
CSI Drivers DocCSI drivers doc This site documents how to develop, deploy, and test a Container Storage Interface (CSI) driver on Kubernetes.
Flexvolumeflexvolume.md Flexvolume enables users to write their own drivers and add support for their volumes in Kubernetes.
Kubemark User Guidekubemark-guide.md
How to Set Up a Kubemark Clusterkubemark-setup-guide.md
Profiling Kubernetesprofiling.md
Understanding the Kubernetes Schedulerscheduling_code_hierarchy_overview.md
Customizing the Kubernetes Schedulerscheduler configuration
Understanding how Pods are queued in Kubernetes Schedulerscheduler_queues.md
Scheduler Benchmarkingscheduler_benchmarking.md
API Conventionsapi-conventions.md
Component Configuration Conventionscomponent-config-conventions.md
Changing the APIapi_changes.md
Staging Directory and Publishingstaging.md
Using Go Modules to Manage Dependenciesvendor.md This document only applies to Kubernetes development after 1.14.x. See previous godep documentation for working with dependencies for Kubernetes 1.14.x and earlier.
Using Go Modules to Manage Dependencies (for Kubernetes 1.14.x and earlier)godep.md See current documentation for working with dependencies for master branch development.
Conformance Testing in Kubernetesconformance-tests.md
- Strategic Merge Patchstrategic-merge-patch.md
- Writing Controllerscontrollers.md
- Generation and release cycle of clientsetgenerating-clientset.md
Testing guidetesting.md
Writing good e2e tests for Kuberneteswriting-good-e2e-tests.md
Writing Good Conformance Tests for Kuberneteswriting-good-conformance-tests.md
Integration Testing in Kubernetesintegration-tests.md
End-to-End Testing in Kubernetese2e-tests.md and e2e-tests-kubetest2.md
Debugging with Gubernatorgubernator.md
Flaky testsflaky-tests.md
CRI: the Container Runtime Interfacecontainer-runtime-interface.md
Container Runtime Interface (CRI) Networking Specificationskubelet-cri-networking.md
Measuring Node Performancenode-performance-testing.md
Container Runtime Interface: Container Metricscri-container-stats.md
Node End-To-End testse2e-node-tests.md
Container Runtime Interface: Testing Policycri-testing-policy.md
- Kubectl Conventionskubectl-conventions.md