Skip to content

Commit 9e69b33

Browse files
tengqmMisty Linville
tengqm
authored and
Misty Linville
committed
Reference doc for kubeadm (release-1.11) (#9044)
* Reference doc for kubeadm (release-1.11) * fix shortcode to troubleshoot deploy (#9057)
1 parent bf66892 commit 9e69b33

File tree

81 files changed

+1510
-426
lines changed

Some content is hidden

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

81 files changed

+1510
-426
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Example usage:
3939

4040
### Options
4141

42-
<table style="width: 100%;">
42+
<table style="width: 100%; table-layout: fixed;">
4343
<colgroup>
4444
<col span="1" style="width: 10px;" />
4545
<col span="1" />
@@ -50,7 +50,7 @@ Example usage:
5050
<td colspan="2">-h, --help</td>
5151
</tr>
5252
<tr>
53-
<td></td><td style="line-height: 130%">help for kubeadm</td>
53+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for kubeadm</td>
5454
</tr>
5555

5656
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Experimental sub-commands not yet fully functional.
88

99
### Options
1010

11-
<table style="width: 100%;">
11+
<table style="width: 100%; table-layout: fixed;">
1212
<colgroup>
1313
<col span="1" style="width: 10px;" />
1414
<col span="1" />
@@ -19,7 +19,7 @@ Experimental sub-commands not yet fully functional.
1919
<td colspan="2">-h, --help</td>
2020
</tr>
2121
<tr>
22-
<td></td><td style="line-height: 130%">help for alpha</td>
22+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for alpha</td>
2323
</tr>
2424

2525
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
88

99
### Options
1010

11-
<table style="width: 100%;">
11+
<table style="width: 100%; table-layout: fixed;">
1212
<colgroup>
1313
<col span="1" style="width: 10px;" />
1414
<col span="1" />
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand
1919
<td colspan="2">-h, --help</td>
2020
</tr>
2121
<tr>
22-
<td></td><td style="line-height: 130%">help for phase</td>
22+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for phase</td>
2323
</tr>
2424

2525
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
88

99
### Options
1010

11-
<table style="width: 100%;">
11+
<table style="width: 100%; table-layout: fixed;">
1212
<colgroup>
1313
<col span="1" style="width: 10px;" />
1414
<col span="1" />
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand
1919
<td colspan="2">-h, --help</td>
2020
</tr>
2121
<tr>
22-
<td></td><td style="line-height: 130%">help for addon</td>
22+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for addon</td>
2323
</tr>
2424

2525
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ Installs all addons to a Kubernetes cluster
44
### Synopsis
55

66

7-
Installs the kube-dns and the kube-proxys addons components via the API server.
8-
Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
7+
Installs the CoreDNS and the kube-proxys addons components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
98

109
Alpha Disclaimer: this command is currently alpha.
1110

@@ -16,15 +15,15 @@ kubeadm alpha phase addon all [flags]
1615
### Examples
1716

1817
```
19-
# Installs the kube-dns and the kube-proxys addons components via the API server,
18+
# Installs the CoreDNS and the kube-proxys addons components via the API server,
2019
# functionally equivalent to what installed by kubeadm init.
2120
2221
kubeadm alpha phase selfhosting from-staticpods
2322
```
2423

2524
### Options
2625

27-
<table style="width: 100%;">
26+
<table style="width: 100%; table-layout: fixed;">
2827
<colgroup>
2928
<col span="1" style="width: 10px;" />
3029
<col span="1" />
@@ -35,77 +34,77 @@ kubeadm alpha phase addon all [flags]
3534
<td colspan="2">--apiserver-advertise-address string</td>
3635
</tr>
3736
<tr>
38-
<td></td><td style="line-height: 130%">The IP address or DNS name the API server is accessible on</td>
37+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address the API server is accessible on</td>
3938
</tr>
4039

4140
<tr>
4241
<td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
4342
</tr>
4443
<tr>
45-
<td></td><td style="line-height: 130%">The port the API server is accessible on</td>
44+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The port the API server is accessible on</td>
4645
</tr>
4746

4847
<tr>
4948
<td colspan="2">--config string</td>
5049
</tr>
5150
<tr>
52-
<td></td><td style="line-height: 130%">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!</td>
51+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental</td>
5352
</tr>
5453

5554
<tr>
5655
<td colspan="2">--feature-gates string</td>
5756
</tr>
5857
<tr>
59-
<td></td><td style="line-height: 130%">A set of key=value pairs that describe feature gates for various features.Options are:<br/>Auditing=true|false (ALPHA - default=false)<br/>CoreDNS=true|false (BETA - default=false)<br/>DynamicKubeletConfig=true|false (ALPHA - default=false)<br/>SelfHosting=true|false (ALPHA - default=false)<br/>StoreCertsInSecrets=true|false (ALPHA - default=false)</td>
58+
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of key=value pairs that describe feature gates for various features.Options are:<br/>Auditing=true|false (ALPHA - default=false)<br/>CoreDNS=true|false (default=true)<br/>DynamicKubeletConfig=true|false (ALPHA - default=false)<br/>SelfHosting=true|false (ALPHA - default=false)<br/>StoreCertsInSecrets=true|false (ALPHA - default=false)</td>
6059
</tr>
6160

6261
<tr>
6362
<td colspan="2">-h, --help</td>
6463
</tr>
6564
<tr>
66-
<td></td><td style="line-height: 130%">help for all</td>
65+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for all</td>
6766
</tr>
6867

6968
<tr>
7069
<td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
7170
</tr>
7271
<tr>
73-
<td></td><td style="line-height: 130%">Choose a container registry to pull control plane images from</td>
72+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
7473
</tr>
7574

7675
<tr>
7776
<td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
7877
</tr>
7978
<tr>
80-
<td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
79+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
8180
</tr>
8281

8382
<tr>
8483
<td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
8584
</tr>
8685
<tr>
87-
<td></td><td style="line-height: 130%">Choose a specific Kubernetes version for the control plane</td>
86+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
8887
</tr>
8988

9089
<tr>
9190
<td colspan="2">--pod-network-cidr string</td>
9291
</tr>
9392
<tr>
94-
<td></td><td style="line-height: 130%">The range of IP addresses used for the Pod network</td>
93+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP addresses used for the Pod network</td>
9594
</tr>
9695

9796
<tr>
9897
<td colspan="2">--service-cidr string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "10.96.0.0/12"</td>
9998
</tr>
10099
<tr>
101-
<td></td><td style="line-height: 130%">The range of IP address used for service VIPs</td>
100+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP address used for service VIPs</td>
102101
</tr>
103102

104103
<tr>
105104
<td colspan="2">--service-dns-domain string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cluster.local"</td>
106105
</tr>
107106
<tr>
108-
<td></td><td style="line-height: 130%">Alternative domain for services</td>
107+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Alternative domain for services</td>
109108
</tr>
110109

111110
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md‎

Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,84 @@
1-
PLACEHOLDER FILE UNTIL WE GENERATE THE REAL THING. DO NOT REMOVE FROM 1.11 DOCS BRANCH
1+
2+
Installs the CoreDNS addon to a Kubernetes cluster
23

34
### Synopsis
45

5-
Installs the coredns addon components via the API server.
6+
7+
Installs the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
8+
9+
Alpha Disclaimer: this command is currently alpha.
10+
11+
```
12+
kubeadm alpha phase addon coredns [flags]
13+
```
14+
15+
### Options
16+
17+
<table style="width: 100%; table-layout: fixed;">
18+
<colgroup>
19+
<col span="1" style="width: 10px;" />
20+
<col span="1" />
21+
</colgroup>
22+
<tbody>
23+
24+
<tr>
25+
<td colspan="2">--config string</td>
26+
</tr>
27+
<tr>
28+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental</td>
29+
</tr>
30+
31+
<tr>
32+
<td colspan="2">--feature-gates string</td>
33+
</tr>
34+
<tr>
35+
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of key=value pairs that describe feature gates for various features.Options are:<br/>Auditing=true|false (ALPHA - default=false)<br/>CoreDNS=true|false (default=true)<br/>DynamicKubeletConfig=true|false (ALPHA - default=false)<br/>SelfHosting=true|false (ALPHA - default=false)<br/>StoreCertsInSecrets=true|false (ALPHA - default=false)</td>
36+
</tr>
37+
38+
<tr>
39+
<td colspan="2">-h, --help</td>
40+
</tr>
41+
<tr>
42+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for coredns</td>
43+
</tr>
44+
45+
<tr>
46+
<td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
47+
</tr>
48+
<tr>
49+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
50+
</tr>
51+
52+
<tr>
53+
<td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
54+
</tr>
55+
<tr>
56+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
57+
</tr>
58+
59+
<tr>
60+
<td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
61+
</tr>
62+
<tr>
63+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
64+
</tr>
65+
66+
<tr>
67+
<td colspan="2">--service-cidr string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "10.96.0.0/12"</td>
68+
</tr>
69+
<tr>
70+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP address used for service VIPs</td>
71+
</tr>
72+
73+
<tr>
74+
<td colspan="2">--service-dns-domain string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cluster.local"</td>
75+
</tr>
76+
<tr>
77+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Alternative domain for services</td>
78+
</tr>
79+
80+
</tbody>
81+
</table>
82+
83+
84+

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ kubeadm alpha phase addon kube-proxy [flags]
1414

1515
### Options
1616

17-
<table style="width: 100%;">
17+
<table style="width: 100%; table-layout: fixed;">
1818
<colgroup>
1919
<col span="1" style="width: 10px;" />
2020
<col span="1" />
@@ -25,56 +25,56 @@ kubeadm alpha phase addon kube-proxy [flags]
2525
<td colspan="2">--apiserver-advertise-address string</td>
2626
</tr>
2727
<tr>
28-
<td></td><td style="line-height: 130%">The IP address or DNS name the API server is accessible on</td>
28+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address the API server is accessible on</td>
2929
</tr>
3030

3131
<tr>
3232
<td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
3333
</tr>
3434
<tr>
35-
<td></td><td style="line-height: 130%">The port the API server is accessible on</td>
35+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The port the API server is accessible on</td>
3636
</tr>
3737

3838
<tr>
3939
<td colspan="2">--config string</td>
4040
</tr>
4141
<tr>
42-
<td></td><td style="line-height: 130%">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!</td>
42+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental</td>
4343
</tr>
4444

4545
<tr>
4646
<td colspan="2">-h, --help</td>
4747
</tr>
4848
<tr>
49-
<td></td><td style="line-height: 130%">help for kube-proxy</td>
49+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for kube-proxy</td>
5050
</tr>
5151

5252
<tr>
5353
<td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
5454
</tr>
5555
<tr>
56-
<td></td><td style="line-height: 130%">Choose a container registry to pull control plane images from</td>
56+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
5757
</tr>
5858

5959
<tr>
6060
<td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
6161
</tr>
6262
<tr>
63-
<td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
63+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
6464
</tr>
6565

6666
<tr>
6767
<td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
6868
</tr>
6969
<tr>
70-
<td></td><td style="line-height: 130%">Choose a specific Kubernetes version for the control plane</td>
70+
<td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
7171
</tr>
7272

7373
<tr>
7474
<td colspan="2">--pod-network-cidr string</td>
7575
</tr>
7676
<tr>
77-
<td></td><td style="line-height: 130%">The range of IP addresses used for the Pod network</td>
77+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP addresses used for the Pod network</td>
7878
</tr>
7979

8080
</tbody>

‎content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
88

99
### Options
1010

11-
<table style="width: 100%;">
11+
<table style="width: 100%; table-layout: fixed;">
1212
<colgroup>
1313
<col span="1" style="width: 10px;" />
1414
<col span="1" />
@@ -19,14 +19,14 @@ This command is not meant to be run on its own. See list of available subcommand
1919
<td colspan="2">-h, --help</td>
2020
</tr>
2121
<tr>
22-
<td></td><td style="line-height: 130%">help for bootstrap-token</td>
22+
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for bootstrap-token</td>
2323
</tr>
2424

2525
<tr>
2626
<td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
2727
</tr>
2828
<tr>
29-
<td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
29+
<td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
3030
</tr>
3131

3232
</tbody>

0 commit comments

Comments
 (0)