Skip to content

Commit b212339

Browse files
committed
Add generated/kubeadm-certs*.md
1 parent af7e3cc commit b212339

16 files changed

+1386
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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 conent, 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+
Commands related to handling kubernetes certificates
14+
15+
### Synopsis
16+
17+
18+
Commands related to handling kubernetes certificates
19+
20+
### Options
21+
22+
<table style="width: 100%; table-layout: fixed;">
23+
<colgroup>
24+
<col span="1" style="width: 10px;" />
25+
<col span="1" />
26+
</colgroup>
27+
<tbody>
28+
29+
<tr>
30+
<td colspan="2">-h, --help</td>
31+
</tr>
32+
<tr>
33+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for certs</p></td>
34+
</tr>
35+
36+
</tbody>
37+
</table>
38+
39+
40+
41+
### Options inherited from parent commands
42+
43+
<table style="width: 100%; table-layout: fixed;">
44+
<colgroup>
45+
<col span="1" style="width: 10px;" />
46+
<col span="1" />
47+
</colgroup>
48+
<tbody>
49+
50+
<tr>
51+
<td colspan="2">--rootfs string</td>
52+
</tr>
53+
<tr>
54+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[EXPERIMENTAL] The path to the 'real' host root filesystem.</p></td>
55+
</tr>
56+
57+
</tbody>
58+
</table>
59+
60+
61+
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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 conent, 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+
Generate certificate keys
14+
15+
### Synopsis
16+
17+
18+
19+
This command will print out a secure randomly-generated certificate key that can be used with
20+
the "init" command.
21+
22+
You can also use "kubeadm init --upload-certs" without specifying a certificate key and it will
23+
generate and print one for you.
24+
25+
26+
```
27+
kubeadm certs certificate-key [flags]
28+
```
29+
30+
### Options
31+
32+
<table style="width: 100%; table-layout: fixed;">
33+
<colgroup>
34+
<col span="1" style="width: 10px;" />
35+
<col span="1" />
36+
</colgroup>
37+
<tbody>
38+
39+
<tr>
40+
<td colspan="2">-h, --help</td>
41+
</tr>
42+
<tr>
43+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for certificate-key</p></td>
44+
</tr>
45+
46+
</tbody>
47+
</table>
48+
49+
50+
51+
### Options inherited from parent commands
52+
53+
<table style="width: 100%; table-layout: fixed;">
54+
<colgroup>
55+
<col span="1" style="width: 10px;" />
56+
<col span="1" />
57+
</colgroup>
58+
<tbody>
59+
60+
<tr>
61+
<td colspan="2">--rootfs string</td>
62+
</tr>
63+
<tr>
64+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[EXPERIMENTAL] The path to the 'real' host root filesystem.</p></td>
65+
</tr>
66+
67+
</tbody>
68+
</table>
69+
70+
71+
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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 conent, 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+
Check certificates expiration for a Kubernetes cluster
14+
15+
### Synopsis
16+
17+
18+
Checks expiration for the certificates in the local PKI managed by kubeadm.
19+
20+
```
21+
kubeadm certs check-expiration [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">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
35+
</tr>
36+
<tr>
37+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path where to save the certificates</p></td>
38+
</tr>
39+
40+
<tr>
41+
<td colspan="2">--config string</td>
42+
</tr>
43+
<tr>
44+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a kubeadm configuration file.</p></td>
45+
</tr>
46+
47+
<tr>
48+
<td colspan="2">-h, --help</td>
49+
</tr>
50+
<tr>
51+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for check-expiration</p></td>
52+
</tr>
53+
54+
<tr>
55+
<td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
56+
</tr>
57+
<tr>
58+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.</p></td>
59+
</tr>
60+
61+
</tbody>
62+
</table>
63+
64+
65+
66+
### Options inherited from parent commands
67+
68+
<table style="width: 100%; table-layout: fixed;">
69+
<colgroup>
70+
<col span="1" style="width: 10px;" />
71+
<col span="1" />
72+
</colgroup>
73+
<tbody>
74+
75+
<tr>
76+
<td colspan="2">--rootfs string</td>
77+
</tr>
78+
<tr>
79+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[EXPERIMENTAL] The path to the 'real' host root filesystem.</p></td>
80+
</tr>
81+
82+
</tbody>
83+
</table>
84+
85+
86+
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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 conent, 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+
Generate keys and certificate signing requests
14+
15+
### Synopsis
16+
17+
18+
Generates keys and certificate signing requests (CSRs) for all the certificates required to run the control plane. This command also generates partial kubeconfig files with private key data in the "users &gt; user &gt; client-key-data" field, and for each kubeconfig file an accompanying ".csr" file is created.
19+
20+
This command is designed for use in [Kubeadm External CA Mode](https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/#external-ca-mode). It generates CSRs which you can then submit to your external certificate authority for signing.
21+
22+
The PEM encoded signed certificates should then be saved alongside the key files, using ".crt" as the file extension, or in the case of kubeconfig files, the PEM encoded signed certificate should be base64 encoded and added to the kubeconfig file in the "users &gt; user &gt; client-certificate-data" field.
23+
24+
```
25+
kubeadm certs generate-csr [flags]
26+
```
27+
28+
### Examples
29+
30+
```
31+
# The following command will generate keys and CSRs for all control-plane certificates and kubeconfig files:
32+
kubeadm certs generate-csr --kubeconfig-dir /tmp/etc-k8s --cert-dir /tmp/etc-k8s/pki
33+
```
34+
35+
### Options
36+
37+
<table style="width: 100%; table-layout: fixed;">
38+
<colgroup>
39+
<col span="1" style="width: 10px;" />
40+
<col span="1" />
41+
</colgroup>
42+
<tbody>
43+
44+
<tr>
45+
<td colspan="2">--cert-dir string</td>
46+
</tr>
47+
<tr>
48+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path where to save the certificates</p></td>
49+
</tr>
50+
51+
<tr>
52+
<td colspan="2">--config string</td>
53+
</tr>
54+
<tr>
55+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a kubeadm configuration file.</p></td>
56+
</tr>
57+
58+
<tr>
59+
<td colspan="2">-h, --help</td>
60+
</tr>
61+
<tr>
62+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for generate-csr</p></td>
63+
</tr>
64+
65+
<tr>
66+
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
67+
</tr>
68+
<tr>
69+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path where to save the kubeconfig file.</p></td>
70+
</tr>
71+
72+
</tbody>
73+
</table>
74+
75+
76+
77+
### Options inherited from parent commands
78+
79+
<table style="width: 100%; table-layout: fixed;">
80+
<colgroup>
81+
<col span="1" style="width: 10px;" />
82+
<col span="1" />
83+
</colgroup>
84+
<tbody>
85+
86+
<tr>
87+
<td colspan="2">--rootfs string</td>
88+
</tr>
89+
<tr>
90+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[EXPERIMENTAL] The path to the 'real' host root filesystem.</p></td>
91+
</tr>
92+
93+
</tbody>
94+
</table>
95+
96+
97+
Lines changed: 65 additions & 0 deletions
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 conent, 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+
Renew certificates for a Kubernetes cluster
14+
15+
### Synopsis
16+
17+
18+
This command is not meant to be run on its own. See list of available subcommands.
19+
20+
```
21+
kubeadm certs renew [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 renew</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>[EXPERIMENTAL] The path to the 'real' host root filesystem.</p></td>
59+
</tr>
60+
61+
</tbody>
62+
</table>
63+
64+
65+

0 commit comments

Comments
 (0)