Switch branches/tags
Nothing to show
Find file History
Latest commit c7b3bdf Oct 20, 2017 @dims dims Merge pull request #1238 from yuexiao-wang/update-go-version
Update Go version required by Kubernetes
Permalink
..
Failed to load latest commit information.
gubernator-images imported docs/devel as a subtree Nov 30, 2016
release Update files in the community repo to point to multicluster rather th… Oct 13, 2017
OWNERS Make tabs in OWNERS files into 2 spaces. Aug 15, 2017
README.md Remove a useless link to an empty document. Oct 17, 2017
adding-an-APIGroup.md redirect adding-an-APIGroup.md to api-changes.md Jul 19, 2017
api-conventions.md Merge pull request #1043 from resouer/inform-taint Oct 19, 2017
api_changes.md Merge pull request #1160 from php-coder/no_extensions_api Oct 17, 2017
automation.md Merge pull request #1211 from porridge/remove-mungedocs-reference Oct 19, 2017
bazel.md Document set of host dependencies for bazel-build Aug 30, 2017
cherry-picks.md Update doc for release note and cherry pick labels Aug 31, 2017
client-libraries.md Move client-libraries.md to kubernetes.io Jul 11, 2017
coding-conventions.md Merge pull request #908 from ianchakeres/fix-auth-link Aug 15, 2017
collab.md Update collab.md Dec 16, 2016
community-expectations.md corrected # of pull requests Mar 1, 2017
container-runtime-interface.md Update the CRI documentation for 1.7 Jun 21, 2017
controllers.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
cri-container-stats.md Fix links after design proposal move Sep 25, 2017
cri-validation.md Add docs for CRI validation test suites Jun 22, 2017
development.md Merge pull request #1238 from yuexiao-wang/update-go-version Oct 20, 2017
e2e-node-tests.md fix error links in test docs Feb 22, 2017
e2e-tests.md Removing prom-push-gateway flag Sep 14, 2017
faster_reviews.md consolidate pull-requests.md, faster_reviews.md, and pull-request-com… May 15, 2017
flaky-tests.md Update flaky-tests.md Oct 17, 2017
flexvolume.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
generating-clientset.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
getting-builds.md imported docs/devel as a subtree Nov 30, 2016
git_workflow.png imported docs/devel as a subtree Nov 30, 2016
go-code.md Fix minor typos and gramar Aug 28, 2017
godep.md Rewrite docs on godep Sep 5, 2017
gubernator.md Fixed some typo in community documents. Feb 6, 2017
how-to-doc.md fix link in how-to-doc.md Sep 29, 2017
instrumentation.md Fix indentation for nested numerated list Jun 20, 2017
issues.md Clarify what "on its own" means. Oct 16, 2017
kubectl-conventions.md add draft exit code to kubectl-conventions, add some redundancy and p… Oct 10, 2017
kubelet-cri-networking.md remove UNVERSIONED_WARNING (#382) Feb 17, 2017
kubemark-guide.md Clean up contributors/devel docs Sep 3, 2017
logging.md imported docs/devel as a subtree Nov 30, 2016
mesos-style.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
node-performance-testing.md Update node-performance-testing.md Aug 22, 2017
on-call-build-cop.md Reword build cop duties for batch merges. Jun 24, 2017
on-call-federation-build-cop.md Update on-call-federation-build-cop.md Aug 1, 2017
on-call-rotations.md imported docs/devel as a subtree Nov 30, 2016
on-call-user-support.md Fix name and link to k8s oncall. Oct 17, 2017
owners.md Update OWNERS documents to reflect recent changes Aug 8, 2017
pr_workflow.dia imported docs/devel as a subtree Nov 30, 2016
pr_workflow.png imported docs/devel as a subtree Nov 30, 2016
profiling.md imported docs/devel as a subtree Nov 30, 2016
pull-requests.md Make release note description more readable per review comments. Oct 19, 2017
running-locally.md Update running-locally.md Aug 22, 2017
scalability-good-practices.md Change channel name for the rename. Oct 18, 2017
scheduler.md Clean up contributors/devel docs Sep 3, 2017
scheduler_algorithm.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
security-release-process.md Security Release: add copy about other upstream timelines Oct 16, 2017
strategic-merge-patch.md Fix broken links after moving proposals to subdirs. Sep 21, 2017
testing.md Remove "updated" note. Oct 17, 2017
update-release-docs.md imported docs/devel as a subtree Nov 30, 2016
updating-docs-for-feature-changes.md imported docs/devel as a subtree Nov 30, 2016
vagrant.md Clean up contributors/devel docs Sep 3, 2017
welcome-to-kubernetes-new-developer-guide.md contributors/devel: add welcome-to-kubernetes-new-developer-guide.md Aug 11, 2017
writing-a-getting-started-guide.md imported docs/devel as a subtree Nov 30, 2016
writing-good-e2e-tests.md Update writing-good-e2e-tests.md Aug 22, 2017

README.md

Kubernetes Developer Guide

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.

The process of developing and contributing code to the Kubernetes project

  • Welcome to Kubernetes (New Developer Guide) (welcome-to-kubernetes-new-developer-guide.md): An introductory guide to contributing to K8s.

  • On Collaborative Development (collab.md): Info on pull requests and code reviews.

  • GitHub Issues (issues.md): How incoming issues are triaged.

  • Pull Request Process (pull-requests.md): When and why pull requests are closed.

  • Kubernetes On-Call Rotations (on-call-rotations.md): Descriptions of on-call rotations for build and end-user support.

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

Setting up your dev environment, coding, and debugging

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

  • 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): Glog 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 (how-to-doc.md) Document style advice for contributors.

  • Running a cluster locally (running-locally.md): A fast and lightweight local cluster deployment for development.

Developing against the Kubernetes API

  • 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.md): A list of existing client libraries, both supported and user-contributed.

Writing plugins

  • 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)

Building releases

See the kubernetes/release repository for details on creating releases and related tools and helper scripts.

Analytics