Apply templates to all concepts and tasks to fix double bullets in TOC (#9149)

* Apply concept template to fix double bullet issue. * Apply concept template * Apply templates to tasks
2018-06-22 11:20:04 -07:00
parent ec15f3fab9
commit 75f00dfc60
71 changed files with 1059 additions and 321 deletions
@@ -1,13 +1,20 @@
 ---
 title: Accessing Clusters
 weight: 20
+content_template: templates/concept
 ---

+{{% capture overview %}}
+
+This topic discusses multiple ways to interact with clusters.
+
+{{% /capture %}}
+
 {{< toc >}}

-## Accessing the cluster API
+{{% capture body %}}

-### Accessing for the first time with kubectl
+## Accessing for the first time with kubectl

 When accessing the Kubernetes API for the first time, we suggest using the
 Kubernetes CLI, `kubectl`.
@@ -26,7 +33,7 @@ $ kubectl config view
 Many of the [examples](/docs/user-guide/kubectl-cheatsheet) provide an introduction to using
 kubectl and complete documentation is found in the [kubectl manual](/docs/user-guide/kubectl-overview).

-### Directly accessing the REST API
+## Directly accessing the REST API

 Kubectl handles locating and authenticating to the apiserver.
 If you want to directly access the REST API with an http client like
@@ -43,7 +50,7 @@ curl or wget, or a browser, there are several ways to locate and authenticate:
    - Works with some types of client code that are confused by using a proxy.
    - Need to import a root cert into your browser to protect against MITM.

-#### Using kubectl proxy
+### Using kubectl proxy

 The following command runs kubectl in a mode where it acts as a reverse proxy.  It handles
 locating the apiserver and authenticating.
@@ -67,27 +74,12 @@ $ curl http://localhost:8080/api/
 }
 ```

-#### Without kubectl proxy (before v1.3.x)

-It is possible to avoid using kubectl proxy by passing an authentication token
-directly to the apiserver, like this:
-
-```shell
-$ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ")
-$ TOKEN=$(kubectl config view | grep token | cut -f 2 -d ":" | tr -d " ")
-$ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure
-{
-  "versions": [
-    "v1"
-  ]
-}
-```
-
-#### Without kubectl proxy (post v1.3.x)
+### Without kubectl proxy

 In Kubernetes version 1.3 or later, `kubectl config view` no longer displays the token. Use `kubectl describe secret...` to get the token for the default service account, like this:

-``` shell
+```shell
 $ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ")
 $ TOKEN=$(kubectl describe secret $(kubectl get secrets | grep default | cut -f1 -d ' ') | grep -E '^token' | cut -f2 -d':' | tr -d '\t')
 $ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure
@@ -118,12 +110,12 @@ for this.  [Configuring Access to the API](/docs/admin/accessing-the-api)
 describes how a cluster admin can configure this.  Such approaches may conflict
 with future high-availability support.

-### Programmatic access to the API
+## Programmatic access to the API

 Kubernetes officially supports [Go](#go-client) and [Python](#python-client)
 client libraries.

-#### Go client
+### Go client

 * To get the library, run the following command: `go get k8s.io/client-go/<version number>/kubernetes`. See [https://github.com/kubernetes/client-go](https://github.com/kubernetes/client-go) to see which versions are supported.
 * Write an application atop of the client-go clients. Note that client-go defines its own API objects, so if needed, please import API definitions from client-go rather than from the main repository, e.g., `import "k8s.io/client-go/1.4/pkg/api/v1"` is correct.
@@ -133,19 +125,19 @@ as the kubectl CLI does to locate and authenticate to the apiserver. See this [e

 If the application is deployed as a Pod in the cluster, please refer to the [next section](#accessing-the-api-from-a-pod).

-#### Python client
+### Python client

 To use [Python client](https://github.com/kubernetes-client/python), run the following command: `pip install kubernetes`. See [Python Client Library page](https://github.com/kubernetes-client/python) for more installation options.

 The Python client can use the same [kubeconfig file](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/)
 as the kubectl CLI does to locate and authenticate to the apiserver. See this [example](https://github.com/kubernetes-client/python/tree/master/examples/example1.py).

-#### Other languages
+### Other languages

 There are [client libraries](/docs/reference/using-api/client-libraries/) for accessing the API from other languages.
 See documentation for other libraries for how they authenticate.

-### Accessing the API from a Pod
+## Accessing the API from a Pod

 When accessing the API from a pod, locating and authenticating
 to the apiserver are somewhat different.
@@ -275,7 +267,7 @@ The supported formats for the name segment of the URL are:
  }
 ```

-#### Using web browsers to access services running on the cluster
+### Using web browsers to access services running on the cluster

 You may be able to put an apiserver proxy url into the address bar of a browser. However:

@@ -334,3 +326,5 @@ There are several different proxies you may encounter when using Kubernetes:

 Kubernetes users will typically not need to worry about anything other than the first two types.  The cluster admin
 will typically ensure that the latter types are setup correctly.
