github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/admin/README.md

101 lines
4.3 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
Run gendocs
2015-07-15 00:28:47 +00:00
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
Run gendocs
2015-07-13 22:15:35 +00:00
<h1>PLEASE NOTE: This document applies to the HEAD of the source
Run gendocs and munges
2015-07-12 04:04:52 +00:00
tree only. If you are using a released version of Kubernetes, you almost
certainly want the docs that go with that version.</h1>
<strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
Run gendocs
2015-07-15 00:28:47 +00:00
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
Run gendocs
2015-07-13 22:15:35 +00:00
Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
# Kubernetes Cluster Admin Guide
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
Initial TOC for the user guide.
2015-07-14 17:24:12 +00:00
It assumes some familiarity with concepts in the [User Guide](../user-guide/README.md).
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
## Planning a cluster
There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
[matrix](../getting-started-guides/README.md). We call each of the combinations in this matrix a *distro*.
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
Copy edits for spelling errors and typos Signed-off-by: Ed Costello <epc@epcostello.com>
2015-06-11 05:11:44 +00:00
Before choosing a particular guide, here are some things to consider:
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
- 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
Fix broken links in cluster-admin guide After the split of documentation into sections, some of the links in cluster-admin-guide appeared to be broken. This commit fixes them.
2015-03-14 11:09:10 +00:00
model](networking.md) fits best.
Take availability.md doc and - extract the portion related to multi-cluster operation into a new multi-cluster.md doc - merge the remainder (that was basically high-level troubleshooting advice) into cluster-troubleshooting.md
2015-07-16 09:20:30 +00:00
- If you are designing for very high-availability, you may want [clusters in multiple zones](multi-cluster.md).
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
## Setting up a cluster
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
Pick one of the Getting Started Guides from the [matrix](../getting-started-guides/README.md) and follow it.
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
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).
## Upgrading a cluster
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
[Upgrading a cluster](cluster-management.md).
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
## 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.
automated link fixes
2015-07-14 16:37:37 +00:00
* **Logging** with [Kibana](../user-guide/logging.md)
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
## Multi-tenant support
* **Namespaces** ([namespaces.md](namespaces.md)): Namespaces help different
projects, teams, or customers to share a kubernetes cluster.
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
* **Resource Quota** ([resource-quota.md](resource-quota.md))
Added Quota documentation for Cluster Admins. Also documented Admission Control Plugins for developers.
2015-03-16 22:14:30 +00:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
## Security
automated link fixes
2015-07-14 16:37:37 +00:00
* **Kubernetes Container Environment** ([docs/user-guide/container-environment.md](../user-guide/container-environment.md)):
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
Describes the environment for Kubelet managed containers on a Kubernetes
node.
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
* **Securing access to the API Server** [accessing the api](accessing-the-api.md)
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
Auto-fixed docs
2015-07-10 01:02:10 +00:00
* **Authentication** [authentication](authentication.md)
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
Auto-fixed docs
2015-07-10 01:02:10 +00:00
* **Authorization** [authorization](authorization.md)
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
* **Admission Controllers** [admission_controllers](admission-controllers.md)
Update Admission Control docs and add others. Address most of the comments from #8936 review. Adds minimal documentation for securityContext and serviceAccounts, which I will expand in a future PR. Adds analytics. Links admission_controllers.md from cluster-admin-guide.
2015-06-03 00:19:17 +00:00
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link.
2015-05-14 22:12:45 +00:00
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
standardize on - instead of _ in file names
2015-07-10 19:39:25 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/README.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->