Skip to content

Commit

Permalink
add en pages
Browse files Browse the repository at this point in the history
  • Loading branch information
kbhawkey committed Jun 9, 2020
1 parent 1502e02 commit ecc27bb
Show file tree
Hide file tree
Showing 347 changed files with 2,900 additions and 2,537 deletions.
15 changes: 8 additions & 7 deletions content/en/docs/concepts/_index.md
@@ -1,17 +1,17 @@
---
title: Concepts
main_menu: true
content_template: templates/concept
content_type: concept
weight: 40
---

{{% capture overview %}}
<!-- overview -->

The Concepts section helps you learn about the parts of the Kubernetes system and the abstractions Kubernetes uses to represent your {{< glossary_tooltip text="cluster" term_id="cluster" length="all" >}}, and helps you obtain a deeper understanding of how Kubernetes works.

{{% /capture %}}

{{% capture body %}}

<!-- body -->

## Overview

Expand Down Expand Up @@ -60,12 +60,13 @@ The Kubernetes master is responsible for maintaining the desired state for your
The nodes in a cluster are the machines (VMs, physical servers, etc) that run your applications and cloud workflows. The Kubernetes master controls each node; you'll rarely interact with nodes directly.


{{% /capture %}}

{{% capture whatsnext %}}

## {{% heading "whatsnext" %}}


If you would like to write a concept page, see
[Using Page Templates](/docs/home/contribute/page-templates/)
for information about the concept page type and the concept template.

{{% /capture %}}

14 changes: 7 additions & 7 deletions content/en/docs/concepts/architecture/cloud-controller.md
@@ -1,10 +1,10 @@
---
title: Cloud Controller Manager
content_template: templates/concept
content_type: concept
weight: 40
---

{{% capture overview %}}
<!-- overview -->

{{< feature-state state="beta" for_k8s_version="v1.11" >}}

Expand All @@ -17,9 +17,9 @@ components.
The cloud-controller-manager is structured using a plugin
mechanism that allows different cloud providers to integrate their platforms with Kubernetes.

{{% /capture %}}

{{% capture body %}}

<!-- body -->

## Design

