github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/developer-guide.md

36 lines
1.5 KiB
Markdown
Raw Normal View History

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 21:27:10 +00: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.
It assumes some familiarity with concepts in the [User Guide](user-guide.md) and the [Cluster Admin
Guide](cluster-admin-guide.md).
## Developing against the Kubernetes API
* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
* **Annotations** ([annotations.md](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](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
* **Authentication Plugins** ([authentication.md](authentication.md)):
The current and planned states of authentication tokens.
* **Authorization Plugins** ([authorization.md](authorization.md)):
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 21:31:27 +00: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 22:14:30 +00: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 21:27:10 +00:00
## Contributing to the Kubernetes Project
See this [README](../docs/devel/README.md).