whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Regenerate kubeadm reference doc (#8115)

Browse Source
This commit is contained in:
Qiming
2018-04-27 05:14:27 +08:00
committed by k8s-ci-robot
parent b855bd1d52
commit e579f79235
66 changed files with 3124 additions and 527 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/setup-tools/kubeadm/generated/kubeadm.md
+19 -3
View File
@@ -4,6 +4,7 @@ kubeadm: easily bootstrap a secure Kubernetes cluster
### Synopsis ### Synopsis
kubeadm: easily bootstrap a secure Kubernetes cluster. kubeadm: easily bootstrap a secure Kubernetes cluster.
┌──────────────────────────────────────────────────────────┐ ┌──────────────────────────────────────────────────────────┐
@@ -38,7 +39,22 @@ Example usage:
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for kubeadm <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for kubeadm</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md
+19 -3
View File
@@ -3,11 +3,27 @@ Experimental sub-commands not yet fully functional.
### Synopsis ### Synopsis
Experimental sub-commands not yet fully functional. Experimental sub-commands not yet fully functional.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for alpha <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for alpha</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md
+19 -3
View File
@@ -3,11 +3,27 @@ Invoke subsets of kubeadm functions separately for a manual install.
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for phase <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for phase</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md
+19 -3
View File
@@ -3,11 +3,27 @@ Installs required addons for passing Conformance tests
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for addon <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for addon</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md
+89 -18
View File
@@ -3,6 +3,7 @@ Installs all addons to a Kubernetes cluster
### Synopsis ### Synopsis
Installs the kube-dns and the kube-proxys addons components via the API server. 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. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
@@ -23,22 +24,92 @@ kubeadm alpha phase addon all [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address or DNS name the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" />
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: </colgroup>
Auditing=true|false (ALPHA - default=false) <tbody>
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td colspan="2">--apiserver-advertise-address string</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
-h, --help help for all <tr>
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") <td></td><td style="line-height: 130%">The IP address or DNS name the API server is accessible on</td>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") </tr>
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10")
--pod-network-cidr string The range of IP addresses used for the Pod network <tr>
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
--service-dns-domain string Alternative domain for services (default "cluster.local") </tr>
``` <tr>
<td></td><td style="line-height: 130%">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>
</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</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>
</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>
</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>
</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>
</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md
+68 -15
View File
@@ -3,6 +3,7 @@ Installs the kube-dns addon to a Kubernetes cluster
### Synopsis ### Synopsis
Installs the kube-dns addon components via the API server. Installs the kube-dns addon components via the API server.
Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
@@ -14,19 +15,71 @@ kubeadm alpha phase addon kube-dns [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! <colgroup>
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: <col span="1" style="width: 10px;" />
Auditing=true|false (ALPHA - default=false) <col span="1" />
CoreDNS=true|false (BETA - default=false) </colgroup>
DynamicKubeletConfig=true|false (ALPHA - default=false) <tbody>
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false) <tr>
-h, --help help for kube-dns <td colspan="2">--config string</td>
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") </tr>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <tr>
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") <td></td><td style="line-height: 130%">Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!</td>
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") </tr>
--service-dns-domain string Alternative domain for services (default "cluster.local")
``` <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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for kube-dns</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>
</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>
</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>
</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>
</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md
+68 -10
View File
@@ -3,6 +3,7 @@ Installs the kube-proxy addon to a Kubernetes cluster
### Synopsis ### Synopsis
Installs the kube-proxy addon components via the API server. Installs the kube-proxy addon components via the API server.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,14 +14,71 @@ kubeadm alpha phase addon kube-proxy [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address or DNS name the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" />
-h, --help help for kube-proxy </colgroup>
--image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") <tbody>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf")
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") <tr>
--pod-network-cidr string The range of IP addresses used for the Pod network <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>
</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>
</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</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>
</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>
</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md
+26 -4
View File
@@ -3,12 +3,34 @@ Manage kubeadm-specific bootstrap token functions
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for bootstrap-token <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md
+86 -13
View File
@@ -3,6 +3,7 @@ Makes all the bootstrap token configurations and creates an initial token
### Synopsis ### Synopsis
Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a the master node. Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a the master node.
This command makes all the configurations required to make bootstrap tokens works and then creates an initial token. This command makes all the configurations required to make bootstrap tokens works and then creates an initial token.
@@ -23,20 +24,92 @@ kubeadm alpha phase bootstrap-token all [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <colgroup>
--description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.") <col span="1" style="width: 10px;" />
--groups strings Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token]) <col span="1" />
-h, --help help for all </colgroup>
--skip-token-print Skip printing of the bootstrap token <tbody>
--token string The token to use for establishing bidirectional trust between nodes and masters
--ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s) <tr>
--usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication]) <td colspan="2">--config string</td>
``` </tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)</td>
</tr>
<tr>
<td colspan="2">--description string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "The default bootstrap token generated by 'kubeadm init'."</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A human friendly description of how this token is used.</td>
</tr>
<tr>
<td colspan="2">--groups stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [system:bootstrappers:kubeadm:default-node-token]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for all</td>
</tr>
<tr>
<td colspan="2">--skip-token-print</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Skip printing of the bootstrap token</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The token to use for establishing bidirectional trust between nodes and masters</td>
</tr>
<tr>
<td colspan="2">--ttl duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire</td>
</tr>
<tr>
<td colspan="2">--usages stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [signing,authentication]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md
+37 -6
View File
@@ -3,6 +3,7 @@ Uploads the cluster-info ConfigMap from the given kubeconfig file
### Synopsis ### Synopsis
Uploads the "cluster-info" ConfigMap in the "kube-public" namespace, populating it with cluster information extracted from the given kubeconfig file. The ConfigMap is used for the node bootstrap process in its initial phases, before the client trusts the API server. Uploads the "cluster-info" ConfigMap in the "kube-public" namespace, populating it with cluster information extracted from the given kubeconfig file. The ConfigMap is used for the node bootstrap process in its initial phases, before the client trusts the API server.
See online documentation about Authenticating with Bootstrap Tokens for more details. See online documentation about Authenticating with Bootstrap Tokens for more details.
@@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token cluster-info [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for cluster-info <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for cluster-info</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md
+86 -13
View File
@@ -3,6 +3,7 @@ Creates a bootstrap token to be used for node joining
### Synopsis ### Synopsis
Creates a bootstrap token. If no token value is given, kubeadm will generate a random token instead. Creates a bootstrap token. If no token value is given, kubeadm will generate a random token instead.
Alternatively, you can use kubeadm token. Alternatively, you can use kubeadm token.
@@ -15,20 +16,92 @@ kubeadm alpha phase bootstrap-token create [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <colgroup>
--description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.") <col span="1" style="width: 10px;" />
--groups strings Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]" (default [system:bootstrappers:kubeadm:default-node-token]) <col span="1" />
-h, --help help for create </colgroup>
--skip-token-print Skip printing of the bootstrap token <tbody>
--token string The token to use for establishing bidirectional trust between nodes and masters
--ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s) <tr>
--usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication]) <td colspan="2">--config string</td>
``` </tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)</td>
</tr>
<tr>
<td colspan="2">--description string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "The default bootstrap token generated by 'kubeadm init'."</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A human friendly description of how this token is used.</td>
</tr>
<tr>
<td colspan="2">--groups stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [system:bootstrappers:kubeadm:default-node-token]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for create</td>
</tr>
<tr>
<td colspan="2">--skip-token-print</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Skip printing of the bootstrap token</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The token to use for establishing bidirectional trust between nodes and masters</td>
</tr>
<tr>
<td colspan="2">--ttl duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire</td>
</tr>
<tr>
<td colspan="2">--usages stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [signing,authentication]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md
+37 -6
View File
@@ -3,17 +3,48 @@ Configures the node bootstrap process
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for node <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for node</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md
+37 -6
View File
@@ -3,6 +3,7 @@ Configures RBAC rules to allow the csrapprover controller automatically approve
### Synopsis ### Synopsis
Configures RBAC rules to allow the csrapprover controller to automatically approve certificate signing requests generated by nodes joining the cluster. It configures also RBAC rules for certificates rotation (with auto approval of new certificates). Configures RBAC rules to allow the csrapprover controller to automatically approve certificate signing requests generated by nodes joining the cluster. It configures also RBAC rules for certificates rotation (with auto approval of new certificates).
See online documentation about TLS bootstrapping for more details. See online documentation about TLS bootstrapping for more details.
@@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for allow-auto-approve <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for allow-auto-approve</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md
+37 -6
View File
@@ -3,6 +3,7 @@ Configures RBAC to allow node bootstrap tokens to post CSRs in order for nodes t
### Synopsis ### Synopsis
Configures RBAC rules to allow node bootstrap tokens to post a certificate signing request, thus enabling nodes joining the cluster to request long term certificate credentials. Configures RBAC rules to allow node bootstrap tokens to post a certificate signing request, thus enabling nodes joining the cluster to request long term certificate credentials.
See online documentation about TLS bootstrapping for more details. See online documentation about TLS bootstrapping for more details.
@@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for allow-post-csrs <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for allow-post-csrs</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md
+19 -3
View File
@@ -3,11 +3,27 @@ Generates certificates for a Kubernetes cluster
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for certs <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for certs</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md
+61 -9
View File
@@ -3,6 +3,7 @@ Generates all PKI assets necessary to establish the control plane
### Synopsis ### Synopsis
Generates a self-signed CA to provision identities for each component in the cluster (including nodes) and client certificates to be used by various components. Generates a self-signed CA to provision identities for each component in the cluster (including nodes) and client certificates to be used by various components.
If a given certificate and private key pair both exist, kubeadm skips the generation step and If a given certificate and private key pair both exist, kubeadm skips the generation step and
@@ -27,13 +28,64 @@ kubeadm alpha phase certs all [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert <colgroup>
--apiserver-cert-extra-sans strings Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names <col span="1" style="width: 10px;" />
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for all <tbody>
--service-cidr string Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services, to use for the API server serving cert (default "cluster.local") <tr>
``` <td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The IP address the API server is accessible on, to use for the API server serving cert</td>
</tr>
<tr>
<td colspan="2">--apiserver-cert-extra-sans stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 all</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%">Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert</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, to use for the API server serving cert</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a client certificate for the API server to connect to etcd securely
### Synopsis ### Synopsis
Generates the client certificate for the API server to connect to etcd securely and the respective key, and saves them into apiserver-etcd-client.crt and apiserver-etcd-client.key files. Generates the client certificate for the API server to connect to etcd securely and the respective key, and saves them into apiserver-etcd-client.crt and apiserver-etcd-client.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs apiserver-etcd-client [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for apiserver-etcd-client <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 apiserver-etcd-client</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a client certificate for the API server to connect to the kubelets sec
### Synopsis ### Synopsis
Generates the client certificate for the API server to connect to the kubelet securely and the respective key, and saves them into apiserver-kubelet-client.crt and apiserver-kubelet-client.key files. Generates the client certificate for the API server to connect to the kubelet securely and the respective key, and saves them into apiserver-kubelet-client.crt and apiserver-kubelet-client.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs apiserver-kubelet-client [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for apiserver-kubelet-client <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 apiserver-kubelet-client</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md
+61 -9
View File
@@ -3,6 +3,7 @@ Generates an API server serving certificate and key
### Synopsis ### Synopsis
Generates the API server serving certificate and key and saves them into apiserver.crt and apiserver.key files. Generates the API server serving certificate and key and saves them into apiserver.crt and apiserver.key files.
The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: <node-name>, <apiserver-advertise-address>, kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc. <service-dns-domain>, <internalAPIServerVirtualIP>(that is the .10 address in <service-cidr>address space). The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: <node-name>, <apiserver-advertise-address>, kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc. <service-dns-domain>, <internalAPIServerVirtualIP>(that is the .10 address in <service-cidr>address space).
@@ -17,13 +18,64 @@ kubeadm alpha phase certs apiserver [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert <colgroup>
--apiserver-cert-extra-sans strings Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names <col span="1" style="width: 10px;" />
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for apiserver <tbody>
--service-cidr string Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert (default "10.96.0.0/12")
--service-dns-domain string Alternative domain for services, to use for the API server serving cert (default "cluster.local") <tr>
``` <td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The IP address the API server is accessible on, to use for the API server serving cert</td>
</tr>
<tr>
<td colspan="2">--apiserver-cert-extra-sans stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 apiserver</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%">Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert</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, to use for the API server serving cert</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a self-signed kubernetes CA to provision identities for components of
### Synopsis ### Synopsis
Generates the self-signed kubernetes certificate authority and related key, and saves them into ca.crt and ca.key files. Generates the self-signed kubernetes certificate authority and related key, and saves them into ca.crt and ca.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs ca [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for ca <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 ca</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a self-signed CA to provision identities for etcd
### Synopsis ### Synopsis
Generates the self-signed etcd certificate authority and related key and saves them into etcd/ca.crt and etcd/ca.key files. Generates the self-signed etcd certificate authority and related key and saves them into etcd/ca.crt and etcd/ca.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs etcd-ca [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for etcd-ca <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 etcd-ca</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a client certificate for liveness probes to healthcheck etcd
### Synopsis ### Synopsis
Generates the client certificate for liveness probes to healthcheck etcd and the respective key, and saves them into etcd/healthcheck-client.crt and etcd/healthcheck-client.key files. Generates the client certificate for liveness probes to healthcheck etcd and the respective key, and saves them into etcd/healthcheck-client.crt and etcd/healthcheck-client.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs etcd-healthcheck-client [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for etcd-healthcheck-client <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 etcd-healthcheck-client</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates an etcd peer certificate and key
### Synopsis ### Synopsis
Generates the etcd peer certificate and key and saves them into etcd/peer.crt and etcd/peer.key files. Generates the etcd peer certificate and key and saves them into etcd/peer.crt and etcd/peer.key files.
The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: <node-name>, <apiserver-advertise-address>. The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: <node-name>, <apiserver-advertise-address>.
@@ -17,9 +18,36 @@ kubeadm alpha phase certs etcd-peer [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for etcd-peer <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 etcd-peer</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates an etcd serving certificate and key
### Synopsis ### Synopsis
Generates the etcd serving certificate and key and saves them into etcd/server.crt and etcd/server.key files. Generates the etcd serving certificate and key and saves them into etcd/server.crt and etcd/server.key files.
The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: localhost, 127.0.0.1. The certificate includes default subject alternative names and additional SANs provided by the user; default SANs are: localhost, 127.0.0.1.
@@ -17,9 +18,36 @@ kubeadm alpha phase certs etcd-server [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for etcd-server <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 etcd-server</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a front proxy CA certificate and key for a Kubernetes cluster
### Synopsis ### Synopsis
Generates the front proxy CA certificate and key and saves them into front-proxy-ca.crt and front-proxy-ca.key files. Generates the front proxy CA certificate and key and saves them into front-proxy-ca.crt and front-proxy-ca.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs front-proxy-ca [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for front-proxy-ca <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 front-proxy-ca</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a front proxy CA client certificate and key for a Kubernetes cluster
### Synopsis ### Synopsis
Generates the front proxy client certificate and key and saves them into front-proxy-client.crt and front-proxy-client.key files. Generates the front proxy client certificate and key and saves them into front-proxy-client.crt and front-proxy-client.key files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs front-proxy-client [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for front-proxy-client <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 front-proxy-client</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates a private key for signing service account tokens along with its public
### Synopsis ### Synopsis
Generates the private key for signing service account tokens along with its public key, and saves them into sa.key and sa.pub files. Generates the private key for signing service account tokens along with its public key, and saves them into sa.key and sa.pub files.
If both files already exist, kubeadm skips the generation step and existing files will be used. If both files already exist, kubeadm skips the generation step and existing files will be used.
@@ -15,9 +16,36 @@ kubeadm alpha phase certs sa [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for sa <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save the certificates</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 sa</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md
+19 -3
View File
@@ -3,11 +3,27 @@ Generates all static Pod manifest files necessary to establish the control plane
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for controlplane <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for controlplane</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md
+96 -19
View File
@@ -3,6 +3,7 @@ Generates all static Pod manifest files necessary to establish the control plane
### Synopsis ### Synopsis
Generates all static Pod manifest files necessary to establish the control plane. Generates all static Pod manifest files necessary to establish the control plane.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -24,23 +25,99 @@ kubeadm alpha phase controlplane all [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address of the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value> <col span="1" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") </colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <tbody>
--controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: <tr>
Auditing=true|false (ALPHA - default=false) <td colspan="2">--apiserver-advertise-address string</td>
CoreDNS=true|false (BETA - default=false) </tr>
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td></td><td style="line-height: 130%">The IP address of the API server is accessible on</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
-h, --help help for all
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") <tr>
--pod-network-cidr string The range of IP addresses used for the Pod network <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
--scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value> </tr>
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") <tr>
``` <td></td><td style="line-height: 130%">The port the API server is accessible on</td>
</tr>
<tr>
<td colspan="2">--apiserver-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the API Server or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)</td>
</tr>
<tr>
<td colspan="2">--controller-manager-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the Controller Manager or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for all</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>
</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>
</tr>
<tr>
<td colspan="2">--scheduler-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the Scheduler or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md
+75 -16
View File
@@ -3,6 +3,7 @@ Generates the API server static Pod manifest.
### Synopsis ### Synopsis
Generates the static Pod manifest file for the API server and saves it into /etc/kubernetes/manifests/kube-apiserver.yaml file. Generates the static Pod manifest file for the API server and saves it into /etc/kubernetes/manifests/kube-apiserver.yaml file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,20 +14,78 @@ kubeadm alpha phase controlplane apiserver [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address of the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value> <col span="1" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") </colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <tbody>
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false) <tr>
CoreDNS=true|false (BETA - default=false) <td colspan="2">--apiserver-advertise-address string</td>
DynamicKubeletConfig=true|false (ALPHA - default=false) </tr>
SelfHosting=true|false (ALPHA - default=false) <tr>
StoreCertsInSecrets=true|false (ALPHA - default=false) <td></td><td style="line-height: 130%">The IP address of the API server is accessible on</td>
-h, --help help for apiserver </tr>
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10")
--service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") <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>
</tr>
<tr>
<td colspan="2">--apiserver-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the API Server or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for apiserver</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>
</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md
+54 -8
View File
@@ -3,6 +3,7 @@ Generates the controller-manager static Pod manifest.
### Synopsis ### Synopsis
Generates the static Pod manifest file for the controller-manager and saves it into /etc/kubernetes/manifests/kube-controller-manager.yaml file. Generates the static Pod manifest file for the controller-manager and saves it into /etc/kubernetes/manifests/kube-controller-manager.yaml file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,12 +14,57 @@ kubeadm alpha phase controlplane controller-manager [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
--controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value> <col span="1" />
-h, --help help for controller-manager </colgroup>
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") <tbody>
--pod-network-cidr string The range of IP addresses used for the Pod network
``` <tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)</td>
</tr>
<tr>
<td colspan="2">--controller-manager-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the Controller Manager or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for controller-manager</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>
</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md
+47 -7
View File
@@ -3,6 +3,7 @@ Generates the scheduler static Pod manifest.
### Synopsis ### Synopsis
Generates the static Pod manifest file for the scheduler and saves it into /etc/kubernetes/manifests/kube-scheduler.yaml file. Generates the static Pod manifest file for the scheduler and saves it into /etc/kubernetes/manifests/kube-scheduler.yaml file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,11 +14,50 @@ kubeadm alpha phase controlplane scheduler [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for scheduler <col span="1" />
--kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") </colgroup>
--scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value> <tbody>
```
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 scheduler</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>
</tr>
<tr>
<td colspan="2">--scheduler-extra-args mapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A set of extra flags to pass to the Scheduler or override default ones in form of &lt;flagname&gt;=&lt;value&gt;</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md
+19 -3
View File
@@ -3,11 +3,27 @@ Generates static Pod manifest file for etcd.
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for etcd <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for etcd</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md
+33 -5
View File
@@ -3,6 +3,7 @@ Generates the static Pod manifest file for a local, single-node etcd instance
### Synopsis ### Synopsis
Generates the static Pod manifest file for a local, single-node etcd instance and saves it to /etc/kubernetes/manifests/etcd.yaml file. Generates the static Pod manifest file for a local, single-node etcd instance and saves it to /etc/kubernetes/manifests/etcd.yaml file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -24,9 +25,36 @@ kubeadm alpha phase etcd local [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <colgroup>
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <col span="1" style="width: 10px;" />
-h, --help help for local <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 local</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md
+19 -3
View File
@@ -3,11 +3,27 @@ Generates all kubeconfig files necessary to establish the control plane and the
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for kubeconfig <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for kubeconfig</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md
+54 -8
View File
@@ -3,6 +3,7 @@ Generates a kubeconfig file for the admin to use and for kubeadm itself
### Synopsis ### Synopsis
Generates the kubeconfig file for the admin and for kubeadm itself, and saves it to admin.conf file. Generates the kubeconfig file for the admin and for kubeadm itself, and saves it to admin.conf file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig admin [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for admin <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
``` <tr>
<td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 admin</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md
+61 -9
View File
@@ -3,6 +3,7 @@ Generates all kubeconfig files necessary to establish the control plane and the
### Synopsis ### Synopsis
Generates all kubeconfig files necessary to establish the control plane and the admin kubeconfig file. Generates all kubeconfig files necessary to establish the control plane and the admin kubeconfig file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -24,13 +25,64 @@ kubeadm alpha phase kubeconfig all [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for all <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
--node-name string The node name that should be used for the kubelet client certificate <tr>
``` <td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 all</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The node name that should be used for the kubelet client certificate</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md
+54 -8
View File
@@ -3,6 +3,7 @@ Generates a kubeconfig file for the controller manager to use
### Synopsis ### Synopsis
Generates the kubeconfig file for the controller manager to use and saves it to /etc/kubernetes/controller-manager.conf file. Generates the kubeconfig file for the controller manager to use and saves it to /etc/kubernetes/controller-manager.conf file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig controller-manager [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for controller-manager <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
``` <tr>
<td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 controller-manager</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md
+61 -9
View File
@@ -3,6 +3,7 @@ Generates a kubeconfig file for the kubelet to use. Please note that this should
### Synopsis ### Synopsis
Generates the kubeconfig file for the kubelet to use and saves it to /etc/kubernetes/kubelet.conf file. Generates the kubeconfig file for the kubelet to use and saves it to /etc/kubernetes/kubelet.conf file.
Please note that this should only be used for bootstrapping purposes. After your control plane is up, you should request all kubelet credentials from the CSR API. Please note that this should only be used for bootstrapping purposes. After your control plane is up, you should request all kubelet credentials from the CSR API.
@@ -15,13 +16,64 @@ kubeadm alpha phase kubeconfig kubelet [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for kubelet <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
--node-name string The node name that should be used for the kubelet client certificate <tr>
``` <td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 kubelet</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The node name that should be used for the kubelet client certificate</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md
+54 -8
View File
@@ -3,6 +3,7 @@ Generates a kubeconfig file for the scheduler to use
### Synopsis ### Synopsis
Generates the kubeconfig file for the scheduler to use and saves it to /etc/kubernetes/scheduler.conf file. Generates the kubeconfig file for the scheduler to use and saves it to /etc/kubernetes/scheduler.conf file.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig scheduler [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) </colgroup>
-h, --help help for scheduler <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
``` <tr>
<td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 scheduler</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md
+61 -9
View File
@@ -3,6 +3,7 @@ Outputs a kubeconfig file for an additional user
### Synopsis ### Synopsis
Outputs a kubeconfig file for an additional user. Outputs a kubeconfig file for an additional user.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -20,13 +21,64 @@ kubeadm alpha phase kubeconfig user [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API server is accessible on <colgroup>
--apiserver-bind-port int32 The port the API server is accessible on (default 6443) <col span="1" style="width: 10px;" />
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <col span="1" />
--client-name string The name of user. It will be used as the CN if client certificates are created </colgroup>
-h, --help help for user <tbody>
--kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes")
--token string The token that should be used as the authentication mechanism for this kubeconfig (instead of client certificates) <tr>
``` <td colspan="2">--apiserver-advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">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>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where certificates are stored</td>
</tr>
<tr>
<td colspan="2">--client-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The name of user. It will be used as the CN if client certificates are created</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for user</td>
</tr>
<tr>
<td colspan="2">--kubeconfig-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The port where to save the kubeconfig file</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The token that should be used as the authentication mechanism for this kubeconfig (instead of client certificates)</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md
+40 -6
View File
@@ -3,6 +3,7 @@ Mark a node as master
### Synopsis ### Synopsis
Applies a label that specifies that a node is a master and a taint that forces workloads to be deployed accordingly. Applies a label that specifies that a node is a master and a taint that forces workloads to be deployed accordingly.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -23,10 +24,43 @@ kubeadm alpha phase mark-master [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <colgroup>
-h, --help help for mark-master <col span="1" style="width: 10px;" />
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" />
--node-name string The node name to which label and taints should apply </colgroup>
``` <tbody>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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 mark-master</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>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The node name to which label and taints should apply</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md
+19 -3
View File
@@ -3,11 +3,27 @@ Run pre-flight checks
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for preflight <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for preflight</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md
+19 -3
View File
@@ -3,6 +3,7 @@ Run master pre-flight checks
### Synopsis ### Synopsis
Run master pre-flight checks, functionally equivalent to what implemented by kubeadm init. Run master pre-flight checks, functionally equivalent to what implemented by kubeadm init.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -20,7 +21,22 @@ kubeadm alpha phase preflight master [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for master <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for master</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md
+19 -3
View File
@@ -3,6 +3,7 @@ Run node pre-flight checks
### Synopsis ### Synopsis
Run node pre-flight checks, functionally equivalent to what implemented by kubeadm join. Run node pre-flight checks, functionally equivalent to what implemented by kubeadm join.
Alpha Disclaimer: this command is currently alpha. Alpha Disclaimer: this command is currently alpha.
@@ -20,7 +21,22 @@ kubeadm alpha phase preflight node [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for node <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for node</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md
+19 -3
View File
@@ -3,11 +3,27 @@ Makes a kubeadm cluster self-hosted
### Synopsis ### Synopsis
This command is not meant to be run on its own. See list of available subcommands. This command is not meant to be run on its own. See list of available subcommands.
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for selfhosting <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for selfhosting</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md
+47 -12
View File
@@ -3,6 +3,7 @@ Converts a static Pod-hosted control plane into a self-hosted one
### Synopsis ### Synopsis
Converts static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API. Converts static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API.
See the documentation for self-hosting limitations. See the documentation for self-hosting limitations.
@@ -25,16 +26,50 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") <colgroup>
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" style="width: 10px;" />
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: <col span="1" />
Auditing=true|false (ALPHA - default=false) </colgroup>
CoreDNS=true|false (BETA - default=false) <tbody>
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false) <tr>
StoreCertsInSecrets=true|false (ALPHA - default=false) <td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
-h, --help help for convert-from-staticpods </tr>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <tr>
``` <td></td><td style="line-height: 130%">The path where certificates are stored</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>
</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for convert-from-staticpods</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md
+33 -5
View File
@@ -3,6 +3,7 @@ Uploads the currently used configuration for kubeadm to a ConfigMap
### Synopsis ### Synopsis
Uploads the kubeadm init configuration of your cluster to a ConfigMap called kubeadm-config in the kube-system namespace. This enables correct configuration of system components and a seamless user experience when upgrading. Uploads the kubeadm init configuration of your cluster to a ConfigMap called kubeadm-config in the kube-system namespace. This enables correct configuration of system components and a seamless user experience when upgrading.
Alternatively, you can use kubeadm config. Alternatively, you can use kubeadm config.
@@ -22,9 +23,36 @@ kubeadm alpha phase upload-config [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! <colgroup>
-h, --help help for upload-config <col span="1" style="width: 10px;" />
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" />
``` </colgroup>
<tbody>
<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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for upload-config</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md
+19 -3
View File
@@ -4,6 +4,7 @@ Output shell completion code for the specified shell (bash or zsh).
### Synopsis ### Synopsis
Output shell completion code for the specified shell (bash or zsh). Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive The shell code must be evaluated to provide interactive
completion of kubeadm commands. This can be done by sourcing it from completion of kubeadm commands. This can be done by sourcing it from
@@ -48,7 +49,22 @@ source <(kubeadm completion zsh)
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for completion <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for completion</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md
+26 -4
View File
@@ -4,6 +4,7 @@ Manage configuration for a kubeadm cluster persisted in a ConfigMap in the clust
### Synopsis ### Synopsis
There is a ConfigMap in the kube-system namespace called "kubeadm-config" that kubeadm uses to store internal configuration about the There is a ConfigMap in the kube-system namespace called "kubeadm-config" that kubeadm uses to store internal configuration about the
cluster. kubeadm CLI v1.8.0+ automatically creates this ConfigMap with the config used with 'kubeadm init', but if you cluster. kubeadm CLI v1.8.0+ automatically creates this ConfigMap with the config used with 'kubeadm init', but if you
initialized your cluster using kubeadm v1.7.x or lower, you must use the 'config upload' command to create this initialized your cluster using kubeadm v1.7.x or lower, you must use the 'config upload' command to create this
@@ -16,8 +17,29 @@ kubeadm config [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for config <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for config</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md
+37 -6
View File
@@ -3,6 +3,7 @@ Upload configuration about the current state, so that 'kubeadm upgrade' can late
### Synopsis ### Synopsis
Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster. Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster.
``` ```
@@ -11,13 +12,43 @@ kubeadm config upload [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for upload <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for upload</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md
+44 -7
View File
@@ -4,6 +4,7 @@ Upload a configuration file to the in-cluster ConfigMap for kubeadm configuratio
### Synopsis ### Synopsis
Using this command, you can upload configuration to the ConfigMap in the cluster using the same config file you gave to 'kubeadm init'. Using this command, you can upload configuration to the ConfigMap in the cluster using the same config file you gave to 'kubeadm init'.
If you initialized your cluster using a v1.7.x or lower kubeadm client and used the --config option, you need to run this command with the If you initialized your cluster using a v1.7.x or lower kubeadm client and used the --config option, you need to run this command with the
same config file before upgrading to v1.8 using 'kubeadm upgrade'. same config file before upgrading to v1.8 using 'kubeadm upgrade'.
@@ -17,14 +18,50 @@ kubeadm config upload from-file [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental. <colgroup>
-h, --help help for from-file <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%">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 from-file</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md
+128 -24
View File
@@ -4,6 +4,7 @@ Create the in-cluster configuration file for the first time from using flags.
### Synopsis ### Synopsis
Using this command, you can upload configuration to the ConfigMap in the cluster using the same flags you gave to 'kubeadm init'. Using this command, you can upload configuration to the ConfigMap in the cluster using the same flags you gave to 'kubeadm init'.
If you initialized your cluster using a v1.7.x or lower kubeadm client and set certain flags, you need to run this command with the If you initialized your cluster using a v1.7.x or lower kubeadm client and set certain flags, you need to run this command with the
same flags before upgrading to v1.8 using 'kubeadm upgrade'. same flags before upgrading to v1.8 using 'kubeadm upgrade'.
@@ -17,31 +18,134 @@ kubeadm config upload from-flags [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface. <colgroup>
--apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) <col span="1" style="width: 10px;" />
--apiserver-cert-extra-sans strings Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names. <col span="1" />
--cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") </colgroup>
--cri-socket string Specify the CRI socket to connect to. (default "/var/run/dockershim.sock") <tbody>
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false) <tr>
CoreDNS=true|false (BETA - default=false) <td colspan="2">--apiserver-advertise-address string</td>
DynamicKubeletConfig=true|false (ALPHA - default=false) </tr>
SelfHosting=true|false (ALPHA - default=false) <tr>
StoreCertsInSecrets=true|false (ALPHA - default=false) <td></td><td style="line-height: 130%">The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.</td>
-h, --help help for from-flags </tr>
--kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1.10")
--node-name string Specify the node name. <tr>
--pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
--service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") </tr>
--service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") <tr>
--token string The token to use for establishing bidirectional trust between nodes and masters. <td></td><td style="line-height: 130%">Port for the API Server to bind to.</td>
--token-ttl duration The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire. (default 24h0m0s) </tr>
```
<tr>
<td colspan="2">--apiserver-cert-extra-sans stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save and store the certificates.</td>
</tr>
<tr>
<td colspan="2">--cri-socket string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/var/run/dockershim.sock"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify the CRI socket to connect to.</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for from-flags</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>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify the node name.</td>
</tr>
<tr>
<td colspan="2">--pod-network-cidr string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.</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%">Use alternative range of IP address 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%">Use alternative domain for services, e.g. "myorg.internal".</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The token to use for establishing bidirectional trust between nodes and masters.</td>
</tr>
<tr>
<td colspan="2">--token-ttl duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md
+37 -6
View File
@@ -4,6 +4,7 @@ View the kubeadm configuration stored inside the cluster.
### Synopsis ### Synopsis
Using this command, you can view the ConfigMap in the cluster where the configuration for kubeadm is located. Using this command, you can view the ConfigMap in the cluster where the configuration for kubeadm is located.
The configuration is located in the "kube-system" namespace in the "kubeadm-config" ConfigMap. The configuration is located in the "kube-system" namespace in the "kubeadm-config" ConfigMap.
@@ -15,13 +16,43 @@ kubeadm config view [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for view <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for view</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md
+138 -25
View File
@@ -3,6 +3,7 @@ Run this command in order to set up the Kubernetes master.
### Synopsis ### Synopsis
Run this command in order to set up the Kubernetes master. Run this command in order to set up the Kubernetes master.
``` ```
@@ -11,29 +12,141 @@ kubeadm init [flags]
### Options ### Options
``` <table style="width: 100%;">
--apiserver-advertise-address string The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface. <colgroup>
--apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) <col span="1" style="width: 10px;" />
--apiserver-cert-extra-sans strings Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names. <col span="1" />
--cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") </colgroup>
--config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental. <tbody>
--cri-socket string Specify the CRI socket to connect to. (default "/var/run/dockershim.sock")
--dry-run Don't apply any changes; just output what would be done. <tr>
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: <td colspan="2">--apiserver-advertise-address string</td>
Auditing=true|false (ALPHA - default=false) </tr>
CoreDNS=true|false (BETA - default=false) <tr>
DynamicKubeletConfig=true|false (ALPHA - default=false) <td></td><td style="line-height: 130%">The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.</td>
SelfHosting=true|false (ALPHA - default=false) </tr>
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help help for init <tr>
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. <td colspan="2">--apiserver-bind-port int32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 6443</td>
--kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1.10") </tr>
--node-name string Specify the node name. <tr>
--pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. <td></td><td style="line-height: 130%">Port for the API Server to bind to.</td>
--service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") </tr>
--service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local")
--skip-token-print Skip printing of the default bootstrap token generated by 'kubeadm init'. <tr>
--token string The token to use for establishing bidirectional trust between nodes and masters. <td colspan="2">--apiserver-cert-extra-sans stringSlice</td>
--token-ttl duration The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire. (default 24h0m0s) </tr>
``` <tr>
<td></td><td style="line-height: 130%">Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.</td>
</tr>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path where to save and store the certificates.</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.</td>
</tr>
<tr>
<td colspan="2">--cri-socket string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/var/run/dockershim.sock"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify the CRI socket to connect to.</td>
</tr>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Don't apply any changes; just output what would be done.</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for init</td>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</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>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify the node name.</td>
</tr>
<tr>
<td colspan="2">--pod-network-cidr string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.</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%">Use alternative range of IP address 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%">Use alternative domain for services, e.g. "myorg.internal".</td>
</tr>
<tr>
<td colspan="2">--skip-token-print</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Skip printing of the default bootstrap token generated by 'kubeadm init'.</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The token to use for establishing bidirectional trust between nodes and masters.</td>
</tr>
<tr>
<td colspan="2">--token-ttl duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md
+96 -19
View File
@@ -4,6 +4,7 @@ Run this on any machine you wish to join an existing cluster
### Synopsis ### Synopsis
When joining a kubeadm initialized cluster, we need to establish When joining a kubeadm initialized cluster, we need to establish
bidirectional trust. This is split into discovery (having the Node bidirectional trust. This is split into discovery (having the Node
trust the Kubernetes Master) and TLS bootstrap (having the Kubernetes trust the Kubernetes Master) and TLS bootstrap (having the Kubernetes
@@ -52,23 +53,99 @@ kubeadm join [flags]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to kubeadm config file. <colgroup>
--cri-socket string Specify the CRI socket to connect to. (default "/var/run/dockershim.sock") <col span="1" style="width: 10px;" />
--discovery-file string A file or url from which to load cluster information. <col span="1" />
--discovery-token string A token used to validate cluster information fetched from the master. </colgroup>
--discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>"). <tbody>
--discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
--feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: <tr>
Auditing=true|false (ALPHA - default=false) <td colspan="2">--config string</td>
CoreDNS=true|false (BETA - default=false) </tr>
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td></td><td style="line-height: 130%">Path to kubeadm config file.</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
-h, --help help for join
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. <tr>
--node-name string Specify the node name. <td colspan="2">--cri-socket string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/var/run/dockershim.sock"</td>
--tls-bootstrap-token string A token used for TLS bootstrapping. </tr>
--token string Use this token for both discovery-token and tls-bootstrap-token. <tr>
``` <td></td><td style="line-height: 130%">Specify the CRI socket to connect to.</td>
</tr>
<tr>
<td colspan="2">--discovery-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A file or url from which to load cluster information.</td>
</tr>
<tr>
<td colspan="2">--discovery-token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A token used to validate cluster information fetched from the master.</td>
</tr>
<tr>
<td colspan="2">--discovery-token-ca-cert-hash stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">For token-based discovery, validate that the root CA public key matches this hash (format: "&lt;type&gt;:&lt;value&gt;").</td>
</tr>
<tr>
<td colspan="2">--discovery-token-unsafe-skip-ca-verification</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.</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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for join</td>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</td>
</tr>
<tr>
<td colspan="2">--node-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specify the node name.</td>
</tr>
<tr>
<td colspan="2">--tls-bootstrap-token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A token used for TLS bootstrapping.</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Use this token for both discovery-token and tls-bootstrap-token.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md
+40 -6
View File
@@ -3,6 +3,7 @@ Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm j
### Synopsis ### Synopsis
Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join'. Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join'.
``` ```
@@ -11,10 +12,43 @@ kubeadm reset [flags]
### Options ### Options
``` <table style="width: 100%;">
--cert-dir string The path to the directory where the certificates are stored. If specified, clean this directory. (default "/etc/kubernetes/pki") <colgroup>
--cri-socket string The path to the CRI socket to use with crictl when cleaning up containers. (default "/var/run/dockershim.sock") <col span="1" style="width: 10px;" />
-h, --help help for reset <col span="1" />
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. </colgroup>
``` <tbody>
<tr>
<td colspan="2">--cert-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/etc/kubernetes/pki"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path to the directory where the certificates are stored. If specified, clean this directory.</td>
</tr>
<tr>
<td colspan="2">--cri-socket string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/var/run/dockershim.sock"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The path to the CRI socket to use with crictl when cleaning up containers.</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for reset</td>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md
+33 -5
View File
@@ -4,6 +4,7 @@ Manage bootstrap tokens.
### Synopsis ### Synopsis
This command manages bootstrap tokens. It is optional and needed only for advanced use cases. This command manages bootstrap tokens. It is optional and needed only for advanced use cases.
In short, bootstrap tokens are used for establishing bidirectional trust between a client and a server. In short, bootstrap tokens are used for establishing bidirectional trust between a client and a server.
@@ -28,9 +29,36 @@ kubeadm token [flags]
### Options ### Options
``` <table style="width: 100%;">
--dry-run Whether to enable dry-run mode or not <colgroup>
-h, --help help for token <col span="1" style="width: 10px;" />
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" />
``` </colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Whether to enable dry-run mode or not</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for 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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md
+86 -13
View File
@@ -4,6 +4,7 @@ Create bootstrap tokens on the server.
### Synopsis ### Synopsis
This command will create a bootstrap token for you. This command will create a bootstrap token for you.
You can specify the usages for this token, the "time to live" and an optional human friendly description. You can specify the usages for this token, the "time to live" and an optional human friendly description.
@@ -18,20 +19,92 @@ kubeadm token create [token]
### Options ### Options
``` <table style="width: 100%;">
--config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) <colgroup>
--description string A human friendly description of how this token is used. <col span="1" style="width: 10px;" />
--groups strings Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]". (default [system:bootstrappers:kubeadm:default-node-token]) <col span="1" />
-h, --help help for create </colgroup>
--print-join-command Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token. <tbody>
--ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire. (default 24h0m0s)
--usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]. (default [signing,authentication]) <tr>
``` <td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)</td>
</tr>
<tr>
<td colspan="2">--description string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A human friendly description of how this token is used.</td>
</tr>
<tr>
<td colspan="2">--groups stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [system:bootstrappers:kubeadm:default-node-token]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]".</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for create</td>
</tr>
<tr>
<td colspan="2">--print-join-command</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.</td>
</tr>
<tr>
<td colspan="2">--ttl duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire.</td>
</tr>
<tr>
<td colspan="2">--usages stringSlice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: [signing,authentication]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication].</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--dry-run Whether to enable dry-run mode or not <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Whether to enable dry-run mode or not</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md
+44 -7
View File
@@ -4,6 +4,7 @@ Delete bootstrap tokens on the server.
### Synopsis ### Synopsis
This command will delete a given bootstrap token for you. This command will delete a given bootstrap token for you.
The [token-value] is the full Token of the form "[a-z0-9]{6}.[a-z0-9]{16}" or the The [token-value] is the full Token of the form "[a-z0-9]{6}.[a-z0-9]{16}" or the
@@ -16,14 +17,50 @@ kubeadm token delete [token-value]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for delete <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for delete</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--dry-run Whether to enable dry-run mode or not <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Whether to enable dry-run mode or not</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md
+44 -7
View File
@@ -4,6 +4,7 @@ Generate and print a bootstrap token, but do not create it on the server.
### Synopsis ### Synopsis
This command will print out a randomly-generated bootstrap token that can be used with This command will print out a randomly-generated bootstrap token that can be used with
the "init" and "join" commands. the "init" and "join" commands.
@@ -21,14 +22,50 @@ kubeadm token generate [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for generate <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for generate</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--dry-run Whether to enable dry-run mode or not <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Whether to enable dry-run mode or not</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md
+44 -7
View File
@@ -4,6 +4,7 @@ List bootstrap tokens on the server.
### Synopsis ### Synopsis
This command will list all bootstrap tokens for you. This command will list all bootstrap tokens for you.
@@ -13,14 +14,50 @@ kubeadm token list [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for list <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for list</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--dry-run Whether to enable dry-run mode or not <colgroup>
--kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Whether to enable dry-run mode or not</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>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md
+68 -15
View File
@@ -3,6 +3,7 @@ Upgrade your cluster smoothly to a newer version with this command.
### Synopsis ### Synopsis
Upgrade your cluster smoothly to a newer version with this command. Upgrade your cluster smoothly to a newer version with this command.
``` ```
@@ -11,19 +12,71 @@ kubeadm upgrade [flags]
### Options ### Options
``` <table style="width: 100%;">
--allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. <colgroup>
--allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. <col span="1" style="width: 10px;" />
--config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" />
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: </colgroup>
Auditing=true|false (ALPHA - default=false) <tbody>
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td colspan="2">--allow-experimental-upgrades</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
-h, --help help for upgrade <tr>
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. <td></td><td style="line-height: 130%">Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.</td>
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") </tr>
--print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not.
``` <tr>
<td colspan="2">--allow-release-candidate-upgrades</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for upgrade</td>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</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>
</tr>
<tr>
<td colspan="2">--print-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specifies whether the configuration file that will be used in the upgrade should be printed or not.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md
+114 -22
View File
@@ -3,6 +3,7 @@ Upgrade your Kubernetes cluster to the specified version.
### Synopsis ### Synopsis
Upgrade your Kubernetes cluster to the specified version. Upgrade your Kubernetes cluster to the specified version.
``` ```
@@ -11,29 +12,120 @@ kubeadm upgrade apply [version]
### Options ### Options
``` <table style="width: 100%;">
--dry-run Do not change any state, just output what actions would be performed. <colgroup>
--etcd-upgrade Perform the upgrade of etcd. (default true) <col span="1" style="width: 10px;" />
-f, --force Force upgrading although some requirements might not be met. This also implies non-interactive mode. <col span="1" />
-h, --help help for apply </colgroup>
--image-pull-timeout duration The maximum amount of time to wait for the control plane pods to be downloaded. (default 15m0s) <tbody>
-y, --yes Perform the upgrade and do not prompt for confirmation (non-interactive mode).
``` <tr>
<td colspan="2">--dry-run</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Do not change any state, just output what actions would be performed.</td>
</tr>
<tr>
<td colspan="2">--etcd-upgrade&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Perform the upgrade of etcd.</td>
</tr>
<tr>
<td colspan="2">-f, --force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Force upgrading although some requirements might not be met. This also implies non-interactive mode.</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for apply</td>
</tr>
<tr>
<td colspan="2">--image-pull-timeout duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 15m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">The maximum amount of time to wait for the control plane pods to be downloaded.</td>
</tr>
<tr>
<td colspan="2">-y, --yes</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Perform the upgrade and do not prompt for confirmation (non-interactive mode).</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. <colgroup>
--allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. <col span="1" style="width: 10px;" />
--config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" />
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: </colgroup>
Auditing=true|false (ALPHA - default=false) <tbody>
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td colspan="2">--allow-experimental-upgrades</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. <tr>
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <td></td><td style="line-height: 130%">Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.</td>
--print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. </tr>
```
<tr>
<td colspan="2">--allow-release-candidate-upgrades</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</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>
</tr>
<tr>
<td colspan="2">--print-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specifies whether the configuration file that will be used in the upgrade should be printed or not.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md
+79 -17
View File
@@ -3,6 +3,7 @@ Check which versions are available to upgrade to and validate whether your curre
### Synopsis ### Synopsis
Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. Check which versions are available to upgrade to and validate whether your current cluster is upgradeable.
``` ```
@@ -11,24 +12,85 @@ kubeadm upgrade plan [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for plan <colgroup>
``` <col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for plan</td>
</tr>
</tbody>
</table>
### Options inherited from parent commands ### Options inherited from parent commands
``` <table style="width: 100%;">
--allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. <colgroup>
--allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. <col span="1" style="width: 10px;" />
--config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! <col span="1" />
--feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: </colgroup>
Auditing=true|false (ALPHA - default=false) <tbody>
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false) <tr>
SelfHosting=true|false (ALPHA - default=false) <td colspan="2">--allow-experimental-upgrades</td>
StoreCertsInSecrets=true|false (ALPHA - default=false) </tr>
--ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. <tr>
--kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") <td></td><td style="line-height: 130%">Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.</td>
--print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. </tr>
```
<tr>
<td colspan="2">--allow-release-candidate-upgrades</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Path to 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>
</tr>
<tr>
<td colspan="2">--ignore-preflight-errors stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</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>
</tr>
<tr>
<td colspan="2">--print-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Specifies whether the configuration file that will be used in the upgrade should be printed or not.</td>
</tr>
</tbody>
</table>
docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md
+26 -4
View File
@@ -3,6 +3,7 @@ Print the version of kubeadm
### Synopsis ### Synopsis
Print the version of kubeadm Print the version of kubeadm
``` ```
@@ -11,8 +12,29 @@ kubeadm version [flags]
### Options ### Options
``` <table style="width: 100%;">
-h, --help help for version <colgroup>
-o, --output string Output format; available options are 'yaml', 'json' and 'short' <col span="1" style="width: 10px;" />
``` <col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">help for version</td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%">Output format; available options are 'yaml', 'json' and 'short'</td>
</tr>
</tbody>
</table>