Table of Contents:
Table of Contents:
diff --git a/v1.1/basicstutorials.md b/v1.1/basicstutorials.md index e81620bb5b..06af1b9c89 100644 --- a/v1.1/basicstutorials.md +++ b/v1.1/basicstutorials.md @@ -2,8 +2,6 @@ title: "Quick Walkthrough: Kubernetes Basics" --- -## {{ page.title }} ## - Use this quick walkthrough of Kubernetes to learn about the basic application administration tasks.Table of Contents:
diff --git a/v1.1/deploy-clusters.md b/v1.1/deploy-clusters.md index 7f74683d24..7a3976d321 100644 --- a/v1.1/deploy-clusters.md +++ b/v1.1/deploy-clusters.md @@ -2,8 +2,6 @@ title: "Examples: Deploying Clusters" --- -## {{ page.title }} ## - Use the following examples to learn how to deploy your application into a Kubernetes cluster.Table of Contents:
diff --git a/v1.1/docs/README.md b/v1.1/docs/README.md index 0f06e68e06..abed6e0046 100644 --- a/v1.1/docs/README.md +++ b/v1.1/docs/README.md @@ -1,21 +1,17 @@ --- title: "Kubernetes Documentation: releases.k8s.io/release-1.1" --- - - -# Kubernetes Documentation: releases.k8s.io/release-1.1 - -* The [User's guide](user-guide/README.html) is for anyone who wants to run programs and +* The [User's guide](user-guide/README) is for anyone who wants to run programs and services on an existing Kubernetes cluster. -* The [Cluster Admin's guide](admin/README.html) is for anyone setting up +* The [Cluster Admin's guide](admin/README) is for anyone setting up a Kubernetes cluster or administering it. -* The [Developer guide](devel/README.html) is for anyone wanting to write +* The [Developer guide](devel/README) is for anyone wanting to write programs that access the Kubernetes API, write plugins or extensions, or modify the core code of Kubernetes. -* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl.html) is a detailed reference on +* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl) is a detailed reference on the `kubectl` CLI. * The [API object documentation](http://kubernetes.io/third_party/swagger-ui/) @@ -26,10 +22,10 @@ title: "Kubernetes Documentation: releases.k8s.io/release-1.1" * There are example files and walkthroughs in the [examples](../examples/) folder. -* If something went wrong, see the [troubleshooting](troubleshooting.html) document for how to debug. -You should also check the [known issues](user-guide/known-issues.html) for the release you're using. +* If something went wrong, see the [troubleshooting](troubleshooting) document for how to debug. +You should also check the [known issues](user-guide/known-issues) for the release you're using. -* To report a security issue, see [Reporting a Security Issue](reporting-security-issues.html). +* To report a security issue, see [Reporting a Security Issue](reporting-security-issues). diff --git a/v1.1/docs/admin/README.md b/v1.1/docs/admin/README.md index f7e1803e01..6d672796c2 100644 --- a/v1.1/docs/admin/README.md +++ b/v1.1/docs/admin/README.md @@ -1,44 +1,40 @@ --- title: "Kubernetes Cluster Admin Guide" --- - - -# 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.html). +It assumes some familiarity with concepts in the [User Guide](../user-guide/README). ## Admin Guide Table of Contents -[Introduction](introduction.html) +[Introduction](introduction) -1. [Components of a cluster](cluster-components.html) - 1. [Cluster Management](cluster-management.html) +1. [Components of a cluster](cluster-components) + 1. [Cluster Management](cluster-management) 1. Administrating Master Components - 1. [The kube-apiserver binary](kube-apiserver.html) - 1. [Authorization](authorization.html) - 1. [Authentication](authentication.html) - 1. [Accessing the api](accessing-the-api.html) - 1. [Admission Controllers](admission-controllers.html) - 1. [Administrating Service Accounts](service-accounts-admin.html) - 1. [Resource Quotas](resource-quota.html) - 1. [The kube-scheduler binary](kube-scheduler.html) - 1. [The kube-controller-manager binary](kube-controller-manager.html) - 1. [Administrating Kubernetes Nodes](node.html) - 1. [The kubelet binary](kubelet.html) - 1. [Garbage Collection](garbage-collection.html) - 1. [The kube-proxy binary](kube-proxy.html) + 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.html) - 1. [Networking](networking.html) - 1. [OVS Networking](ovs-networking.html) + 1. [DNS](dns) + 1. [Networking](networking) + 1. [OVS Networking](ovs-networking) 1. Example Configurations - 1. [Multiple Clusters](multi-cluster.html) - 1. [High Availability Clusters](high-availability.html) - 1. [Large Clusters](cluster-large.html) - 1. [Getting started from scratch](../getting-started-guides/scratch.html) - 1. [Kubernetes's use of salt](salt.html) - 1. [Troubleshooting](cluster-troubleshooting.html) + 1. [Multiple Clusters](multi-cluster) + 1. [High Availability Clusters](high-availability) + 1. [Large Clusters](cluster-large) + 1. [Getting started from scratch](../getting-started-guides/scratch) + 1. [Kubernetes's use of salt](salt) + 1. [Troubleshooting](cluster-troubleshooting) diff --git a/v1.1/docs/admin/accessing-the-api.md b/v1.1/docs/admin/accessing-the-api.md index a611e04056..ffab5e3507 100644 --- a/v1.1/docs/admin/accessing-the-api.md +++ b/v1.1/docs/admin/accessing-the-api.md @@ -1,17 +1,13 @@ --- title: "Configuring APIserver ports" --- - - -# Configuring APIserver ports - This document describes what ports the Kubernetes apiserver may serve on and how to reach them. The audience is cluster administrators who want to customize their cluster or understand the details. Most questions about accessing the cluster are covered -in [Accessing the cluster](../user-guide/accessing-the-cluster.html). +in [Accessing the cluster](../user-guide/accessing-the-cluster). ## Ports and IPs Served On @@ -30,10 +26,10 @@ 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.html). - - uses policy-based [authorization](authorization.html). + - uses token-file or client-certificate based [authentication](authentication). + - uses policy-based [authorization](authorization). 3. Removed: ReadOnly Port - - For security reasons, this had to be removed. Use the [service account](../user-guide/service-accounts.html) feature instead. + - For security reasons, this had to be removed. Use the [service account](../user-guide/service-accounts) feature instead. ## Proxies and Firewall rules @@ -56,7 +52,7 @@ variety of uses cases: running on the `kubernetes-master` machine. The proxy can use cert-based authentication or token-based authentication. 2. Processes running in Containers on Kubernetes that need to read from - the apiserver. Currently, these can use a [service account](../user-guide/service-accounts.html). + the apiserver. Currently, these can use a [service account](../user-guide/service-accounts). 3. Scheduler and Controller-manager processes, which need to do read-write API operations. Currently, these have to run on the same host as the apiserver and use the Localhost Port. In the future, these will be diff --git a/v1.1/docs/admin/admission-controllers.md b/v1.1/docs/admin/admission-controllers.md index 7e38cc89ce..bef19d5f45 100644 --- a/v1.1/docs/admin/admission-controllers.md +++ b/v1.1/docs/admin/admission-controllers.md @@ -1,33 +1,7 @@ --- title: "Admission Controllers" --- - - -# Admission Controllers - -**Table of Contents** - - -- [Admission Controllers](#admission-controllers) - - [What are they?](#what-are-they) - - [Why do I need them?](#why-do-i-need-them) - - [How do I turn on an admission control plug-in?](#how-do-i-turn-on-an-admission-control-plug-in) - - [What does each plug-in do?](#what-does-each-plug-in-do) - - [AlwaysAdmit](#alwaysadmit) - - [AlwaysDeny](#alwaysdeny) - - [DenyExecOnPrivileged (deprecated)](#denyexeconprivileged-deprecated) - - [DenyEscalatingExec](#denyescalatingexec) - - [ServiceAccount](#serviceaccount) - - [SecurityContextDeny](#securitycontextdeny) - - [ResourceQuota](#resourcequota) - - [LimitRanger](#limitranger) - - [InitialResources (experimental)](#initialresources-experimental) - - [NamespaceExists (deprecated)](#namespaceexists-deprecated) - - [NamespaceAutoProvision (deprecated)](#namespaceautoprovision-deprecated) - - [NamespaceLifecycle](#namespacelifecycle) - - [Is there a recommended set of plug-ins to use?](#is-there-a-recommended-set-of-plug-ins-to-use) - - +{% include pagetoc.html %} ## What are they? @@ -87,12 +61,12 @@ enabling this plug-in. ### ServiceAccount -This plug-in implements automation for [serviceAccounts](../user-guide/service-accounts.html). +This plug-in implements automation for [serviceAccounts](../user-guide/service-accounts). We strongly recommend using this plug-in if you intend to make use of Kubernetes `ServiceAccount` objects. ### SecurityContextDeny -This plug-in will deny any pod with a [SecurityContext](../user-guide/security-context.html) that defines options that were not available on the `Container`. +This plug-in will deny any pod with a [SecurityContext](../user-guide/security-context) that defines options that were not available on the `Container`. ### ResourceQuota @@ -100,7 +74,7 @@ This plug-in will observe the incoming request and ensure that it does not viola enumerated in the `ResourceQuota` object in a `Namespace`. If you are using `ResourceQuota` objects in your Kubernetes deployment, you MUST use this plug-in to enforce quota constraints. -See the [resourceQuota design doc](../design/admission_control_resource_quota.html) and the [example of Resource Quota](resourcequota/) for more details. +See the [resourceQuota design doc](../design/admission_control_resource_quota) and the [example of Resource Quota](resourcequota/) for more details. It is strongly encouraged that this plug-in is configured last in the sequence of admission control plug-ins. This is so that quota is not prematurely incremented only for the request to be rejected later in admission control. @@ -113,7 +87,7 @@ your Kubernetes deployment, you MUST use this plug-in to enforce those constrain be used to apply default resource requests to Pods that don't specify any; currently, the default LimitRanger applies a 0.1 CPU requirement to all Pods in the `default` namespace. -See the [limitRange design doc](../design/admission_control_limit_range.html) and the [example of Limit Range](limitrange/) for more details. +See the [limitRange design doc](../design/admission_control_limit_range) and the [example of Limit Range](limitrange/) for more details. ### InitialResources (experimental) @@ -122,7 +96,7 @@ then the plug-in auto-populates a compute resource request based on historical u If there is not enough data to make a decision the Request is left unchanged. When the plug-in sets a compute resource request, it annotates the pod with information on what compute resources it auto-populated. -See the [InitialResouces proposal](../proposals/initial-resources.html) for more details. +See the [InitialResouces proposal](../proposals/initial-resources) for more details. ### NamespaceExists (deprecated) @@ -154,9 +128,9 @@ Yes. For Kubernetes 1.0, we strongly recommend running the following set of admission control plug-ins (order matters): ``` -{% raw %} + --admission-control=NamespaceLifecycle,LimitRanger,SecurityContextDeny,ServiceAccount,ResourceQuota -{% endraw %} + ``` diff --git a/v1.1/docs/admin/authentication.md b/v1.1/docs/admin/authentication.md index ac32e2b244..bf64b491a6 100644 --- a/v1.1/docs/admin/authentication.md +++ b/v1.1/docs/admin/authentication.md @@ -1,10 +1,6 @@ --- title: "Authentication Plugins" --- - - -# Authentication Plugins - Kubernetes uses client certificates, tokens, or http basic auth to authenticate users for API calls. **Client certificate authentication** is enabled by passing the `--client-ca-file=SOMEFILE` diff --git a/v1.1/docs/admin/authorization.md b/v1.1/docs/admin/authorization.md index b7c9fe66ee..5bea29d852 100644 --- a/v1.1/docs/admin/authorization.md +++ b/v1.1/docs/admin/authorization.md @@ -1,13 +1,8 @@ --- title: "Authorization Plugins" --- - - -# Authorization Plugins - - In Kubernetes, authorization happens as a separate step from authentication. -See the [authentication documentation](authentication.html) for an +See the [authentication documentation](authentication) for an overview of authentication. Authorization applies to all HTTP accesses on the main (secure) apiserver port. @@ -94,25 +89,25 @@ To permit an action Policy with an unset namespace applies regardless of namespa A service account automatically generates a user. The user's name is generated according to the naming convention: ``` -{% raw %} + system:serviceaccount: