Permalink
Browse files

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
  • Loading branch information...
steveperry-53 authored and k8s-ci-robot committed Jun 22, 2018
1 parent ec15f3f commit 75f00dfc602cd4fd1ce2c37f77e0e70b9fa5c5cb
Showing with 1,059 additions and 321 deletions.
  1. +10 −1 content/en/docs/concepts/architecture/cloud-controller.md
  2. +9 −3 content/en/docs/concepts/architecture/master-node-communication.md
  3. +10 −3 content/en/docs/concepts/architecture/nodes.md
  4. +11 −1 content/en/docs/concepts/cluster-administration/addons.md
  5. +10 −2 content/en/docs/concepts/cluster-administration/certificates.md
  6. +14 −1 content/en/docs/concepts/cluster-administration/kubelet-garbage-collection.md
  7. +9 −0 content/en/docs/concepts/cluster-administration/logging.md
  8. +12 −1 content/en/docs/concepts/cluster-administration/manage-deployment.md
  9. +9 −3 content/en/docs/concepts/cluster-administration/networking.md
  10. +11 −0 content/en/docs/concepts/overview/kubernetes-api.md
  11. +9 −0 content/en/docs/concepts/overview/working-with-objects/labels.md
  12. +11 −0 content/en/docs/concepts/overview/working-with-objects/names.md
  13. +11 −0 content/en/docs/concepts/overview/working-with-objects/namespaces.md
  14. +9 −0 content/en/docs/concepts/policy/pod-security-policy.md
  15. +14 −1 content/en/docs/concepts/policy/resource-quotas.md
  16. +9 −0 content/en/docs/concepts/storage/persistent-volumes.md
  17. +9 −0 content/en/docs/concepts/storage/storage-classes.md
  18. +10 −3 content/en/docs/concepts/workloads/controllers/cron-jobs.md
  19. +10 −3 content/en/docs/concepts/workloads/controllers/daemonset.md
  20. +10 −3 content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md
  21. +10 −2 content/en/docs/concepts/workloads/pods/pod.md
  22. +21 −27 content/en/docs/tasks/access-application-cluster/access-cluster.md
  23. +8 −0 content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md
  24. +22 −11 content/en/docs/tasks/access-application-cluster/configure-cloud-provider-firewall.md
  25. +7 −1 content/en/docs/tasks/access-application-cluster/configure-dns-cluster.md
  26. +12 −1 content/en/docs/tasks/access-application-cluster/web-ui-dashboard.md
  27. +6 −0 content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md
  28. +10 −1 content/en/docs/tasks/administer-cluster/cluster-management.md
  29. +25 −4 content/en/docs/tasks/administer-cluster/configure-multiple-schedulers.md
  30. +18 −4 content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md
  31. +16 −2 content/en/docs/tasks/administer-cluster/cpu-management-policies.md
  32. +5 −0 content/en/docs/tasks/administer-cluster/declare-network-policy.md
  33. +11 −6 content/en/docs/tasks/administer-cluster/developing-cloud-controller-manager.md
  34. +6 −0 content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md
  35. +8 −0 content/en/docs/tasks/administer-cluster/encrypt-data.md
  36. +10 −3 content/en/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md
  37. +23 −2 content/en/docs/tasks/administer-cluster/highly-available-master.md
  38. +20 −4 content/en/docs/tasks/administer-cluster/namespaces-walkthrough.md
  39. +10 −1 content/en/docs/tasks/administer-cluster/out-of-resource.md
  40. +20 −1 content/en/docs/tasks/administer-cluster/reserve-compute-resources.md
  41. +11 −4 content/en/docs/tasks/administer-cluster/running-cloud-controller.md
  42. +12 −1 content/en/docs/tasks/administer-cluster/static-pod.md
  43. +4 −3 content/en/docs/tasks/administer-federation/deployment.md
  44. +9 −1 content/en/docs/tasks/administer-federation/events.md
  45. +14 −9 content/en/docs/tasks/administer-federation/secret.md
  46. +16 −0 content/en/docs/tasks/configure-pod-container/configure-service-account.md
  47. +130 −111 content/en/docs/tasks/configure-pod-container/translate-compose-kubernetes.md
  48. +17 −6 content/en/docs/tasks/debug-application-cluster/audit.md
  49. +11 −0 content/en/docs/tasks/debug-application-cluster/core-metrics-pipeline.md
  50. +15 −2 content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md
  51. +12 −1 content/en/docs/tasks/debug-application-cluster/debug-application.md
  52. +11 −0 content/en/docs/tasks/debug-application-cluster/debug-cluster.md
  53. +9 −3 content/en/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md
  54. +15 −5 content/en/docs/tasks/debug-application-cluster/debug-service.md
  55. +11 −2 content/en/docs/tasks/debug-application-cluster/events-stackdriver.md
  56. +12 −0 content/en/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana.md
  57. +14 −1 content/en/docs/tasks/debug-application-cluster/logging-stackdriver.md
  58. +18 −3 content/en/docs/tasks/debug-application-cluster/monitor-node-health.md
  59. +12 −5 content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md
  60. +11 −0 content/en/docs/tasks/debug-application-cluster/troubleshooting.md
  61. +48 −30 content/en/docs/tasks/federation/federation-service-discovery.md
  62. +16 −2 content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md
  63. +17 −2 content/en/docs/tasks/inject-data-application/podpreset.md
  64. +23 −4 content/en/docs/tasks/job/coarse-parallel-processing-work-queue.md
  65. +27 −5 content/en/docs/tasks/job/fine-parallel-processing-work-queue.md
  66. +10 −3 content/en/docs/tasks/job/parallel-processing-expansion.md
  67. +11 −0 content/en/docs/tasks/manage-gpus/scheduling-gpus.md
  68. +24 −6 content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md
  69. +13 −6 content/en/docs/tasks/run-application/horizontal-pod-autoscale.md
  70. +10 −3 content/en/docs/tasks/run-application/rolling-update-replication-controller.md
  71. +21 −8 content/en/docs/tasks/tls/managing-tls-in-a-cluster.md
