kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/_data/reference.yml

111 lines
3.5 KiB
YAML
Raw Normal View History

Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
bigheader: "Reference Documentation"
abstract: "Design docs, concept definitions, and references for APIs and CLIs."
toc:
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/reference/index.md
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Using the API
Add section for resources only
2017-01-07 00:26:23 +00:00
section:
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/reference/api-overview.md
Document API client libraries Add concept page about the Kubernetes API client libraries explaining what they do and list officially-supported & community-maintained client libraries. The list is obtained from https://github.com/kubernetes/community/blob/master/contributors/devel/client-libraries.md and I am planning to add a notice there urging people to update the /docs/reference/client-libraries.md when they add something there. Alternatively we could remove that page altogether. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2017-07-09 02:25:05 +00:00
- docs/reference/client-libraries.md
Moving Accessing the API stuff under Kubernetes API
2016-03-06 10:49:43 +00:00
- title: Accessing the API
section:
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/admin/accessing-the-api.md
- docs/admin/authentication.md
Add details on Bootstrap Tokens
2017-03-10 03:13:12 +00:00
- docs/admin/bootstrap-tokens.md
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/admin/admission-controllers.md
Extensible admission controller (#4092) * extensible-admission-controllers * Update extensible-admission-controllers.md * more on initializers * fixes * Expand external admission webhooks documentation * wrap at 80 chars * more * add reference
2017-06-28 23:38:44 +00:00
- docs/admin/extensible-admission-controllers.md
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/admin/service-accounts-admin.md
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Authorization
section:
- docs/admin/authorization/index.md
Reimplement #3767
2017-05-23 20:56:57 +00:00
- docs/admin/authorization/abac.md
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/admin/authorization/rbac.md
Document node authorization mode
2017-06-14 04:11:20 +00:00
- docs/admin/authorization/node.md
Reimplement #3770
2017-05-23 21:10:17 +00:00
- docs/admin/authorization/webhook.md
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/reference/deprecation-policy.md
Add Batch and Autoscaling API topics to left nav
2016-03-17 23:26:59 +00:00
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: API Reference
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
section:
Api and Kubectl reference docs updates for 1.7 (#4193) * Fix includes groups * Generated kubectl docs for 1.7 * Generated references docs for 1.7 api
2017-06-26 22:37:56 +00:00
- title: v1.7
path: /docs/api-reference/v1.7/
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: v1.6
path: /docs/api-reference/v1.6/
- title: v1.5
path: /docs/api-reference/v1.5/
- docs/reference/labels-annotations-taints.md
- title: OpenAPI and Swagger
Fix Reference ToC links
2017-04-07 17:41:54 +00:00
section:
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: OpenAPI Spec
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/kubernetes/api/openapi-spec/
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Swagger Spec
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/kubernetes/api/swagger-spec/
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Federation API
section:
- docs/reference/federation/v1/operations.html
- docs/reference/federation/v1/definitions.html
- docs/reference/federation/v1beta1/operations.html
- docs/reference/federation/v1beta1/definitions.html
- docs/reference/federation/extensions/v1beta1/operations.html
- docs/reference/federation/extensions/v1beta1/definitions.html
- title: kubectl CLI
section:
- docs/user-guide/kubectl-overview.md
Api and Kubectl reference docs updates for 1.7 (#4193) * Fix includes groups * Generated kubectl docs for 1.7 * Generated references docs for 1.7 api
2017-06-26 22:37:56 +00:00
- title: v1.7 Commands
path: /docs/user-guide/kubectl/v1.7/
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: v1.6 Commands
path: /docs/user-guide/kubectl/v1.6/
- title: v1.5 Commands
path: /docs/user-guide/kubectl/v1.5/
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/user-guide/docker-cli-to-kubectl.md
- docs/user-guide/kubectl-conventions.md
- docs/user-guide/jsonpath.md
- docs/user-guide/kubectl-cheatsheet.md
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
[Federation] Add reference docs for kubefed (#2937) * Update the reference docs for kubefed * fix syntax typos * add period * fix ToC links * fix kubefed link * revert to Kubefed title as link * Add kubefed reference docs for the first time * Add link for base kubefed command also
2017-08-01 20:57:19 +00:00
- title: Setup Tools
section:
- title: Kubeadm
path: /docs/admin/kubeadm/
- title: Kubefed
path: /docs/admin/kubefed/
section:
- docs/admin/kubefed.md
- docs/admin/kubefed_options.md
- docs/admin/kubefed_init.md
- docs/admin/kubefed_join.md
- docs/admin/kubefed_unjoin.md
- docs/admin/kubefed_version.md
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Config Reference
Rationalize navigation
2016-05-16 17:57:31 +00:00
section:
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/admin/kubelet.md
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/admin/kube-apiserver.md
- docs/admin/kube-controller-manager.md
- docs/admin/kube-proxy.md
- docs/admin/kube-scheduler.md
Move Guide topics: Federation reference. (#3394)
2017-04-13 23:23:19 +00:00
- docs/admin/federation-apiserver.md
- docs/admin/federation-controller-manager.md
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
- title: Kubernetes Design Docs
section:
- title: Kubernetes Architecture
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/community/contributors/design-proposals/architecture.md
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
- title: Kubernetes Design Overview
Fix Reference ToC links
2017-04-07 17:41:54 +00:00
path: https://github.com/kubernetes/kubernetes/tree/release-1.6/docs/design
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
- title: Kubernetes Identity and Access Management
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/community/contributors/design-proposals/access.md
use in-page titles to generate sidebar nav
2016-12-19 20:08:54 +00:00
- docs/admin/ovs-networking.md
Moving docs from /vX to /docs; we will use branches for old versions.
2016-02-29 23:17:22 +00:00
- title: Security Contexts
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/community/contributors/design-proposals/security_context.md
Alphabetized Lists Order can imply importance. Disorder can make things hard to find. For simple lists (glossary for example,) I alphabetized the components and docs. I left the shorter lists alone that have some context/expected order, or general eye pleasing as is.
2016-08-05 20:51:55 +00:00
- title: Security in Kubernetes
Update links to proper repos
2017-06-26 22:40:13 +00:00
path: https://git.k8s.io/community/contributors/design-proposals/security.md
Move Support topics. (#3363) * Move Support topics. * Fix toc entry.
2017-04-13 01:42:34 +00:00
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- title: Kubernetes Issues and Security
Move Support topics. (#3363) * Move Support topics. * Fix toc entry.
2017-04-13 01:42:34 +00:00
section:
- title: Kubernetes Issue Tracker on GitHub
path: https://github.com/kubernetes/kubernetes/issues/
Reference ToC refactor (#3427) * Reference ToC refactor * Move Federation into Reference * Fix ToC, add deprecation notice * Fix Reference ToC * tweak ToC * Move content into Reference * touch up kubectl * fix ToC syntax error * remove resources-reference docs * change kubectl section name * adjust page titles * create Command-Line Tools section * Move Federation API out to top level * remove extensions/v1beta1 definitions * rewrite Kubernetes API in Concepts in a later PR * Add jbeda to Kubernetes API Overview page for reviews. * incorporate feedback * remove /docs/federation * move around copy * cleanup reference landing page * update reference landing page
2017-04-20 20:04:32 +00:00
- docs/reference/security.md
Move Support topics. (#3363) * Move Support topics. * Fix toc entry.
2017-04-13 01:42:34 +00:00