Skip to content

Commit 1e0c500

Browse files
committed
add content_type param, kubeadm pages
add no_list, clean up toc-hide params
1 parent 14b7c11 commit 1e0c500

20 files changed

+79
-84
lines changed
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: Accessing the API
33
weight: 20
4-
toc-hide: true
54
---
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: Command line tools reference
33
weight: 60
4-
toc-hide: true
54
---
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: Kubernetes Issues and Security
33
weight: 10
4-
toc-hide: true
54
---
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: Setup tools reference
33
weight: 50
4-
toc-hide: true
54
---
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: "Kubeadm"
33
weight: 10
4-
toc-hide: true
4+
no_list: true
55
---

content/en/docs/reference/setup-tools/kubeadm/implementation-details.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ However, it might not be obvious _how_ kubeadm does that.
1515

1616
This document provides additional details on what happen under the hood, with the aim of sharing knowledge on Kubernetes cluster best practices.
1717

18-
1918
<!-- body -->
2019
## Core design principles
2120

@@ -518,6 +517,7 @@ Please note that:
518517
- The automatic CSR approval is managed by the csrapprover controller, according with configuration done the `kubeadm init` process
519518

520519
### (optional) Write init kubelet configuration
520+
521521
{{< feature-state for_k8s_version="v1.9" state="alpha" >}}
522522

523523
If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig`:
@@ -530,5 +530,3 @@ If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig`:
530530
Please note that:
531531

532532
1. To make dynamic kubelet configuration work, flag `--dynamic-config-dir=/var/lib/kubelet/config/dynamic` should be specified in `/etc/systemd/system/kubelet.service.d/10-kubeadm.conf`
533-
534-

content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ reviewers:
33
- luxas
44
- jbeda
55
title: kubeadm alpha
6+
content_type: concept
67
weight: 90
78
---
9+
810
{{< caution >}}
911
`kubeadm alpha` provides a preview of a set of features made available for gathering feedback
1012
from the community. Please try it out and give us feedback!
@@ -67,7 +69,6 @@ Use the following command to enable the DynamicKubeletConfiguration feature.
6769
{{< tab name="enable-dynamic" include="generated/kubeadm_alpha_kubelet_config_enable-dynamic.md" />}}
6870
{{< /tabs >}}
6971

70-
7172
## kubeadm alpha selfhosting pivot {#cmd-selfhosting}
7273

7374
The subcommand `pivot` can be used to convert a static Pod-hosted control plane into a self-hosted one.
@@ -79,8 +80,8 @@ The subcommand `pivot` can be used to convert a static Pod-hosted control plane
7980
{{< tab name="pivot" include="generated/kubeadm_alpha_selfhosting_pivot.md" />}}
8081
{{< /tabs >}}
8182

83+
## {{% heading "whatsnext" %}}
8284

83-
## What's next
8485
* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node
8586
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster
8687
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`

content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ title: kubeadm config
66
content_type: concept
77
weight: 50
88
---
9+
910
<!-- overview -->
1011
During `kubeadm init`, kubeadm uploads the `ClusterConfiguration` object to your cluster
1112
in a ConfigMap called `kubeadm-config` in the `kube-system` namespace. This configuration is then read during
@@ -19,30 +20,31 @@ In Kubernetes v1.13.0 and later to list/pull kube-dns images instead of the Core
1920
the `--config` method described [here](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon)
2021
has to be used.
2122

22-
23-
2423
<!-- body -->
2524
## kubeadm config view {#cmd-config-view}
25+
2626
{{< include "generated/kubeadm_config_view.md" >}}
2727

2828
## kubeadm config print init-defaults {#cmd-config-print-init-defaults}
29+
2930
{{< include "generated/kubeadm_config_print_init-defaults.md" >}}
3031

3132
## kubeadm config print join-defaults {#cmd-config-print-join-defaults}
33+
3234
{{< include "generated/kubeadm_config_print_join-defaults.md" >}}
3335

3436
## kubeadm config migrate {#cmd-config-migrate}
37+
3538
{{< include "generated/kubeadm_config_migrate.md" >}}
3639

3740
## kubeadm config images list {#cmd-config-images-list}
41+
3842
{{< include "generated/kubeadm_config_images_list.md" >}}
3943

4044
## kubeadm config images pull {#cmd-config-images-pull}
41-
{{< include "generated/kubeadm_config_images_pull.md" >}}
42-
4345

46+
{{< include "generated/kubeadm_config_images_pull.md" >}}
4447

4548
## {{% heading "whatsnext" %}}
4649

4750
* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/) to upgrade a Kubernetes cluster to a newer version
48-

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init-phase.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: kubeadm init phase
33
weight: 90
4+
content_type: concept
45
---
6+
57
`kubeadm init phase` enables you to invoke atomic steps of the bootstrap process.
68
Hence, you can let kubeadm do some of the work and you can fill in the gaps
79
if you wish to apply customization.
@@ -80,7 +82,6 @@ Use the following phase to create a local etcd instance based on a static Pod fi
8082
{{< tab name="local" include="generated/kubeadm_init_phase_etcd_local.md" />}}
8183
{{< /tabs >}}
8284

83-
8485
## kubeadm init phase upload-config {#cmd-phase-upload-config}
8586

8687
You can use this command to upload the kubeadm configuration to your cluster.
@@ -93,7 +94,6 @@ Alternatively, you can use [kubeadm config](/docs/reference/setup-tools/kubeadm/
9394
{{< tab name="kubelet" include="generated/kubeadm_init_phase_upload-config_kubelet.md" />}}
9495
{{< /tabs >}}
9596

96-
9797
## kubeadm init phase upload-certs {#cmd-phase-upload-certs}
9898

9999
Use the following phase to upload control-plane certificates to the cluster.
@@ -103,7 +103,6 @@ By default the certs and encryption key expire after two hours.
103103
{{< tab name="upload-certs" include="generated/kubeadm_init_phase_upload-certs.md" />}}
104104
{{< /tabs >}}
105105

106-
107106
## kubeadm init phase mark-control-plane {#cmd-phase-mark-control-plane}
108107

109108
Use the following phase to label and taint the node with the `node-role.kubernetes.io/master=""` key-value pair.
@@ -112,7 +111,6 @@ Use the following phase to label and taint the node with the `node-role.kubernet
112111
{{< tab name="mark-control-plane" include="generated/kubeadm_init_phase_mark-control-plane.md" />}}
113112
{{< /tabs >}}
114113

