Reference doc for kubeadm (release-1.11) (#9044)

* Reference doc for kubeadm (release-1.11) * fix shortcode to troubleshoot deploy (#9057)
kubernetes · Jun 27, 2018 · 9e69b33 · 9e69b33
1 parent bf66892
commit 9e69b33
Show file tree

Hide file tree

Showing 81 changed files with 1,510 additions and 426 deletions.
diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md
@@ -39,7 +39,7 @@ Example usage:
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -50,7 +50,7 @@ Example usage:
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for kubeadm</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for kubeadm</td>
     </tr>
 
   </tbody>

diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md
@@ -8,7 +8,7 @@ Experimental sub-commands not yet fully functional.
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -19,7 +19,7 @@ Experimental sub-commands not yet fully functional.
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for alpha</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for alpha</td>
     </tr>
 
   </tbody>

diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for phase</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for phase</td>
     </tr>
 
   </tbody>

diff --git a/...nt/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md b/...nt/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for addon</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for addon</td>
     </tr>
 
   </tbody>

diff --git a/...n/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md b/...n/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md
@@ -4,8 +4,7 @@ Installs all addons to a Kubernetes cluster
 ### Synopsis
 
 
-Installs the kube-dns 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. 
+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. 
 
 Alpha Disclaimer: this command is currently alpha.
 
@@ -16,15 +15,15 @@ kubeadm alpha phase addon all [flags]
 ### Examples
 
 ```
-  # Installs the kube-dns and the kube-proxys addons components via the API server,
+  # Installs the CoreDNS and the kube-proxys addons components via the API server,
   # functionally equivalent to what installed by kubeadm init.
   
   kubeadm alpha phase selfhosting from-staticpods
 ```
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -35,77 +34,77 @@ kubeadm alpha phase addon all [flags]
       <td colspan="2">--apiserver-advertise-address string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The IP address or DNS name the API server is accessible on</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address the API server is accessible on</td>
     </tr>
 
     <tr>
       <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The port the API server is accessible on</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The port the API server is accessible on</td>
     </tr>
 
     <tr>
       <td colspan="2">--config string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!</td>
+      <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>
     </tr>
 
     <tr>
       <td colspan="2">--feature-gates string</td>
     </tr>
     <tr>
-      <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>
+      <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>
     </tr>
 
     <tr>
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for all</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for all</td>
     </tr>
 
     <tr>
       <td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Choose a container registry to pull control plane images from</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
     </tr>
 
     <tr>
       <td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
     </tr>
 
     <tr>
       <td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Choose a specific Kubernetes version for the control plane</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
     </tr>
 
     <tr>
       <td colspan="2">--pod-network-cidr string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The range of IP addresses used for the Pod network</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP addresses used for the Pod network</td>
     </tr>
 
     <tr>
       <td colspan="2">--service-cidr string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "10.96.0.0/12"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The range of IP address used for service VIPs</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP address used for service VIPs</td>
     </tr>
 
     <tr>
       <td colspan="2">--service-dns-domain string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cluster.local"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Alternative domain for services</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Alternative domain for services</td>
     </tr>
 
   </tbody>

diff --git a/...cs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md b/...cs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md
@@ -1,5 +1,84 @@
-PLACEHOLDER FILE UNTIL WE GENERATE THE REAL THING. DO NOT REMOVE FROM 1.11 DOCS BRANCH
+
+Installs the CoreDNS addon to a Kubernetes cluster
 
 ### Synopsis
 
-Installs the coredns addon components via the API server.
+
+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. 
+
+Alpha Disclaimer: this command is currently alpha.
+
+```
+kubeadm alpha phase addon coredns [flags]
+```
+
+### Options
+
+<table style="width: 100%; table-layout: fixed;">
+  <colgroup>
+    <col span="1" style="width: 10px;" />
+    <col span="1" />
+  </colgroup>
+  <tbody>
+
+    <tr>
+      <td colspan="2">--config string</td>
+    </tr>
+    <tr>
+      <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>
+    </tr>
+
+    <tr>
+      <td colspan="2">--feature-gates string</td>
+    </tr>
+    <tr>
+      <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>
+    </tr>
+
+    <tr>
+      <td colspan="2">-h, --help</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for coredns</td>
+    </tr>
+
+    <tr>
+      <td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
+    </tr>
+
+    <tr>
+      <td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
+    </tr>
+
+    <tr>
+      <td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
+    </tr>
+
+    <tr>
+      <td colspan="2">--service-cidr string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "10.96.0.0/12"</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP address used for service VIPs</td>
+    </tr>
+
+    <tr>
+      <td colspan="2">--service-dns-domain string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cluster.local"</td>
+    </tr>
+    <tr>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Alternative domain for services</td>
+    </tr>
+
+  </tbody>
+</table>
+
+
+
diff --git a/...reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md b/...reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md
@@ -14,7 +14,7 @@ kubeadm alpha phase addon kube-proxy [flags]
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -25,56 +25,56 @@ kubeadm alpha phase addon kube-proxy [flags]
       <td colspan="2">--apiserver-advertise-address string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The IP address or DNS name the API server is accessible on</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address the API server is accessible on</td>
     </tr>
 
     <tr>
       <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The port the API server is accessible on</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The port the API server is accessible on</td>
     </tr>
 
     <tr>
       <td colspan="2">--config string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!</td>
+      <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>
     </tr>
 
     <tr>
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for kube-proxy</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for kube-proxy</td>
     </tr>
 
     <tr>
       <td colspan="2">--image-repository string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "k8s.gcr.io"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Choose a container registry to pull control plane images from</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a container registry to pull control plane images from</td>
     </tr>
 
     <tr>
       <td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
     </tr>
 
     <tr>
       <td colspan="2">--kubernetes-version string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stable-1.10"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">Choose a specific Kubernetes version for the control plane</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">Choose a specific Kubernetes version for the control plane</td>
     </tr>
 
     <tr>
       <td colspan="2">--pod-network-cidr string</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The range of IP addresses used for the Pod network</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The range of IP addresses used for the Pod network</td>
     </tr>
 
   </tbody>

diff --git a/.../reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md b/.../reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md
@@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand
 
 ### Options
 
-<table style="width: 100%;">
+<table style="width: 100%; table-layout: fixed;">
   <colgroup>
     <col span="1" style="width: 10px;" />
     <col span="1" />
@@ -19,14 +19,14 @@ This command is not meant to be run on its own. See list of available subcommand
       <td colspan="2">-h, --help</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">help for bootstrap-token</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">help for bootstrap-token</td>
     </tr>
 
     <tr>
       <td colspan="2">--kubeconfig string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/admin.conf"</td>
     </tr>
     <tr>
-      <td></td><td style="line-height: 130%">The KubeConfig file to use when talking to the cluster</td>
+      <td></td><td style="line-height: 130%; word-wrap: break-word;">The KubeConfig file to use when talking to the cluster</td>
     </tr>
 
   </tbody>