+
+{{% /capture %}}
@@ -26,6 +26,14 @@ You need to have the [`kubectl`](/docs/tasks/tools/install-kubectl/) command-lin

 {{% /capture %}}

+{{< toc >}}
+
+{{% capture prerequisites %}}
+
+{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
+
+{{% /capture %}}
+
 {{% capture steps %}}

 ## Define clusters, users, and contexts
@@ -3,15 +3,30 @@ reviewers:
 - bprashanth
 - davidopp
 title: Configure Your Cloud Provider's Firewalls
+content_template: templates/task
 weight: 90
 ---

+{{% capture prerequisites %}}
+
 Many cloud providers (e.g. Google Compute Engine) define firewalls that help prevent inadvertent
 exposure to the internet.  When exposing a service to the external world, you may need to open up
 one or more ports in these firewalls to serve traffic.  This document describes this process, as
 well as any provider specific details that may be necessary.

-### Restrict Access For LoadBalancer Service
+{{% /capture %}}
+
+{{< toc >}}
+
+{{% capture prerequisites %}}
+
+{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
+
+{{% /capture %}}
+
+{{% capture steps %}}
+
+## Restrict Access For LoadBalancer Service

 When using a Service with `spec.type: LoadBalancer`, you can specify the IP ranges that are allowed to access the load balancer
 by using `spec.loadBalancerSourceRanges`. This field takes a list of IP CIDR ranges, which Kubernetes will use to configure firewall exceptions.
@@ -55,7 +70,7 @@ spec:
  - 130.211.204.2/32
 ```

-### Google Compute Engine
+## Google Compute Engine

 When using a Service with `spec.type: LoadBalancer`, the firewall will be
 opened automatically.  When using `spec.type: NodePort`, however, the firewall
@@ -69,11 +84,9 @@ You can add a firewall with the `gcloud` command line tool:
 gcloud compute firewall-rules create my-rule --allow=tcp:<port>
 ```

-**Note**
-There is one important security note when using firewalls on Google Compute Engine:
-
-as of Kubernetes v1.0.0, GCE firewalls are defined per-vm, rather than per-ip
-address.  This means that when you open a firewall for a service's ports,
+{{< note >}}
+**Note**: GCE firewalls are defined per-vm, rather than per-ip
+address. This means that when you open a firewall for a service's ports,
 anything that serves on that port on that VM's host IP address may potentially
 serve traffic.  Note that this is not a problem for other Kubernetes services,
 as they listen on IP addresses that are different than the host node's external
@@ -93,8 +106,6 @@ Consequently, please be careful when opening firewalls in Google Compute Engine
 or Google Kubernetes Engine.  You may accidentally be exposing other services to
 the wilds of the internet.

-This will be fixed in an upcoming release of Kubernetes.
+{{< /note >}}

-### Other cloud providers
-
-Coming soon.
+{{% /capture %}}
@@ -1,7 +1,13 @@
 ---
 title: Configure DNS for a Cluster
 weight: 120
+content_template: templates/concept
 ---

-Kubernetes offers a DNS cluster addon, which most of the supported environments enable by default. For more information on how to configure DNS for a Kubernetes cluster, see the [Kubernetes DNS sample plugin.](https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns)
+{{% capture overview %}}
+Kubernetes offers a DNS cluster addon, which most of the supported environments enable by default. 
+{{% /capture %}}
+{{% capture body %}}
+For more information on how to configure DNS for a Kubernetes cluster, see the [Kubernetes DNS sample plugin.](https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns)

+{{% /capture %}}
@@ -4,17 +4,24 @@ reviewers:
 - mikedanese
 - rf232
 title: Web UI (Dashboard)
+content_template: templates/concept
 weight: 10
 ---

+{{% capture overview %}}
+
 Dashboard is a web-based Kubernetes user interface. You can use Dashboard to deploy containerized applications to a Kubernetes cluster, troubleshoot your containerized application, and manage the cluster itself along with its attendant resources. You can use Dashboard to get an overview of applications running on your cluster, as well as for creating or modifying individual Kubernetes resources (such as Deployments, Jobs, DaemonSets, etc). For example, you can scale a Deployment, initiate a rolling update, restart a pod or deploy new applications using a deploy wizard.

 Dashboard also provides information on the state of Kubernetes resources in your cluster, and on any errors that may have occurred.

 ![Kubernetes Dashboard UI](/images/docs/ui-dashboard.png)

+{{% /capture %}}
+
 {{< toc >}}

+{{% capture body %}}
+
 ## Deploying the Dashboard UI

 The Dashboard UI is not deployed by default. To deploy it, run the following command:
@@ -165,7 +172,11 @@ Pod lists and detail pages link to logs viewer that is built into Dashboard. The

 ![Logs viewer](/images/docs/ui-dashboard-logs-view.png)

-## More information
+{{% /capture %}}
+
+{{% capture whatsnext %}}

 For more information, see the
 [Kubernetes Dashboard project page](https://github.com/kubernetes/dashboard).
+
+{{% /capture %}}