@@ -1,9 +1,10 @@
---
title: Concepts Underlying the Cloud Controller Manager
content_template: templates/concept
weight: 30
---
## Cloud Controller Manager
{{% capture overview %}}
The cloud controller manager (CCM) concept (not to be confused with the binary) was originally created to allow cloud specific vendor code and the Kubernetes core to evolve independent of one another. The cloud controller manager runs alongside other master components such as the Kubernetes controller manager, the API server, and scheduler. It can also be started as a Kubernetes addon, in which case it runs on top of Kubernetes.
@@ -15,6 +16,12 @@ Here's the architecture of a Kubernetes cluster without the cloud controller man
![Pre CCM Kube Arch](/images/docs/pre-ccm-arch.png)
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## Design
In the preceding diagram, Kubernetes and the cloud provider are integrated through several different components:
@@ -254,3 +261,5 @@ The following cloud providers have implemented CCMs:
Complete instructions for configuring and running the CCM are provided
[here](/docs/tasks/administer-cluster/running-cloud-controller/#cloud-controller-manager).
{{% /capture %}}
@@ -4,19 +4,24 @@ reviewers:
- roberthbailey
- liggitt
title: Master-Node communication
content_template: templates/concept
weight: 20
---
{{< toc >}}
## Overview
{{% capture overview %}}
This document catalogs the communication paths between the master (really the
apiserver) and the Kubernetes cluster. The intent is to allow users to
customize their installation to harden the network configuration such that
the cluster can be run on an untrusted network (or on fully public IPs on a
cloud provider).
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## Cluster -> Master
All communication paths from the cluster to the master terminate at the
@@ -91,3 +96,4 @@ connection will be encrypted, it will not provide any guarantees of integrity.
These connections **are not currently safe** to run over untrusted and/or
public networks.
{{% /capture %}}
@@ -3,12 +3,11 @@ reviewers:
- caesarxuchao
- dchen1107
title: Nodes
content_template: templates/concept
weight: 10
---
{{< toc >}}
## What is a node?
{{% capture overview %}}
A `node` is a worker machine in Kubernetes, previously known as a `minion`. A node
may be a VM or physical machine, depending on the cluster. Each node has
@@ -17,6 +16,12 @@ components. The services on a node include Docker, kubelet and kube-proxy. See
[The Kubernetes Node](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md#the-kubernetes-node) section in the
architecture design doc for more details.
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## Node Status
A node's status contains the following information:
@@ -279,3 +284,5 @@ on each kubelet where you want to reserve resources.
Node is a top-level resource in the Kubernetes REST API. More details about the
API object can be found at:
[Node API object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#node-v1-core).
{{% /capture %}}
@@ -1,15 +1,23 @@
---
title: Installing Addons
content_template: templates/concept
---
## Overview
{{% capture overview %}}
Add-ons extend the functionality of Kubernetes.
This page lists some of the available add-ons and links to their respective installation instructions.
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/).
{{< toc >}}
{{% /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 %}}
@@ -2,9 +2,12 @@
reviewers:
- chenopis
title: The Kubernetes API
content_template: templates/concept
weight: 30
---
{{% capture overview %}}
Overall API conventions are described in the [API conventions doc](https://git.k8s.io/community/contributors/devel/api-conventions.md).
API endpoints, resource types and samples are described in [API Reference](/docs/reference).
@@ -17,6 +20,12 @@ Kubernetes also stores its serialized state (currently in [etcd](https://coreos.
Kubernetes itself is decomposed into multiple components, which interact through its API.
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## API changes
In our experience, any system that is successful needs to grow and change as new use cases emerge or existing ones change. Therefore, we expect the Kubernetes API to continuously change and grow. However, we intend to not break compatibility with existing clients, for an extended period of time. In general, new API resources and new resource fields can be expected to be added frequently. Elimination of resources or fields will require following the [API deprecation policy](/docs/reference/using-api/deprecation-policy/).
@@ -121,3 +130,5 @@ DaemonSets, Deployments, HorizontalPodAutoscalers, Ingress, Jobs and ReplicaSets
Other extensions resources can be enabled by setting `--runtime-config` on
apiserver. `--runtime-config` accepts comma separated values. For example: to disable deployments and ingress, set
`--runtime-config=extensions/v1beta1/deployments=false,extensions/v1beta1/ingress=false`
{{% /capture %}}
@@ -2,9 +2,12 @@
reviewers:
- mikedanese
title: Labels and Selectors
content_template: templates/concept
weight: 40
---
{{% capture overview %}}
_Labels_ are key/value pairs that are attached to objects, such as pods.
Labels are intended to be used to specify identifying attributes of objects that are meaningful and relevant to users, but do not directly imply semantics to the core system.
Labels can be used to organize and to select subsets of objects. Labels can be attached to objects at creation time and subsequently added and modified at any time.
@@ -21,8 +24,12 @@ Each object can have a set of key/value labels defined. Each Key must be unique
We'll eventually index and reverse-index labels for efficient queries and watches, use them to sort and group in UIs and CLIs, etc. We don't want to pollute labels with non-identifying, especially large and/or structured, data. Non-identifying information should be recorded using [annotations](/docs/concepts/overview/working-with-objects/annotations/).
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## Motivation
Labels enable users to map their own organizational structures onto system objects in a loosely coupled fashion, without requiring clients to store these mappings.
@@ -194,3 +201,5 @@ selector:
One use case for selecting over labels is to constrain the set of nodes onto which a pod can schedule.
See the documentation on [node selection](/docs/concepts/configuration/assign-pod-node/) for more information.
{{% /capture %}}
@@ -3,15 +3,24 @@ reviewers:
- mikedanese
- thockin
title: Names
content_template: templates/concept
weight: 20
---
{{% capture overview %}}
All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID.
For non-unique user-provided attributes, Kubernetes provides [labels](/docs/user-guide/labels) and [annotations](/docs/concepts/overview/working-with-objects/annotations/).
See the [identifiers design doc](https://git.k8s.io/community/contributors/design-proposals/architecture/identifiers.md) for the precise syntax rules for Names and UIDs.
{{% /capture %}}
{{< toc >}}
{{% capture body %}}
## Names
{{< glossary_definition term_id="name" length="all" >}}
@@ -21,3 +30,5 @@ By convention, the names of Kubernetes resources should be up to maximum length
## UIDs
{{< glossary_definition term_id="uid" length="all" >}}
{{% /capture %}}
Oops, something went wrong.

0 comments on commit 75f00df

Please sign in to comment.