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,8 +1,10 @@
 ---
 title: Installing Addons
+content_template: templates/concept
 ---

-## Overview
+{{% capture overview %}}
+

 Add-ons extend the functionality of Kubernetes.

@@ -10,6 +12,12 @@ This page lists some of the available add-ons and links to their respective inst

 Add-ons in each section are sorted alphabetically - the ordering does not imply any preferential status.

+{{% /capture %}}
+
+{{< toc >}}
+
+{{% capture body %}}
+
 ## Networking and Network Policy


@@ -40,3 +48,5 @@ Add-ons in each section are sorted alphabetically - the ordering does not imply
 There are several other add-ons documented in the deprecated [cluster/addons](https://git.k8s.io/kubernetes/cluster/addons) directory.

 Well-maintained ones should be linked to here. PRs welcome!
+
+{{% /capture %}}
@@ -1,15 +1,21 @@
 ---
 title: Certificates
+content_template: templates/concept
 weight: 20
 ---

-{{< toc >}}

-## Creating Certificates
+{{% capture overview %}}

 When using client certificate authentication, you can generate certificates
 manually through `easyrsa`, `openssl` or `cfssl`.

+{{% /capture %}}
+
+{{< toc >}}
+
+{{% capture body %}}
+
 ### easyrsa

 **easyrsa** can manually generate certificates for your cluster.
@@ -239,3 +245,5 @@ done.
 You can use the `certificates.k8s.io` API to provision
 x509 certificates to use for authentication as documented
 [here](/docs/tasks/tls/managing-tls-in-a-cluster).
+
+{{% /capture %}}
@@ -2,15 +2,22 @@
 reviewers:
 - mikedanese
 title: Configuring kubelet Garbage Collection
+content_template: templates/concept
 weight: 70
 ---

-{{< toc >}}
+{{% capture overview %}}

 Garbage collection is a helpful function of kubelet that will clean up unused images and unused containers. Kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes.

 External garbage collection tools are not recommended as these tools can potentially break the behavior of kubelet by removing containers expected to exist.

+{{% /capture %}}
+
+{{< toc >}}
+
+{{% capture body %}}
+
 ## Image Collection

 Kubernetes manages lifecycle of all images through imageManager, with the cooperation
@@ -72,4 +79,10 @@ Including:
 | `--low-diskspace-threshold-mb` | `--eviction-hard` or `eviction-soft` | eviction generalizes disk thresholds to other resources |
 | `--outofdisk-transition-frequency` | `--eviction-pressure-transition-period` | eviction generalizes disk pressure transition to other resources |

+{{% /capture %}}
+
+{{% capture whatsnext %}}
+
 See [Configuring Out Of Resource Handling](/docs/tasks/administer-cluster/out-of-resource/) for more details.
+
+{{% /capture %}}
@@ -3,15 +3,22 @@ reviewers:
 - piosz
 - x13n
 title: Logging Architecture
+content_template: templates/concept
 weight: 60
 ---

+{{% capture overview %}}
+
 Application and systems logs can help you understand what is happening inside your cluster. The logs are particularly useful for debugging problems and monitoring cluster activity. Most modern applications have some kind of logging mechanism; as such, most container engines are likewise designed to support some kind of logging. The easiest and most embraced logging method for containerized applications is to write to the standard output and standard error streams.

 However, the native functionality provided by a container engine or runtime is usually not enough for a complete logging solution. For example, if a container crashes, a pod is evicted, or a node dies, you'll usually still want to access your application's logs. As such, logs should have a separate storage and lifecycle independent of nodes, pods, or containers. This concept is called _cluster-level-logging_. Cluster-level logging requires a separate backend to store, analyze, and query logs. Kubernetes provides no native storage solution for log data, but you can integrate many existing logging solutions into your Kubernetes cluster.

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

+{{% capture body %}}
+
 Cluster-level logging architectures are described in assumption that
 a logging backend is present inside or outside of your cluster. If you're
 not interested in having cluster-level logging, you might still find
@@ -243,3 +250,5 @@ container.
 You can implement cluster-level logging by exposing or pushing logs directly from
 every application; however, the implementation for such a logging mechanism
 is outside the scope of Kubernetes.
+
+{{% /capture %}}
@@ -4,13 +4,20 @@ reviewers:
 - janetkuo
 - mikedanese
 title: Managing Resources
+content_template: templates/concept
 weight: 40
 ---

+{{% capture overview %}}
+
 You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features that we will discuss in more depth are [configuration files](/docs/concepts/configuration/overview/) and [labels](/docs/concepts/overview/working-with-objects/labels/).

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

+{{% capture body %}}
+
 ## Organizing resource configurations

 Many applications require multiple resources to be created, such as a Deployment and a Service. Management of multiple resources can be simplified by grouping them together in the same file (separated by `---` in YAML). For example:
@@ -391,7 +398,11 @@ $ kubectl edit deployment/my-nginx

 That's it! The Deployment will declaratively update the deployed nginx application progressively behind the scene. It ensures that only a certain number of old replicas may be down while they are being updated, and only a certain number of new replicas may be created above the desired number of pods. To learn more details about it, visit [Deployment page](/docs/concepts/workloads/controllers/deployment/).

-## What's next?
+{{% /capture %}}
+
+{{% capture whatsnext %}}

 - [Learn about how to use `kubectl` for application introspection and debugging.](/docs/tasks/debug-application-cluster/debug-application-introspection/)
 - [Configuration Best Practices and Tips](/docs/concepts/configuration/overview/)
+
+{{% /capture %}}
@@ -2,9 +2,11 @@
 reviewers:
 - thockin
 title: Cluster Networking
+content_template: templates/concept
 weight: 50
 ---

+{{% capture overview %}}
 Kubernetes approaches networking somewhat differently than Docker does by
 default.  There are 4 distinct networking problems to solve:

@@ -14,10 +16,11 @@ default.  There are 4 distinct networking problems to solve:
 3. Pod-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/).
 4. External-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/).

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

-
-## Summary
+{{% capture body %}}

 Kubernetes assumes that pods can communicate with other pods, regardless of
 which host they land on.  Every pod gets its own IP address so you do not
@@ -266,9 +269,12 @@ Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-pl
 or stand-alone.  In either version, it doesn't require any configuration or extra code
 to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes.

+{{% /capture %}}

-## Other reading
+{{% capture whatsnext %}}

 The early design of the networking model and its rationale, and some future
 plans are described in more detail in the [networking design
 document](https://git.k8s.io/community/contributors/design-proposals/network/networking.md).
+
+{{% /capture %}}