Skip to content

Commit 426f5e2

Browse files
authored
Merge pull request #48408 from neolit123/1.32-kubeadm-docs
kubeadm: add 1.32 documentation
2 parents b6a7ad7 + bbdb8dd commit 426f5e2

File tree

49 files changed

+1942
-76
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1942
-76
lines changed

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_certs/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ guide. You can file document formatting bugs against the
1010
-->
1111

1212

13-
Commands related to handling kubernetes certificates
13+
Commands related to handling Kubernetes certificates
1414

1515
### Synopsis
1616

1717

18-
Commands related to handling kubernetes certificates
18+
Commands related to handling Kubernetes certificates
1919

2020
```
2121
kubeadm certs [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_certs/kubeadm_certs_renew.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Renew certificates for a Kubernetes cluster
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Renew certificates for a Kubernetes cluster
1919

2020
```
2121
kubeadm certs renew [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Manage configuration for a kubeadm cluster persisted in a ConfigMap in the clust
1818

1919
There is a ConfigMap in the kube-system namespace called "kubeadm-config" that kubeadm uses to store internal configuration about the
2020
cluster. kubeadm CLI v1.8.0+ automatically creates this ConfigMap with the config used with 'kubeadm init', but if you
21-
initialized your cluster using kubeadm v1.7.x or lower, you must use the 'kubeadm init phase upload-config' command to
21+
initialized your cluster using kubeadm v1.7.x or lower, you must use the 'kubeadm init phase upload-config' command to
2222
create this ConfigMap. This is required so that 'kubeadm upgrade' can configure your upgraded cluster correctly.
2323

2424

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config/kubeadm_config_images_list.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ kubeadm config images list [flags]
4848
<td colspan="2">--feature-gates string</td>
4949
</tr>
5050
<tr>
51-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
51+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
5252
</tr>
5353

5454
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config/kubeadm_config_images_pull.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ kubeadm config images pull [flags]
4848
<td colspan="2">--feature-gates string</td>
4949
</tr>
5050
<tr>
51-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
51+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
5252
</tr>
5353

5454
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/_index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ mark-control-plane Mark a node as a control-plane
5353
bootstrap-token Generates bootstrap tokens used to join a node to a cluster
5454
kubelet-finalize Updates settings relevant to the kubelet after TLS bootstrap
5555
/enable-client-cert-rotation Enable kubelet client certificate rotation
56-
/experimental-cert-rotation Enable kubelet client certificate rotation (DEPRECATED: use 'enable-client-cert-rotation' instead)
5756
addon Install required addons for passing conformance tests
5857
/coredns Install the CoreDNS addon to a Kubernetes cluster
5958
/kube-proxy Install the kube-proxy addon to a Kubernetes cluster
@@ -141,7 +140,7 @@ kubeadm init [flags]
141140
<td colspan="2">--feature-gates string</td>
142141
</tr>
143142
<tr>
144-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
143+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
145144
</tr>
146145

147146
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ guide. You can file document formatting bugs against the
1010
-->
1111

1212

13-
Use this command to invoke single phase of the init workflow
13+
Use this command to invoke single phase of the "init" workflow
1414

1515
### Synopsis
1616

1717

18-
Use this command to invoke single phase of the init workflow
18+
Use this command to invoke single phase of the "init" workflow
19+
20+
```
21+
kubeadm init phase [flags]
22+
```
1923

2024
### Options
2125

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_addon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Install required addons for passing conformance tests
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Install required addons for passing conformance tests
1919

2020
```
2121
kubeadm init phase addon [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_addon_all.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ kubeadm init phase addon all [flags]
6969
<td colspan="2">--feature-gates string</td>
7070
</tr>
7171
<tr>
72-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
72+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
7373
</tr>
7474

7575
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_addon_coredns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ kubeadm init phase addon coredns [flags]
4848
<td colspan="2">--feature-gates string</td>
4949
</tr>
5050
<tr>
51-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
51+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
5252
</tr>
5353

5454
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_certs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Certificate generation
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Certificate generation
1919

2020
```
2121
kubeadm init phase certs [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_control-plane.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Generate all static Pod manifest files necessary to establish the control plane
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Generate all static Pod manifest files necessary to establish the control plane
1919

2020
```
2121
kubeadm init phase control-plane [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_control-plane_all.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ kubeadm init phase control-plane all [flags]
8787
<td colspan="2">--feature-gates string</td>
8888
</tr>
8989
<tr>
90-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
90+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
9191
</tr>
9292

9393
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_control-plane_apiserver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ kubeadm init phase control-plane apiserver [flags]
7676
<td colspan="2">--feature-gates string</td>
7777
</tr>
7878
<tr>
79-
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (BETA - default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
79+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for various features. Options are:<br/>ControlPlaneKubeletLocalMode=true|false (ALPHA - default=false)<br/>EtcdLearnerMode=true|false (default=true)<br/>PublicKeysECDSA=true|false (DEPRECATED - default=false)<br/>RootlessControlPlane=true|false (ALPHA - default=false)<br/>WaitForAllControlPlaneComponents=true|false (ALPHA - default=false)</p></td>
8080
</tr>
8181

8282
<tr>

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_etcd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Generate static Pod manifest file for local etcd
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Generate static Pod manifest file for local etcd
1919

2020
```
2121
kubeadm init phase etcd [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_kubeconfig.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Generate all kubeconfig files necessary to establish the control plane and the a
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file
1919

2020
```
2121
kubeadm init phase kubeconfig [flags]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Upload the kubeadm and kubelet configuration to a ConfigMap
1515
### Synopsis
1616

1717

18-
This command is not meant to be run on its own. See list of available subcommands.
18+
Upload the kubeadm and kubelet configuration to a ConfigMap
1919

2020
```
2121
kubeadm init phase upload-config [flags]

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/kubeadm_init_phase_upload-config_kubeadm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ kubeadm init phase upload-config kubeadm [flags]
2727

2828
```
2929
# upload the configuration of your cluster
30-
kubeadm init phase upload-config --config=myConfig.yaml
30+
kubeadm init phase upload-config kubeadm --config=myConfig.yaml
3131
```
3232

3333
### Options

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join/kubeadm_join_phase.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ guide. You can file document formatting bugs against the
1010
-->
1111

1212

13-
Use this command to invoke single phase of the join workflow
13+
Use this command to invoke single phase of the "join" workflow
1414

1515
### Synopsis
1616

1717

18-
Use this command to invoke single phase of the join workflow
18+
Use this command to invoke single phase of the "join" workflow
19+
20+
```
21+
kubeadm join phase [flags]
22+
```
1923

2024
### Options
2125

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset/kubeadm_reset_phase.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ guide. You can file document formatting bugs against the
1010
-->
1111

1212

13-
Use this command to invoke single phase of the reset workflow
13+
Use this command to invoke single phase of the "reset" workflow
1414

1515
### Synopsis
1616

1717

18-
Use this command to invoke single phase of the reset workflow
18+
Use this command to invoke single phase of the "reset" workflow
19+
20+
```
21+
kubeadm reset phase [flags]
22+
```
1923

2024
### Options
2125

content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade/kubeadm_upgrade_apply.md

+23
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,22 @@ Upgrade your Kubernetes cluster to the specified version
1717

1818
Upgrade your Kubernetes cluster to the specified version
1919

20+
The "apply [version]" command executes the following phases:
21+
```
22+
preflight Run preflight checks before upgrade
23+
control-plane Upgrade the control plane
24+
upload-config Upload the kubeadm and kubelet configurations to ConfigMaps
25+
/kubeadm Upload the kubeadm ClusterConfiguration to a ConfigMap
26+
/kubelet Upload the kubelet configuration to a ConfigMap
27+
kubelet-config Upgrade the kubelet configuration for this node
28+
bootstrap-token Configures bootstrap token and cluster-info RBAC rules
29+
addon Upgrade the default kubeadm addons
30+
/coredns Upgrade the CoreDNS addon
31+
/kube-proxy Upgrade the kube-proxy addon
32+
post-upgrade Run post upgrade tasks
33+
```
34+
35+
2036
```
2137
kubeadm upgrade apply [version]
2238
```
@@ -114,6 +130,13 @@ kubeadm upgrade apply [version]
114130
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specifies whether the configuration file that will be used in the upgrade should be printed or not.</p></td>
115131
</tr>
116132

133+
<tr>
134+
<td colspan="2">--skip-phases strings</td>
135+
</tr>
136+
<tr>
137+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of phases to be skipped</p></td>
138+
</tr>
139+
117140
<tr>
118141
<td colspan="2">-y, --yes</td>
119142
</tr>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
The file is auto-generated from the Go source code of the component using a generic
3+
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
4+
to generate the reference documentation, please read
5+
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
6+
To update the reference content, please follow the
7+
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
8+
guide. You can file document formatting bugs against the
9+
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
10+
-->
11+
12+
13+
Use this command to invoke single phase of the "apply" workflow
14+
15+
### Synopsis
16+
17+
18+
Use this command to invoke single phase of the "apply" workflow
19+
20+
```
21+
kubeadm upgrade apply phase [flags]
22+
```
23+
24+
### Options
25+
26+
<table style="width: 100%; table-layout: fixed;">
27+
<colgroup>
28+
<col span="1" style="width: 10px;" />
29+
<col span="1" />
30+
</colgroup>
31+
<tbody>
32+
33+
<tr>
34+
<td colspan="2">-h, --help</td>
35+
</tr>
36+
<tr>
37+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for phase</p></td>
38+
</tr>
39+
40+
</tbody>
41+
</table>
42+
43+
44+
45+
### Options inherited from parent commands
46+
47+
<table style="width: 100%; table-layout: fixed;">
48+
<colgroup>
49+
<col span="1" style="width: 10px;" />
50+
<col span="1" />
51+
</colgroup>
52+
<tbody>
53+
54+
<tr>
55+
<td colspan="2">--rootfs string</td>
56+
</tr>
57+
<tr>
58+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the 'real' host root filesystem. This will cause kubeadm to chroot into the provided path.</p></td>
59+
</tr>
60+
61+
</tbody>
62+
</table>
63+
64+
65+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
The file is auto-generated from the Go source code of the component using a generic
3+
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
4+
to generate the reference documentation, please read
5+
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
6+
To update the reference content, please follow the
7+
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
8+
guide. You can file document formatting bugs against the
9+
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
10+
-->
11+
12+
13+
Upgrade the default kubeadm addons
14+
15+
### Synopsis
16+
17+
18+
Upgrade the default kubeadm addons
19+
20+
```
21+
kubeadm upgrade apply phase addon [flags]
22+
```
23+
24+
### Options
25+
26+
<table style="width: 100%; table-layout: fixed;">
27+
<colgroup>
28+
<col span="1" style="width: 10px;" />
29+
<col span="1" />
30+
</colgroup>
31+
<tbody>
32+
33+
<tr>
34+
<td colspan="2">-h, --help</td>
35+
</tr>
36+
<tr>
37+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for addon</p></td>
38+
</tr>
39+
40+
</tbody>
41+
</table>
42+
43+
44+
45+
### Options inherited from parent commands
46+
47+
<table style="width: 100%; table-layout: fixed;">
48+
<colgroup>
49+
<col span="1" style="width: 10px;" />
50+
<col span="1" />
51+
</colgroup>
52+
<tbody>
53+
54+
<tr>
55+
<td colspan="2">--rootfs string</td>
56+
</tr>
57+
<tr>
58+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the 'real' host root filesystem. This will cause kubeadm to chroot into the provided path.</p></td>
59+
</tr>
60+
61+
</tbody>
62+
</table>
63+
64+
65+

0 commit comments

Comments
 (0)