upstream/kubernetes
1
0
Fork 0
mirror of https://github.com/kubernetes/kubernetes.git synced 2026-04-24 23:57:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
kubernetes/docs/developer-guide.md

55 lines
2.2 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 00:04:52 -04:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
<h1>*** PLEASE NOTE: This document applies to the HEAD of the source
tree only. If you are using a released version of Kubernetes, you almost
certainly want the docs that go with that version.</h1>
<strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
# 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.
automated link fixes
2015-07-14 12:37:37 -04:00
It assumes some familiarity with concepts in the [User Guide](user-guide/user-guide.md) and the [Cluster Admin
move admin related docs into docs/admin
2015-07-09 16:33:48 -04:00
Guide](admin/README.md).
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
## Developing against the Kubernetes API
* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
automated link fixes
2015-07-14 12:37:37 -04:00
* **Annotations** ([user-guide/annotations.md](user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects.
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
Programs that automate Kubernetes objects may use annotations to store small amounts of their state.
* **API Conventions** ([api-conventions.md](api-conventions.md)):
Defining the verbs and resources used in the Kubernetes API.
* **API Client Libraries** ([client-libraries.md](client-libraries.md)):
A list of existing client libraries, both supported and user-contributed.
## Writing Plugins
move admin related docs into docs/admin
2015-07-09 16:33:48 -04:00
* **Authentication Plugins** ([admin/authentication.md](admin/authentication.md)):
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
The current and planned states of authentication tokens.
move admin related docs into docs/admin
2015-07-09 16:33:48 -04:00
* **Authorization Plugins** ([admin/authorization.md](admin/authorization.md)):
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
Authorization applies to all HTTP requests on the main apiserver port.
This doc explains the available authorization implementations.
fixing url for admission_control docs
2015-03-27 17:31:27 -04:00
* **Admission Control Plugins** ([admission_control](design/admission_control.md))
Added Quota documentation for Cluster Admins. Also documented Admission Control Plugins for developers.
2015-03-16 18:14:30 -04:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 17:27:10 -04:00
## Contributing to the Kubernetes Project
Apply mungedocs changes
2015-07-13 20:13:09 -04:00
See this [README](devel/README.md).
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link.
2015-05-14 18:12:45 -04:00
Apply mungedocs changes
2015-07-13 20:13:09 -04:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link.
2015-05-14 18:12:45 -04:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/developer-guide.md?pixel)]()
Apply mungedocs changes
2015-07-13 20:13:09 -04:00
<!-- END MUNGE: GENERATED_ANALYTICS -->
Reference in a new issue Copy permalink