community/contributors/devel
Kubernetes Submit Queue a74d906f01
Merge pull request #1299 from mikedanese/config
Automatic merge from submit-queue.

config: move config proposal to developer docs

* strip some of the design proposal cruft
* make recommendation on config group naming

@bgrant0607 @mtaufen @ncdc
2017-10-31 10:54:15 -07:00
..
gubernator-images imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
release Deprecate Kubernetes on-call rotations 2017-10-23 11:05:10 -07:00
OWNERS Make tabs in OWNERS files into 2 spaces. 2017-08-15 16:33:18 -07:00
README.md contributors/devel: Remove oncall reference (deprecated) from README.md 2017-10-26 17:59:12 -04:00
adding-an-APIGroup.md redirect adding-an-APIGroup.md to api-changes.md 2017-07-19 16:59:52 -07:00
api-conventions.md Merge pull request #1043 from resouer/inform-taint 2017-10-18 20:47:59 -05:00
api_changes.md contributors/devel/api_changes.md: update place with list of packages for protobuf. 2017-10-30 17:57:28 +01:00
automation.md Merge pull request #1211 from porridge/remove-mungedocs-reference 2017-10-19 11:01:43 -07:00
bazel.md Update bazel documentation 2017-10-26 14:34:08 -07:00
cherry-picks.md Update cherry-picks.md 2017-10-10 13:45:14 -07:00
client-libraries.md Move client-libraries.md to kubernetes.io 2017-07-10 22:42:53 -07:00
coding-conventions.md Merge pull request #908 from ianchakeres/fix-auth-link 2017-08-14 21:26:02 -07:00
collab.md Update collab.md 2016-12-15 21:31:18 -08:00
community-expectations.md corrected # of pull requests 2017-03-01 19:49:32 +05:30
component-config-conventions.md config: move config proposal to developer docs 2017-10-30 11:37:49 -07:00
container-runtime-interface.md Update the CRI documentation for 1.7 2017-06-20 17:20:03 -07:00
controllers.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
cri-container-stats.md Fix links after design proposal move 2017-09-26 02:15:55 +05:30
cri-validation.md Add docs for CRI validation test suites 2017-06-22 15:31:01 +08:00
development.md Fix the error for upgrading go version 2017-10-23 15:05:55 +08:00
e2e-node-tests.md correct the arg of kubelet in test-e2e-node 2017-10-30 22:49:37 +08:00
e2e-tests.md Fix broken ToC URL 2017-10-23 14:04:01 +01:00
faster_reviews.md consolidate pull-requests.md, faster_reviews.md, and pull-request-commands.md 2017-05-15 09:05:11 -07:00
flaky-tests.md Update flaky-tests.md 2017-10-17 16:54:38 +01:00
flexvolume.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
generating-clientset.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
getting-builds.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
git_workflow.png imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
go-code.md Fix minor typos and gramar 2017-08-28 10:07:37 +10:00
godep.md Rewrite docs on godep 2017-09-04 22:13:31 -07:00
gubernator.md Fixed some typo in community documents. 2017-02-06 11:24:04 +08:00
how-to-doc.md fix link in how-to-doc.md 2017-09-29 11:14:55 -07:00
instrumentation.md Fix indentation for nested numerated list 2017-06-20 15:45:41 +02:00
issues.md Deprecate Kubernetes on-call rotations 2017-10-23 11:05:10 -07:00
kubectl-conventions.md add draft exit code to kubectl-conventions, add some redundancy and parallelism 2017-10-10 15:35:49 +08:00
kubelet-cri-networking.md remove UNVERSIONED_WARNING (#382) 2017-02-17 14:50:10 -06:00
kubemark-guide.md Clean up contributors/devel docs 2017-09-03 11:06:32 +08:00
logging.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
mesos-style.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
node-performance-testing.md Update node-performance-testing.md 2017-08-22 10:54:53 +08:00
on-call-federation-build-cop.md Update on-call-federation-build-cop.md 2017-08-01 20:19:00 +05:30
owners.md Update OWNERS documents to reflect recent changes 2017-08-08 13:57:43 -07:00
pr_workflow.dia imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
pr_workflow.png imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
profiling.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
pull-requests.md Make release note description more readable per review comments. 2017-10-19 23:28:29 +08:00
running-locally.md Update running-locally.md 2017-08-22 13:03:02 +08:00
scalability-good-practices.md Change channel name for the rename. 2017-10-18 07:46:38 +02:00
scheduler.md Clean up contributors/devel docs 2017-09-03 11:06:32 +08:00
scheduler_algorithm.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
security-release-process.md Security Release: add copy about other upstream timelines 2017-10-16 14:49:15 -04:00
strategic-merge-patch.md Fix broken links after moving proposals to subdirs. 2017-09-21 16:25:49 +02:00
testing.md Remove "updated" note. 2017-10-17 13:02:08 +02:00
update-release-docs.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
updating-docs-for-feature-changes.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
vagrant.md Clean up contributors/devel docs 2017-09-03 11:06:32 +08:00
welcome-to-kubernetes-new-developer-guide.md contributors/devel: add welcome-to-kubernetes-new-developer-guide.md 2017-08-11 16:13:53 -07:00
writing-a-getting-started-guide.md imported docs/devel as a subtree 2016-11-30 14:43:43 -05:00
writing-good-e2e-tests.md Update writing-good-e2e-tests.md 2017-08-22 11:25:55 +08:00

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.

  • 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