Expand Down Expand Up @@ -200,8 +200,9 @@ rules:
- update
```

{{% /capture %}}
{{% capture whatsnext %}}

## {{% heading "whatsnext" %}}

[Cloud Controller Manager Administration](/docs/tasks/administer-cluster/running-cloud-controller/#cloud-controller-manager)
has instructions on running and managing the cloud controller manager.

Expand All @@ -212,4 +213,3 @@ The cloud controller manager uses Go interfaces to allow implementations from an
The implementation of the shared controllers highlighted in this document (Node, Route, and Service), and some scaffolding along with the shared cloudprovider interface, is part of the Kubernetes core. Implementations specific to cloud providers are outside the core of Kubernetes and implement the `CloudProvider` interface.

For more information about developing plugins, see [Developing Cloud Controller Manager](/docs/tasks/administer-cluster/developing-cloud-controller-manager/).
{{% /capture %}}
Expand Up @@ -3,19 +3,19 @@ reviewers:
- dchen1107
- liggitt
title: Control Plane-Node Communication
content_template: templates/concept
content_type: concept
weight: 20
aliases:
- master-node-communication
---

{{% capture overview %}}
<!-- overview -->

This document catalogs the communication paths between the control plane (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 %}}

{{% capture body %}}

<!-- body -->

## Node to Control Plane
All communication paths from the nodes to the control plane terminate at the apiserver (none of the other master components are designed to expose remote services). In a typical deployment, the apiserver is configured to listen for remote connections on a secure HTTPS port (443) with one or more forms of client [authentication](/docs/reference/access-authn-authz/authentication/) enabled.
Expand Down
15 changes: 8 additions & 7 deletions content/en/docs/concepts/architecture/controller.md
@@ -1,10 +1,10 @@
---
title: Controllers
content_template: templates/concept
content_type: concept
weight: 30
---

{{% capture overview %}}
<!-- overview -->

In robotics and automation, a _control loop_ is
a non-terminating loop that regulates the state of a system.
Expand All @@ -18,10 +18,10 @@ closer to the desired state, by turning equipment on or off.

{{< glossary_definition term_id="controller" length="short">}}

{{% /capture %}}


{{% capture body %}}

<!-- body -->

## Controller pattern

Expand Down Expand Up @@ -150,11 +150,12 @@ You can run your own controller as a set of Pods,
or externally to Kubernetes. What fits best will depend on what that particular
controller does.

{{% /capture %}}

{{% capture whatsnext %}}

## {{% heading "whatsnext" %}}

* Read about the [Kubernetes control plane](/docs/concepts/#kubernetes-control-plane)
* Discover some of the basic [Kubernetes objects](/docs/concepts/#kubernetes-objects)
* Learn more about the [Kubernetes API](/docs/concepts/overview/kubernetes-api/)
* If you want to write your own controller, see [Extension Patterns](/docs/concepts/extend-kubernetes/extend-cluster/#extension-patterns) in Extending Kubernetes.
{{% /capture %}}

15 changes: 8 additions & 7 deletions content/en/docs/concepts/architecture/nodes.md
Expand Up @@ -3,11 +3,11 @@ reviewers:
- caesarxuchao
- dchen1107
title: Nodes
content_template: templates/concept
content_type: concept
weight: 10
---

{{% capture overview %}}
<!-- overview -->

Kubernetes runs your workload by placing containers into Pods to run on _Nodes_.
A node may be a virtual or physical machine, depending on the cluster. Each node
Expand All @@ -23,9 +23,9 @@ The [components](/docs/concepts/overview/components/#node-components) on a node
{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}, and the
{{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}}.

{{% /capture %}}

{{% capture body %}}

<!-- body -->

## Management

Expand Down Expand Up @@ -332,12 +332,13 @@ the kubelet can use topology hints when making resource assignment decisions.
See [Control Topology Management Policies on a Node](/docs/tasks/administer-cluster/topology-manager/)
for more information.

{{% /capture %}}
{{% capture whatsnext %}}

## {{% heading "whatsnext" %}}

* Learn about the [components](/docs/concepts/overview/components/#node-components) that make up a node.
* Read the [API definition for Node](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#node-v1-core).
* Read the [Node](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md#the-kubernetes-node)
section of the architecture design document.
* Read about [taints and tolerations](/docs/concepts/configuration/taint-and-toleration/).
* Read about [cluster autoscaling](/docs/tasks/administer-cluster/cluster-management/#cluster-autoscaling).
{{% /capture %}}

10 changes: 5 additions & 5 deletions content/en/docs/concepts/cluster-administration/addons.md
@@ -1,9 +1,9 @@
---
title: Installing Addons
content_template: templates/concept
content_type: concept
---

{{% capture overview %}}
<!-- overview -->


Add-ons extend the functionality of Kubernetes.
Expand All @@ -12,10 +12,10 @@ 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 %}}


{{% capture body %}}

<!-- body -->

## Networking and Network Policy

Expand Down Expand Up @@ -55,4 +55,4 @@ There are several other add-ons documented in the deprecated [cluster/addons](ht

Well-maintained ones should be linked to here. PRs welcome!

{{% /capture %}}

10 changes: 5 additions & 5 deletions content/en/docs/concepts/cluster-administration/certificates.md
@@ -1,19 +1,19 @@
---
title: Certificates
content_template: templates/concept
content_type: concept
weight: 20
---


{{% capture overview %}}
<!-- overview -->

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

{{% /capture %}}


{{% capture body %}}

<!-- body -->

### easyrsa

Expand Down Expand Up @@ -249,4 +249,4 @@ 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 %}}

@@ -1,16 +1,16 @@
---
title: Cloud Providers
content_template: templates/concept
content_type: concept
weight: 30
---

{{% capture overview %}}
<!-- overview -->
This page explains how to manage Kubernetes running on a specific
cloud provider.
{{% /capture %}}


{{% capture body %}}

<!-- body -->
### kubeadm
[kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/) is a popular option for creating kubernetes clusters.
kubeadm has configuration options to specify configuration information for cloud providers. For example a typical
Expand Down Expand Up @@ -363,7 +363,7 @@ Kubernetes network plugin and should appear in the `[Route]` section of the

[kubenet]: /docs/concepts/cluster-administration/network-plugins/#kubenet

{{% /capture %}}


## OVirt

Expand Down
Expand Up @@ -3,16 +3,16 @@ reviewers:
- davidopp
- lavalamp
title: Cluster Administration Overview
content_template: templates/concept
content_type: concept
weight: 10
---

{{% capture overview %}}
<!-- overview -->
The cluster administration overview is for anyone creating or administering a Kubernetes cluster.
It assumes some familiarity with core Kubernetes [concepts](/docs/concepts/).
{{% /capture %}}

{{% capture body %}}

<!-- body -->
## Planning a cluster

See the guides in [Setup](/docs/setup/) for examples of how to plan, set up, and configure Kubernetes clusters. The solutions listed in this article are called *distros*.
Expand Down Expand Up @@ -68,6 +68,6 @@ Note: Not all distros are actively maintained. Choose distros which have been te

* [Logging and Monitoring Cluster Activity](/docs/concepts/cluster-administration/logging/) explains how logging in Kubernetes works and how to implement it.

{{% /capture %}}



14 changes: 7 additions & 7 deletions content/en/docs/concepts/cluster-administration/flow-control.md
@@ -1,10 +1,10 @@
---
title: API Priority and Fairness
content_template: templates/concept
content_type: concept
min-kubernetes-server-version: v1.18
---

{{% capture overview %}}
<!-- overview -->

{{< feature-state state="alpha" for_k8s_version="v1.18" >}}

Expand Down Expand Up @@ -33,9 +33,9 @@ the `--max-requests-inflight` flag without the API Priority and
Fairness feature enabled.
{{< /caution >}}

{{% /capture %}}

{{% capture body %}}

<!-- body -->

## Enabling API Priority and Fairness

Expand Down Expand Up @@ -366,13 +366,13 @@ poorly-behaved workloads that may be harming system health.
request and the PriorityLevel to which it was assigned.


{{% /capture %}}

{{% capture whatsnext %}}

## {{% heading "whatsnext" %}}


For background information on design details for API priority and fairness, see
the [enhancement proposal](https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/20190228-priority-and-fairness.md).
You can make suggestions and feature requests via [SIG API
Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery).

{{% /capture %}}
@@ -1,20 +1,20 @@
---
reviewers:
title: Configuring kubelet Garbage Collection
content_template: templates/concept
content_type: concept
weight: 70
---

{{% capture overview %}}
<!-- 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 %}}


{{% capture body %}}

<!-- body -->

## Image Collection

Expand Down Expand Up @@ -77,10 +77,11 @@ 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 %}}

## {{% heading "whatsnext" %}}


See [Configuring Out Of Resource Handling](/docs/tasks/administer-cluster/out-of-resource/) for more details.

{{% /capture %}}

0 comments on commit ecc27bb

Please sign in to comment.