Skip to content

Commit 3ff7312

Browse files
author
Tim Bannister
committed
Add descriptions to Concept sections
Each section directly beneath Concepts gains a description.
1 parent 5c7e664 commit 3ff7312

File tree

16 files changed

+41
-61
lines changed

16 files changed

+41
-61
lines changed

content/en/docs/concepts/_index.md

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -12,61 +12,3 @@ The Concepts section helps you learn about the parts of the Kubernetes system an
1212

1313

1414
<!-- body -->
15-
16-
## Overview
17-
18-
To work with Kubernetes, you use *Kubernetes API objects* to describe your cluster's *desired state*: what applications or other workloads you want to run, what container images they use, the number of replicas, what network and disk resources you want to make available, and more. You set your desired state by creating objects using the Kubernetes API, typically via the command-line interface, `kubectl`. You can also use the Kubernetes API directly to interact with the cluster and set or modify your desired state.
19-
20-
Once you've set your desired state, the *Kubernetes Control Plane* makes the cluster's current state match the desired state via the Pod Lifecycle Event Generator ([PLEG](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/pod-lifecycle-event-generator.md)). To do so, Kubernetes performs a variety of tasks automatically--such as starting or restarting containers, scaling the number of replicas of a given application, and more. The Kubernetes Control Plane consists of a collection of processes running on your cluster:
21-
22-
* The **Kubernetes Master** is a collection of three processes that run on a single node in your cluster, which is designated as the master node. Those processes are: [kube-apiserver](/docs/admin/kube-apiserver/), [kube-controller-manager](/docs/admin/kube-controller-manager/) and [kube-scheduler](/docs/admin/kube-scheduler/).
23-
* Each individual non-master node in your cluster runs two processes:
24-
* **[kubelet](/docs/admin/kubelet/)**, which communicates with the Kubernetes Master.
25-
* **[kube-proxy](/docs/admin/kube-proxy/)**, a network proxy which reflects Kubernetes networking services on each node.
26-
27-
## Kubernetes objects
28-
29-
Kubernetes contains a number of abstractions that represent the state of your system: deployed containerized applications and workloads, their associated network and disk resources, and other information about what your cluster is doing. These abstractions are represented by objects in the Kubernetes API. See [Understanding Kubernetes objects](/docs/concepts/overview/working-with-objects/kubernetes-objects/#kubernetes-objects) for more details.
30-
31-
The basic Kubernetes objects include:
32-
33-
* [Pod](/docs/concepts/workloads/pods/pod-overview/)
34-
* [Service](/docs/concepts/services-networking/service/)
35-
* [Volume](/docs/concepts/storage/volumes/)
36-
* [Namespace](/docs/concepts/overview/working-with-objects/namespaces/)
37-
38-
Kubernetes also contains higher-level abstractions that rely on [controllers](/docs/concepts/architecture/controller/) to build upon the basic objects, and provide additional functionality and convenience features. These include:
39-
40-
* [Deployment](/docs/concepts/workloads/controllers/deployment/)
41-
* [DaemonSet](/docs/concepts/workloads/controllers/daemonset/)
42-
* [StatefulSet](/docs/concepts/workloads/controllers/statefulset/)
43-
* [ReplicaSet](/docs/concepts/workloads/controllers/replicaset/)
44-
* [Job](/docs/concepts/workloads/controllers/job/)
45-
46-
## Kubernetes Control Plane
47-
48-
The various parts of the Kubernetes Control Plane, such as the Kubernetes Master and kubelet processes, govern how Kubernetes communicates with your cluster. The Control Plane maintains a record of all of the Kubernetes Objects in the system, and runs continuous control loops to manage those objects' state. At any given time, the Control Plane's control loops will respond to changes in the cluster and work to make the actual state of all the objects in the system match the desired state that you provided.
49-
50-
For example, when you use the Kubernetes API to create a Deployment, you provide a new desired state for the system. The Kubernetes Control Plane records that object creation, and carries out your instructions by starting the required applications and scheduling them to cluster nodes--thus making the cluster's actual state match the desired state.
51-
52-
### Kubernetes Master
53-
54-
The Kubernetes master is responsible for maintaining the desired state for your cluster. When you interact with Kubernetes, such as by using the `kubectl` command-line interface, you're communicating with your cluster's Kubernetes master.
55-
56-
> The "master" refers to a collection of processes managing the cluster state. Typically all these processes run on a single node in the cluster, and this node is also referred to as the master. The master can also be replicated for availability and redundancy.
57-
58-
### Kubernetes Nodes
59-
60-
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.
61-
62-
63-
64-
65-
## {{% heading "whatsnext" %}}
66-
67-
68-
If you would like to write a concept page, see
69-
[Page Content Types](/docs/contribute/style/page-content-types/#concept)
70-
for information about the concept page types.
71-
72-
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Cluster Architecture"
33
weight: 30
4+
description: >
5+
The architectural concepts behind Kubernetes.
46
---
57

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Cluster Administration"
33
weight: 100
4+
description: >
5+
Lower-level detail relevant to creating or administering a Kubernetes cluster.
46
---
57

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Configuration"
33
weight: 80
4+
description: >
5+
Resources that Kubernetes provides for configuring Pods.
46
---
57

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
---
22
title: "Containers"
33
weight: 40
4+
description: Technology for packaging an application along with its runtime dependencies.
5+
reviewers:
6+
- erictune
7+
- thockin
8+
content_type: concept
49
---
510

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
title: Extending Kubernetes
33
weight: 110
4+
description: Different ways to change the behavior of your Kubernetes cluster.
45
---
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
title: "Overview"
33
weight: 20
4-
---
4+
description: Get a high-level outline of Kubernetes and the components it is built from.
5+
---

content/en/docs/concepts/overview/components.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ reviewers:
33
- lavalamp
44
title: Kubernetes Components
55
content_type: concept
6+
description: >
7+
A Kubernetes cluster consists of the components that represent the control plane
8+
and a set of machines called nodes.
69
weight: 20
710
card:
811
name: concepts

content/en/docs/concepts/overview/kubernetes-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ reviewers:
44
title: The Kubernetes API
55
content_type: concept
66
weight: 30
7+
description: >
8+
The Kubernetes API lets you query and manipulate the state of objects in Kubernetes.
9+
The core of Kubernetes' control plane is the API server and the HTTP API that it exposes. Users, the different parts of your cluster, and external components all communicate with one another through the API server.
710
card:
811
name: concepts
912
weight: 30

content/en/docs/concepts/overview/working-with-objects/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Working with Kubernetes Objects"
33
weight: 40
4+
description: >
5+
Kubernetes objects are persistent entities in the Kubernetes system. Kubernetes uses these entities to represent the state of your cluster.
6+
Learn about the Kubernetes object model and how to work with these objects.
47
---
5-

0 commit comments

Comments
 (0)