115-
116114
## kubeadm init phase bootstrap-token {#cmd-phase-bootstrap-token}
117115

118116
Use the following phase to configure bootstrap tokens.
@@ -156,7 +154,8 @@ Please note that kube-dns usage with kubeadm is deprecated as of v1.18 and will
156154
For more details on each field in the `v1beta2` configuration you can navigate to our
157155
[API reference pages.] (http://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2)
158156

159-
## What's next
157+
## {{% heading "whatsnext" %}}
158+
160159
* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node
161160
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster
162161
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ weight: 20
99
<!-- overview -->
1010
This command initializes a Kubernetes control-plane node.
1111

12-
1312
<!-- body -->
1413

1514
{{< include "generated/kubeadm_init.md" >}}
1615

1716
### Init workflow {#init-workflow}
17+
1818
`kubeadm init` bootstraps a Kubernetes control-plane node by executing the
1919
following steps:
2020

@@ -166,7 +166,7 @@ to download the certificates when additional control-plane nodes are joining, by
166166

167167
The following phase command can be used to re-upload the certificates after expiration:
168168

169-
```
169+
```shell
170170
kubeadm init phase upload-certs --upload-certs --certificate-key=SOME_VALUE --config=SOME_YAML_FILE
171171
```
172172

@@ -175,7 +175,7 @@ If the flag `--certificate-key` is not passed to `kubeadm init` and
175175

176176
The following command can be used to generate a new key on demand:
177177

178-
```
178+
```shell
179179
kubeadm alpha certs certificate-key
180180
```
181181

@@ -226,26 +226,26 @@ token distribution for easier automation. To implement this automation, you must
226226
know the IP address that the control-plane node will have after it is started,
227227
or use a DNS name or an address of a load balancer.
228228

229-
1. Generate a token. This token must have the form `<6 character string>.<16
230-
character string>`. More formally, it must match the regex:
231-
`[a-z0-9]{6}\.[a-z0-9]{16}`.
229+
1. Generate a token. This token must have the form `<6 character string>.<16
230+
character string>`. More formally, it must match the regex:
231+
`[a-z0-9]{6}\.[a-z0-9]{16}`.
232232

233-
kubeadm can generate a token for you:
233+
kubeadm can generate a token for you:
234234

235-
```shell
235+
```shell
236236
kubeadm token generate
237-
```
237+
```
238238

239-
1. Start both the control-plane node and the worker nodes concurrently with this token.
240-
As they come up they should find each other and form the cluster. The same
241-
`--token` argument can be used on both `kubeadm init` and `kubeadm join`.
239+
1. Start both the control-plane node and the worker nodes concurrently with this token.
240+
As they come up they should find each other and form the cluster. The same
241+
`--token` argument can be used on both `kubeadm init` and `kubeadm join`.
242242

243-
1. Similar can be done for `--certificate-key` when joining additional control-plane
244-
nodes. The key can be generated using:
243+
1. Similar can be done for `--certificate-key` when joining additional control-plane
244+
nodes. The key can be generated using:
245245

246-
```shell
247-
kubeadm alpha certs certificate-key
248-
```
246+
```shell
247+
kubeadm alpha certs certificate-key
248+
```
249249

250250
Once the cluster is up, you can grab the admin credentials from the control-plane node
251251
at `/etc/kubernetes/admin.conf` and use that to talk to the cluster.
@@ -255,13 +255,10 @@ it does not allow the root CA hash to be validated with
255255
`--discovery-token-ca-cert-hash` (since it's not generated when the nodes are
256256
provisioned). For details, see the [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/).
257257

258-
259-
260258
## {{% heading "whatsnext" %}}
261259

262260
* [kubeadm init phase](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/) to understand more about
263261
`kubeadm init` phases
264262
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to bootstrap a Kubernetes worker node and join it to the cluster
265263
* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/) to upgrade a Kubernetes cluster to a newer version
266264
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`
267-

content/en/docs/reference/setup-tools/kubeadm/kubeadm-join-phase.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: kubeadm join phase
33
weight: 90
4+
content_type: concept
45
---
6+
57
`kubeadm join phase` enables you to invoke atomic steps of the join process.
68
Hence, you can let kubeadm do some of the work and you can fill in the gaps
79
if you wish to apply customization.
@@ -56,7 +58,8 @@ Using this phase you can join a node as a control-plane instance.
5658
{{< tab name="mark-control-plane" include="generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md" />}}
5759
{{< /tabs >}}
5860

59-
## What's next
61+
## {{% heading "whatsnext" %}}
62+
6063
* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node
6164
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster
6265
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`

0 commit comments

Comments
 (0)