From f5c7bc79ff1494d566da8e91f76a4058b35d0ed2 Mon Sep 17 00:00:00 2001 From: Andrew Chen Date: Fri, 17 Mar 2017 17:17:42 -0700 Subject: [PATCH] Move Guide topic: Admin Guide --- _data/tasks.yml | 1 + docs/admin/index.md | 89 +--------------------- docs/tasks/administer-cluster/overview.md | 92 +++++++++++++++++++++++ 3 files changed, 95 insertions(+), 87 deletions(-) create mode 100644 docs/tasks/administer-cluster/overview.md diff --git a/_data/tasks.yml b/_data/tasks.yml index 6a85713142..33432d6541 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -59,6 +59,7 @@ toc: - title: Administering a Cluster section: + - docs/tasks/administer-cluster/overview.md - docs/tasks/administer-cluster/assign-pods-nodes.md - docs/tasks/administer-cluster/dns-horizontal-autoscaling.md - docs/tasks/administer-cluster/safely-drain-node.md diff --git a/docs/admin/index.md b/docs/admin/index.md index f1904aa470..2867d40703 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -1,92 +1,7 @@ --- -assignees: -- davidopp -- lavalamp title: 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](/docs/user-guide/). +{% include user-guide-content-moved.md %} -* 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](/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](/docs/admin/networking) fits best. - - If you are designing for very high-availability, you may want [clusters in multiple zones](/docs/admin/multi-cluster). - - You may want to familiarize yourself with the various - [components](/docs/admin/cluster-components) needed to run a cluster. - -## Setting up a cluster - -Pick one of the Getting Started Guides from the [matrix](/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](/docs/admin/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](/docs/admin/salt). - -## Managing a cluster, including upgrades - -[Managing a cluster](/docs/admin/cluster-management). - -## Managing nodes - -[Managing nodes](/docs/admin/node). - -## Optional Cluster Services - -* **DNS Integration with SkyDNS** ([dns.md](/docs/admin/dns)): - Resolving a DNS name directly to a Kubernetes service. - -* [**Cluster-level logging**](/docs/user-guide/logging/overview): - Saving container logs to a central log store with search/browsing interface. - -## Multi-tenant support - -* **Resource Quota** ([resourcequota/](/docs/admin/resourcequota/)) - -## Security - -* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](/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](/docs/admin/accessing-the-api) - -* **Authentication** [authentication](/docs/admin/authentication) - -* **Authorization** [authorization](/docs/admin/authorization) - -* **Admission Controllers** [admission controllers](/docs/admin/admission-controllers) - -* **Sysctls** [sysctls](/docs/admin/sysctls.md) - -* **Audit** [audit](/docs/admin/audit) - -* **Securing the kubelet** - * [Master-Node communication](/docs/admin/master-node-communication/) - * [TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) - * [Kubelet authentication/authorization](/docs/admin/kubelet-authentication-authorization/) +[Cluster Administration Overview](/docs/tasks/administer-cluster/overview/) diff --git a/docs/tasks/administer-cluster/overview.md b/docs/tasks/administer-cluster/overview.md new file mode 100644 index 0000000000..3aead8a3a4 --- /dev/null +++ b/docs/tasks/administer-cluster/overview.md @@ -0,0 +1,92 @@ +--- +assignees: +- davidopp +- lavalamp +title: Cluster Administration Overview +--- + +The cluster administration overview is for anyone creating or administering a Kubernetes cluster. +It assumes some familiarity with concepts in the [User Guide](/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](/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](/docs/admin/networking) fits best. + - If you are designing for very high-availability, you may want [clusters in multiple zones](/docs/admin/multi-cluster). + - You may want to familiarize yourself with the various + [components](/docs/admin/cluster-components) needed to run a cluster. + +## Setting up a cluster + +Pick one of the Getting Started Guides from the [matrix](/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](/docs/admin/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](/docs/admin/salt). + +## Managing a cluster, including upgrades + +[Managing a cluster](/docs/admin/cluster-management). + +## Managing nodes + +[Managing nodes](/docs/admin/node). + +## Optional Cluster Services + +* **DNS Integration with SkyDNS** ([dns.md](/docs/admin/dns)): + Resolving a DNS name directly to a Kubernetes service. + +* [**Cluster-level logging**](/docs/user-guide/logging/overview): + Saving container logs to a central log store with search/browsing interface. + +## Multi-tenant support + +* **Resource Quota** ([resourcequota/](/docs/admin/resourcequota/)) + +## Security + +* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](/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](/docs/admin/accessing-the-api) + +* **Authentication** [authentication](/docs/admin/authentication) + +* **Authorization** [authorization](/docs/admin/authorization) + +* **Admission Controllers** [admission controllers](/docs/admin/admission-controllers) + +* **Sysctls** [sysctls](/docs/admin/sysctls.md) + +* **Audit** [audit](/docs/admin/audit) + +* **Securing the kubelet** + * [Master-Node communication](/docs/admin/master-node-communication/) + * [TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) + * [Kubelet authentication/authorization](/docs/admin/kubelet-authentication-authorization/)