update guides

pull/43/head
John Mulhausen 2016-02-19 15:31:46 -08:00
parent b90e89273a
commit f877024e8a
6 changed files with 75 additions and 112 deletions

View File

@ -83,7 +83,7 @@ toc:
- title: Administering Clusters
section:
- title: Kubernetes Cluster Admin Guide
path: /v1.1/docs/admin/introduction/
path: /v1.1/docs/admin/
- title: Using Multiple Clusters
path: /v1.1/docs/admin/multi-cluster/
- title: Using Large Clusters

View File

@ -27,8 +27,8 @@ By default the Kubernetes APIserver serves HTTP on 2 ports:
- default is port 6443, change with `--secure-port` flag.
- default IP is first non-localhost network interface, change with `--bind-address` flag.
- serves HTTPS. Set cert with `--tls-cert-file` and key with `--tls-private-key-file` flag.
- uses token-file or client-certificate based [authentication](authentication).
- uses policy-based [authorization](authorization).
- uses token-file or client-certificate based [authentication(/{{page.version}}/docs/admin/authentication).
- uses policy-based [authorization(/{{page.version}}/docs/admin/authorization).
3. Removed: ReadOnly Port
- For security reasons, this had to be removed. Use the [service account](/{{page.version}}/docs/user-guide/service-accounts) feature instead.

View File

@ -2,7 +2,7 @@
title: "Authorization Plugins"
---
In Kubernetes, authorization happens as a separate step from authentication.
See the [authentication documentation](authentication) for an
See the [authentication documentation(/{{page.version}}/docs/admin/authentication) for an
overview of authentication.
Authorization applies to all HTTP accesses on the main (secure) apiserver port.

View File

@ -4,34 +4,75 @@ title: "Kubernetes Cluster Admin Guide"
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
It assumes some familiarity with concepts in the [User Guide](/{{page.version}}/docs/user-guide/).
## Admin Guide Table of Contents
* TOC
{:toc}
[Introduction](introduction)
## Planning a cluster
1. [Components of a cluster](cluster-components)
1. [Cluster Management](cluster-management)
1. Administrating Master Components
1. [The kube-apiserver binary](kube-apiserver)
1. [Authorization](authorization)
1. [Authentication](authentication)
1. [Accessing the api](accessing-the-api)
1. [Admission Controllers](admission-controllers)
1. [Administrating Service Accounts](service-accounts-admin)
1. [Resource Quotas](resource-quota)
1. [The kube-scheduler binary](kube-scheduler)
1. [The kube-controller-manager binary](kube-controller-manager)
1. [Administrating Kubernetes Nodes](node)
1. [The kubelet binary](kubelet)
1. [Garbage Collection](garbage-collection)
1. [The kube-proxy binary](kube-proxy)
1. Administrating Addons
1. [DNS](dns)
1. [Networking](networking)
1. [OVS Networking](ovs-networking)
1. Example Configurations
1. [Multiple Clusters](multi-cluster)
1. [High Availability Clusters](high-availability)
1. [Large Clusters](cluster-large)
1. [Getting started from scratch](/{{page.version}}/docs/getting-started-guides/scratch)
1. [Kubernetes's use of salt](salt)
1. [Troubleshooting](cluster-troubleshooting)
There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this
[matrix](/{{page.version}}/docs/getting-started-guides/). We call each of the combinations in this matrix a *distro*.
Before choosing a particular guide, here are some things to consider:
- Are you just looking to try out Kubernetes on your laptop, or build a high-availability many-node cluster? Both
models are supported, but some distros are better for one case or the other.
- Will you be using a hosted Kubernetes cluster, such as [GKE](https://cloud.google.com/container-engine), or setting
one up yourself?
- Will your cluster be on-premises, or in the cloud (IaaS)? Kubernetes does not directly support hybrid clusters. We
recommend setting up multiple clusters rather than spanning distant locations.
- Will you be running Kubernetes on "bare metal" or virtual machines? Kubernetes supports both, via different distros.
- Do you just want to run a cluster, or do you expect to do active development of kubernetes project code? If the
latter, it is better to pick a distro actively used by other developers. Some distros only use binary releases, but
offer is a greater variety of choices.
- Not all distros are maintained as actively. Prefer ones which are listed as tested on a more recent version of
Kubernetes.
- If you are configuring kubernetes on-premises, you will need to consider what [networking
model](networking) fits best.
- If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster).
- You may want to familiarize yourself with the various
[components](cluster-components) needed to run a cluster.
## Setting up a cluster
Pick one of the Getting Started Guides from the [matrix](/{{page.version}}/docs/getting-started-guides/) and follow it.
If none of the Getting Started Guides fits, you may want to pull ideas from several of the guides.
One option for custom networking is *OpenVSwitch GRE/VxLAN networking* ([ovs-networking.md](ovs-networking)), which
uses OpenVSwitch to set up networking between pods across
Kubernetes nodes.
If you are modifying an existing guide which uses Salt, this document explains [how Salt is used in the Kubernetes
project](salt).
## Managing a cluster, including upgrades
[Managing a cluster](cluster-management).
## Managing nodes
[Managing nodes](node).
## Optional Cluster Services
* **DNS Integration with SkyDNS** ([dns.md](dns)):
Resolving a DNS name directly to a Kubernetes service.
* **Logging** with [Kibana](/{{page.version}}/docs/user-guide/logging)
## Multi-tenant support
* **Resource Quota** ([resource-quota.md](resource-quota))
## Security
* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](/{{page.version}}/docs/user-guide/container-environment)):
Describes the environment for Kubelet managed containers on a Kubernetes
node.
* **Securing access to the API Server** [accessing the api](accessing-the-api)
* **Authentication** [authentication(/{{page.version}}/docs/admin/authentication)
* **Authorization** [authorization(/{{page.version}}/docs/admin/authorization)
* **Admission Controllers** [admission_controllers](admission-controllers)

View File

@ -1,78 +0,0 @@
---
title: "Kubernetes Cluster Admin Guide"
---
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
It assumes some familiarity with concepts in the [User Guide](/{{page.version}}/docs/user-guide/).
* TOC
{:toc}
## Planning a cluster
There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this
[matrix](/{{page.version}}/docs/getting-started-guides/). We call each of the combinations in this matrix a *distro*.
Before choosing a particular guide, here are some things to consider:
- Are you just looking to try out Kubernetes on your laptop, or build a high-availability many-node cluster? Both
models are supported, but some distros are better for one case or the other.
- Will you be using a hosted Kubernetes cluster, such as [GKE](https://cloud.google.com/container-engine), or setting
one up yourself?
- Will your cluster be on-premises, or in the cloud (IaaS)? Kubernetes does not directly support hybrid clusters. We
recommend setting up multiple clusters rather than spanning distant locations.
- Will you be running Kubernetes on "bare metal" or virtual machines? Kubernetes supports both, via different distros.
- Do you just want to run a cluster, or do you expect to do active development of kubernetes project code? If the
latter, it is better to pick a distro actively used by other developers. Some distros only use binary releases, but
offer is a greater variety of choices.
- Not all distros are maintained as actively. Prefer ones which are listed as tested on a more recent version of
Kubernetes.
- If you are configuring kubernetes on-premises, you will need to consider what [networking
model](networking) fits best.
- If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster).
- You may want to familiarize yourself with the various
[components](cluster-components) needed to run a cluster.
## Setting up a cluster
Pick one of the Getting Started Guides from the [matrix](/{{page.version}}/docs/getting-started-guides/) and follow it.
If none of the Getting Started Guides fits, you may want to pull ideas from several of the guides.
One option for custom networking is *OpenVSwitch GRE/VxLAN networking* ([ovs-networking.md](ovs-networking)), which
uses OpenVSwitch to set up networking between pods across
Kubernetes nodes.
If you are modifying an existing guide which uses Salt, this document explains [how Salt is used in the Kubernetes
project](salt).
## Managing a cluster, including upgrades
[Managing a cluster](cluster-management).
## Managing nodes
[Managing nodes](node).
## Optional Cluster Services
* **DNS Integration with SkyDNS** ([dns.md](dns)):
Resolving a DNS name directly to a Kubernetes service.
* **Logging** with [Kibana](/{{page.version}}/docs/user-guide/logging)
## Multi-tenant support
* **Resource Quota** ([resource-quota.md](resource-quota))
## Security
* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](/{{page.version}}/docs/user-guide/container-environment)):
Describes the environment for Kubelet managed containers on a Kubernetes
node.
* **Securing access to the API Server** [accessing the api](accessing-the-api)
* **Authentication** [authentication](authentication)
* **Authorization** [authorization](authorization)
* **Admission Controllers** [admission_controllers](admission-controllers)

View File

@ -75,7 +75,7 @@ Even though Kubernetes provides a lot of functionality, there are always new sce
[Labels](/{{page.version}}/docs/user-guide/labels) empower users to organize their resources however they please. [Annotations](/{{page.version}}/docs/user-guide/annotations) enable users to decorate resources with custom information to facilitate their workflows and provide an easy way for management tools to checkpoint state.
Additionally, the [Kubernetes control plane](/{{page.version}}/docs/admin/cluster-components) is built upon the same [APIs](api) that are available to developers and users. Users can write their own controllers, [schedulers](/{{page.version}}/docs/devel/scheduler), etc., if they choose, with [their own APIs](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/extending-api.md) that can be targeted by a general-purpose [command-line tool](/{{page.version}}/docs/user-guide/kubectl-overview).
Additionally, the [Kubernetes control plane](/{{page.version}}/docs/admin/cluster-components) is built upon the same [APIs](/{{page.version}}/docs/api/) that are available to developers and users. Users can write their own controllers, [schedulers](/{{page.version}}/docs/devel/scheduler), etc., if they choose, with [their own APIs](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/extending-api.md) that can be targeted by a general-purpose [command-line tool](/{{page.version}}/docs/user-guide/kubectl-overview).
This [design](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/design/principles.md) has enabled a number of other systems to build atop Kubernetes.