From 022ccb475db095a7f6d43c7b63c18c9ae802f98a Mon Sep 17 00:00:00 2001 From: Daniel Smith Date: Thu, 16 Jul 2015 15:44:00 -0700 Subject: [PATCH] Add admin TOC; mv README -> intro, TOC -> README --- docs/admin/README.md | 94 ++++++++++--------------------- docs/admin/introduction.md | 112 +++++++++++++++++++++++++++++++++++++ 2 files changed, 140 insertions(+), 66 deletions(-) create mode 100644 docs/admin/introduction.md diff --git a/docs/admin/README.md b/docs/admin/README.md index a3558e9a5b0..d88e7b4e653 100644 --- a/docs/admin/README.md +++ b/docs/admin/README.md @@ -36,74 +36,36 @@ Documentation for other releases can be found at The cluster admin guide is for anyone creating or administering a Kubernetes cluster. It assumes some familiarity with concepts in the [User Guide](../user-guide/README.md). -## Planning a cluster +## Admin Guide Table of Contents -There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this -[matrix](../getting-started-guides/README.md). We call each of the combinations in this matrix a *distro*. +[Introduction](introduction.md) -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.md) fits best. - - If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster.md). - - You may want to familiarize yourself with the various - [components](cluster-components.md) needed to run a cluster. - -## Setting up a cluster - -Pick one of the Getting Started Guides from the [matrix](../getting-started-guides/README.md) 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.md)), 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.md). - -## Managing a cluster, including upgrades - -[Managing a cluster](cluster-management.md). - -## Managing nodes - -[Managing nodes](node.md). - -## Optional Cluster Services - -* **DNS Integration with SkyDNS** ([dns.md](dns.md)): - Resolving a DNS name directly to a Kubernetes service. - -* **Logging** with [Kibana](../user-guide/logging.md) - -## Multi-tenant support - -* **Resource Quota** ([resource-quota.md](resource-quota.md)) - -## Security - -* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](../user-guide/container-environment.md)): - Describes the environment for Kubelet managed containers on a Kubernetes - node. - -* **Securing access to the API Server** [accessing the api](accessing-the-api.md) - -* **Authentication** [authentication](authentication.md) - -* **Authorization** [authorization](authorization.md) - -* **Admission Controllers** [admission_controllers](admission-controllers.md) +1. [Components of a cluster](cluster-components.md) + 1. [Cluster Management](cluster-management.md) + 1. Administrating Master Components + 1. [The kube-apiserver binary](kube-apiserver.md) + 1. [Authorization](authorization.md) + 1. [Authentication](authentication.md) + 1. [Accessing the api](accessing-the-api.md) + 1. [Admission Controllers](admission-controllers.md) + 1. [Administrating Service Accounts](service-accounts-admin.md) + 1. [Resource Quotas](resource-quota.md) + 1. [The kube-scheduler binary](kube-scheduler.md) + 1. [The kube-controller-manager binary](kube-controller-manager.md) + 1. [Administrating Kubernetes Nodes](node.md) + 1. [The kubelet binary](kubelet.md) + 1. [The kube-proxy binary](kube-proxy.md) + 1. Administrating Addons + 1. [DNS](dns.md) + 1. [Networking](networking.md) + 1. [OVS Networking](ovs-networking.md) + 1. Example Configurations + 1. [Multiple Clusters](multi-cluster.md) + 1. [High Availability Clusters](high-availability.md) + 1. [Large Clusters](cluster-large.md) + 1. [Getting started from scratch](../getting-started-guides/scratch.md) + 1. [Kubernetes's use of salt](salt.md) + 1. [Troubleshooting](cluster-troubleshooting.md) diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md new file mode 100644 index 00000000000..de6e9ab4e7b --- /dev/null +++ b/docs/admin/introduction.md @@ -0,0 +1,112 @@ + + + + +WARNING +WARNING +WARNING +WARNING +WARNING + +

PLEASE NOTE: This document applies to the HEAD of the source tree

+ +If you are using a released version of Kubernetes, you should +refer to the docs that go with that version. + + +The latest 1.0.x release of this document can be found +[here](http://releases.k8s.io/release-1.0/docs/admin/introduction.md). + +Documentation for other releases can be found at +[releases.k8s.io](http://releases.k8s.io). + +-- + + + + + +# 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](../user-guide/README.md). + +## Planning a cluster + +There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this +[matrix](../getting-started-guides/README.md). 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.md) fits best. + - If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster.md). + - You may want to familiarize yourself with the various + [components](cluster-components.md) needed to run a cluster. + +## Setting up a cluster + +Pick one of the Getting Started Guides from the [matrix](../getting-started-guides/README.md) 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.md)), 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.md). + +## Managing a cluster, including upgrades + +[Managing a cluster](cluster-management.md). + +## Managing nodes + +[Managing nodes](node.md). + +## Optional Cluster Services + +* **DNS Integration with SkyDNS** ([dns.md](dns.md)): + Resolving a DNS name directly to a Kubernetes service. + +* **Logging** with [Kibana](../user-guide/logging.md) + +## Multi-tenant support + +* **Resource Quota** ([resource-quota.md](resource-quota.md)) + +## Security + +* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](../user-guide/container-environment.md)): + Describes the environment for Kubelet managed containers on a Kubernetes + node. + +* **Securing access to the API Server** [accessing the api](accessing-the-api.md) + +* **Authentication** [authentication](authentication.md) + +* **Authorization** [authorization](authorization.md) + +* **Admission Controllers** [admission_controllers](admission-controllers.md) + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/introduction.md?pixel)]() +