Skip to content

K
k3s
Commit 022ccb47 authored by Daniel Smith's avatar Daniel Smith
Browse files
Options

Add admin TOC; mv README -> intro, TOC -> README

parent 2d88675f
Hide whitespace changes
Inline Side-by-side
Showing with 142 additions and 68 deletions
docs/admin/README.md
View file @ 022ccb47
...@@ -36,74 +36,36 @@ Documentation for other releases can be found at ...@@ -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. 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). 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 [Introduction](introduction.md)
[matrix](../getting-started-guides/README.md). We call each of the combinations in this matrix a *distro*.
1. [Components of a cluster](cluster-components.md)
Before choosing a particular guide, here are some things to consider: 1. [Cluster Management](cluster-management.md)
- Are you just looking to try out Kubernetes on your laptop, or build a high-availability many-node cluster? Both 1. Administrating Master Components
models are supported, but some distros are better for one case or the other. 1. [The kube-apiserver binary](kube-apiserver.md)
- Will you be using a hosted Kubernetes cluster, such as [GKE](https://cloud.google.com/container-engine), or setting 1. [Authorization](authorization.md)
one up yourself? 1. [Authentication](authentication.md)
- Will your cluster be on-premises, or in the cloud (IaaS)? Kubernetes does not directly support hybrid clusters. We 1. [Accessing the api](accessing-the-api.md)
recommend setting up multiple clusters rather than spanning distant locations. 1. [Admission Controllers](admission-controllers.md)
- Will you be running Kubernetes on "bare metal" or virtual machines? Kubernetes supports both, via different distros. 1. [Administrating Service Accounts](service-accounts-admin.md)
- Do you just want to run a cluster, or do you expect to do active development of kubernetes project code? If the 1. [Resource Quotas](resource-quota.md)
latter, it is better to pick a distro actively used by other developers. Some distros only use binary releases, but 1. [The kube-scheduler binary](kube-scheduler.md)
offer is a greater variety of choices. 1. [The kube-controller-manager binary](kube-controller-manager.md)
- Not all distros are maintained as actively. Prefer ones which are listed as tested on a more recent version of 1. [Administrating Kubernetes Nodes](node.md)
Kubernetes. 1. [The kubelet binary](kubelet.md)
- If you are configuring kubernetes on-premises, you will need to consider what [networking 1. [The kube-proxy binary](kube-proxy.md)
model](networking.md) fits best. 1. Administrating Addons
- If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster.md). 1. [DNS](dns.md)
- You may want to familiarize yourself with the various 1. [Networking](networking.md)
[components](cluster-components.md) needed to run a cluster. 1. [OVS Networking](ovs-networking.md)
1. Example Configurations
## Setting up a cluster 1. [Multiple Clusters](multi-cluster.md)
1. [High Availability Clusters](high-availability.md)
Pick one of the Getting Started Guides from the [matrix](../getting-started-guides/README.md) and follow it. 1. [Large Clusters](cluster-large.md)
If none of the Getting Started Guides fits, you may want to pull ideas from several of the guides. 1. [Getting started from scratch](../getting-started-guides/scratch.md)
1. [Kubernetes's use of salt](salt.md)
One option for custom networking is *OpenVSwitch GRE/VxLAN networking* ([ovs-networking.md](ovs-networking.md)), which 1. [Troubleshooting](cluster-troubleshooting.md)
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)
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
......
docs/admin/introduction.md 0 → 100644
View file @ 022ccb47
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
<strong>
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).
</strong>
--
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
# 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)
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/introduction.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment