github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/devel
History
Brandon Philips cf676f9ccd docs: devel: point people at place for OWNERS status 
All of the tracking is happening here https://github.com/kubernetes/contrib/issues/1389 point people at it.
 		2016-11-29 13:13:05 -08:00
..
developer-guides Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
gubernator-images Add gubernator.md and image files 2016-08-19 10:05:33 -07:00
local-cluster Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
README.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
adding-an-APIGroup.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
api-conventions.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
api_changes.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
automation.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
bazel.md Merge pull request #36699 from k82cn/update_bazel 2016-11-28 11:43:45 -08:00
cherry-picks.md versionize-docs is dead 2016-10-26 00:06:59 +02:00
cli-roadmap.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
client-libraries.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
coding-conventions.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
collab.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
community-expectations.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
container-runtime-interface.md Add a known issue in the CRI doc 2016-11-22 17:56:38 -08:00
controllers.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
development.md Merge pull request #36634 from thockin/reviewable-doc 2016-11-28 11:43:16 -08:00
e2e-node-tests.md [kubelet]update --cgroups-per-qos to --experimental-cgroups-per-qos 2016-11-15 15:55:47 +08:00
e2e-tests.md Fix typo in e2e tests doc 2016-11-23 10:52:04 +01:00
faster_reviews.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
flaky-tests.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
generating-clientset.md remove release_1_4 2016-10-31 15:05:26 -07:00
getting-builds.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
git_workflow.png
…
go-code.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
godep.md Fix typo in docs/devel/godep.md 2016-11-02 19:07:35 -07:00
gubernator.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
how-to-doc.md versionize-docs is dead 2016-10-26 00:06:59 +02:00
instrumentation.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
issues.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
kubectl-conventions.md kubectl: add less verbose version 2016-11-10 14:07:42 -08:00
kubemark-guide.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
logging.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
mesos-style.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
node-performance-testing.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
on-call-build-cop.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
on-call-rotations.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
on-call-user-support.md fix munge-docs build errors 2016-11-17 16:49:00 +01:00
owners.md docs: devel: point people at place for OWNERS status 2016-11-29 13:13:05 -08:00
pr_workflow.dia
…
pr_workflow.png
…
profiling.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
pull-requests.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
running-locally.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
scheduler.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
scheduler_algorithm.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
testing.md Fix quoting of $PATH in instructions. 2016-11-18 09:21:28 +01:00
update-release-docs.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02:00
updating-docs-for-feature-changes.md Rename PetSet to StatefulSet in docs and examples. 2016-11-05 00:17:28 -07:00
writing-a-getting-started-guide.md fix munge-docs build errors 2016-11-17 16:49:00 +01:00
writing-good-e2e-tests.md Remove 'this is HEAD' warning on docs 2016-10-26 00:06:59 +02: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

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

  • GitHub Issues (issues.md): How incoming issues are reviewed and prioritized.

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

  • Faster PR reviews (faster_reviews.md): How to get faster PR reviews.

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

  • 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 (docs/user-guide/annotations.md): 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

Building releases

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

Analytics