diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm.md index 04b1b8cc4a..4dfddf9c61 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm.md @@ -4,6 +4,7 @@ kubeadm: easily bootstrap a secure Kubernetes cluster ### Synopsis + kubeadm: easily bootstrap a secure Kubernetes cluster. ┌──────────────────────────────────────────────────────────┐ @@ -38,7 +39,22 @@ Example usage: ### Options -``` - -h, --help help for kubeadm -``` + + + + + + + + + + + + + + + +
-h, --help
help for kubeadm
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md index e50806bbe5..63bcf58f03 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md @@ -3,11 +3,27 @@ Experimental sub-commands not yet fully functional. ### Synopsis + Experimental sub-commands not yet fully functional. ### Options -``` - -h, --help help for alpha -``` + + + + + + + + + + + + + + + +
-h, --help
help for alpha
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md index 910003b190..f72c52b0dc 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md @@ -3,11 +3,27 @@ Invoke subsets of kubeadm functions separately for a manual install. ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for phase -``` + + + + + + + + + + + + + + + +
-h, --help
help for phase
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md index f6a02c66e6..f293951dbd 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md @@ -3,11 +3,27 @@ Installs required addons for passing Conformance tests ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for addon -``` + + + + + + + + + + + + + + + +
-h, --help
help for addon
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md index c893035845..c83bbda153 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md @@ -3,6 +3,7 @@ Installs all addons to a Kubernetes cluster ### Synopsis + Installs the kube-dns and the kube-proxys addons components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. @@ -23,22 +24,92 @@ kubeadm alpha phase addon all [flags] ### Options -``` - --apiserver-advertise-address string The IP address or DNS name the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for all - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --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") - --pod-network-cidr string The range of IP addresses used for the Pod network - --service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") - --service-dns-domain string Alternative domain for services (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod network
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md index 4e021f1fa0..c9be9dc6ad 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md @@ -3,6 +3,7 @@ Installs the kube-dns addon to a Kubernetes cluster ### Synopsis + 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. @@ -14,19 +15,71 @@ kubeadm alpha phase addon kube-dns [flags] ### Options -``` - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for kube-dns - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --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") - --service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") - --service-dns-domain string Alternative domain for services (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for kube-dns
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md index 32bfc1e8f6..534834950b 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md @@ -3,6 +3,7 @@ Installs the kube-proxy addon to a Kubernetes cluster ### Synopsis + Installs the kube-proxy addon components via the API server. Alpha Disclaimer: this command is currently alpha. @@ -13,14 +14,71 @@ kubeadm alpha phase addon kube-proxy [flags] ### Options -``` - --apiserver-advertise-address string The IP address or DNS name the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! - -h, --help help for kube-proxy - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --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") - --pod-network-cidr string The range of IP addresses used for the Pod network -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
-h, --help
help for kube-proxy
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod network
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md index cf7f2e3256..8629089198 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md @@ -3,12 +3,34 @@ Manage kubeadm-specific bootstrap token functions ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for bootstrap-token - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for bootstrap-token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md index e1f5f8376c..a595bd4b98 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md @@ -3,6 +3,7 @@ Makes all the bootstrap token configurations and creates an initial token ### Synopsis + 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. @@ -23,20 +24,92 @@ kubeadm alpha phase bootstrap-token all [flags] ### Options -``` - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.") - --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]) - -h, --help help for all - --skip-token-print Skip printing of the bootstrap token - --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) - --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]) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."
A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"
-h, --help
help for all
--skip-token-print
Skip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and masters
--ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
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]
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md index e2374ceadc..f8ad6866e3 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md @@ -3,6 +3,7 @@ Uploads the cluster-info ConfigMap from the given kubeconfig file ### 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. See online documentation about Authenticating with Bootstrap Tokens for more details. @@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] ### Options -``` - -h, --help help for cluster-info -``` + + + + + + + + + + + + + + + +
-h, --help
help for cluster-info
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md index 4fe2f29797..7515ef09ed 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md @@ -3,6 +3,7 @@ Creates a bootstrap token to be used for node joining ### Synopsis + Creates a bootstrap token. If no token value is given, kubeadm will generate a random token instead. Alternatively, you can use kubeadm token. @@ -15,20 +16,92 @@ kubeadm alpha phase bootstrap-token create [flags] ### Options -``` - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --description string A human friendly description of how this token is used. (default "The default bootstrap token generated by 'kubeadm init'.") - --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]) - -h, --help help for create - --skip-token-print Skip printing of the bootstrap token - --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) - --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]) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."
A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"
-h, --help
help for create
--skip-token-print
Skip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and masters
--ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
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]
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md index 200e70e30d..0ec18d7eac 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md @@ -3,17 +3,48 @@ Configures the node bootstrap process ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for node -``` + + + + + + + + + + + + + + + +
-h, --help
help for node
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md index aecd7a6380..dcbd443e3e 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md @@ -3,6 +3,7 @@ Configures RBAC rules to allow the csrapprover controller automatically approve ### 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). See online documentation about TLS bootstrapping for more details. @@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] ### Options -``` - -h, --help help for allow-auto-approve -``` + + + + + + + + + + + + + + + +
-h, --help
help for allow-auto-approve
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md index 4b0af3bde8..7fa3f3043b 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md @@ -3,6 +3,7 @@ Configures RBAC to allow node bootstrap tokens to post CSRs in order for nodes t ### 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. See online documentation about TLS bootstrapping for more details. @@ -15,13 +16,43 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] ### Options -``` - -h, --help help for allow-post-csrs -``` + + + + + + + + + + + + + + + +
-h, --help
help for allow-post-csrs
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md index 39ba4069a6..e780478c15 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md @@ -3,11 +3,27 @@ Generates certificates for a Kubernetes cluster ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for certs -``` + + + + + + + + + + + + + + + +
-h, --help
help for certs
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md index 95326e97fb..b9eb8eb92e 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md @@ -3,6 +3,7 @@ Generates all PKI assets necessary to establish the control plane ### 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. 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 -``` - --apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert - --apiserver-cert-extra-sans strings Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for all - --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") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for all
--service-cidr string     Default: "10.96.0.0/12"
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
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving cert
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md index 8d2ab2d973..9968b1e833 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md @@ -3,6 +3,7 @@ Generates a client certificate for the API server to connect to etcd securely ### 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. 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 -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for apiserver-etcd-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for apiserver-etcd-client
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md index af78ae678f..af8d9cb7ae 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md @@ -3,6 +3,7 @@ Generates a client certificate for the API server to connect to the kubelets sec ### 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. 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 -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for apiserver-kubelet-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for apiserver-kubelet-client
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md index 4761dda918..a4c6b1d03a 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md @@ -3,6 +3,7 @@ Generates an API server serving certificate and key ### Synopsis + 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: , , kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc. , (that is the .10 address in address space). @@ -17,13 +18,64 @@ kubeadm alpha phase certs apiserver [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on, to use for the API server serving cert - --apiserver-cert-extra-sans strings Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for apiserver - --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") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for apiserver
--service-cidr string     Default: "10.96.0.0/12"
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
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving cert
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md index 2b78186b3c..840a798335 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md @@ -3,6 +3,7 @@ Generates a self-signed kubernetes CA to provision identities for components of ### Synopsis + 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. @@ -15,9 +16,36 @@ kubeadm alpha phase certs ca [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for ca
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md index 30397cc029..d3e04a46ac 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md @@ -3,6 +3,7 @@ Generates a self-signed CA to provision identities for etcd ### Synopsis + 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. @@ -15,9 +16,36 @@ kubeadm alpha phase certs etcd-ca [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for etcd-ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for etcd-ca
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md index 88d75987e5..ecc45cc06b 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md @@ -3,6 +3,7 @@ Generates a client certificate for liveness probes to healthcheck etcd ### 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. 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 -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for etcd-healthcheck-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for etcd-healthcheck-client
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md index d4903164f8..54942af8ec 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md @@ -3,6 +3,7 @@ Generates an etcd peer certificate and key ### Synopsis + 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: , . @@ -17,9 +18,36 @@ kubeadm alpha phase certs etcd-peer [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for etcd-peer -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for etcd-peer
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md index f07cb16072..704b0aecc9 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md @@ -3,6 +3,7 @@ Generates an etcd serving certificate and key ### Synopsis + 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. @@ -17,9 +18,36 @@ kubeadm alpha phase certs etcd-server [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for etcd-server -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for etcd-server
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md index bf2a7b7601..89d58039d6 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md @@ -3,6 +3,7 @@ Generates a front proxy CA certificate and key for a Kubernetes cluster ### Synopsis + 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. @@ -15,9 +16,36 @@ kubeadm alpha phase certs front-proxy-ca [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for front-proxy-ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for front-proxy-ca
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md index 10936cf09d..ace2d64d1d 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md @@ -3,6 +3,7 @@ Generates a front proxy CA client certificate and key for a Kubernetes cluster ### Synopsis + 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. @@ -15,9 +16,36 @@ kubeadm alpha phase certs front-proxy-client [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for front-proxy-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for front-proxy-client
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md index 3af8b4c48a..15eda50f3c 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md @@ -3,6 +3,7 @@ Generates a private key for signing service account tokens along with its public ### 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. 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 -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for sa -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for sa
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md index ed13091458..9cd09759d5 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md @@ -3,11 +3,27 @@ Generates all static Pod manifest files necessary to establish the control plane ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for controlplane -``` + + + + + + + + + + + + + + + +
-h, --help
help for controlplane
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md index f802d0ae89..d2fd4bc44a 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md @@ -3,6 +3,7 @@ Generates all static Pod manifest files necessary to establish the control plane ### Synopsis + Generates all static Pod manifest files necessary to establish the control plane. Alpha Disclaimer: this command is currently alpha. @@ -24,23 +25,99 @@ kubeadm alpha phase controlplane all [flags] ### Options -``` - --apiserver-advertise-address string The IP address of the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of = - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of = - --feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for all - --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 - --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = - --service-cidr string The range of IP address used for service VIPs (default "10.96.0.0/12") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--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:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for all
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod network
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md index 35998d6e28..8a8d758b89 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md @@ -3,6 +3,7 @@ Generates the API server static Pod manifest. ### Synopsis + 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. @@ -13,20 +14,78 @@ kubeadm alpha phase controlplane apiserver [flags] ### Options -``` - --apiserver-advertise-address string The IP address of the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of = - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for apiserver - --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") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for apiserver
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md index 35b19702e7..85bee32946 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md @@ -3,6 +3,7 @@ Generates the controller-manager static Pod manifest. ### Synopsis + 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. @@ -13,12 +14,57 @@ kubeadm alpha phase controlplane controller-manager [flags] ### Options -``` - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of = - -h, --help help for controller-manager - --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 -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--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>
-h, --help
help for controller-manager
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod network
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md index efab07120e..8c6d1daca6 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md @@ -3,6 +3,7 @@ Generates the scheduler static Pod manifest. ### Synopsis + 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. @@ -13,11 +14,50 @@ kubeadm alpha phase controlplane scheduler [flags] ### Options -``` - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for scheduler - --kubernetes-version string Choose a specific Kubernetes version for the control plane (default "stable-1.10") - --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for scheduler
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md index 62a0c62a7f..85cada5d43 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md @@ -3,11 +3,27 @@ Generates static Pod manifest file for etcd. ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for etcd -``` + + + + + + + + + + + + + + + +
-h, --help
help for etcd
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md index 641cc1f7f3..9b99b855c8 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md @@ -3,6 +3,7 @@ Generates the static Pod manifest file for a local, single-node etcd instance ### Synopsis + 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. @@ -24,9 +25,36 @@ kubeadm alpha phase etcd local [flags] ### Options -``` - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for local -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for local
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md index b54f576fd1..9357bae592 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md @@ -3,11 +3,27 @@ Generates all kubeconfig files necessary to establish the control plane and the ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for kubeconfig -``` + + + + + + + + + + + + + + + +
-h, --help
help for kubeconfig
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md index 2a4d68e37b..b3b0e8c28d 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md @@ -3,6 +3,7 @@ Generates a kubeconfig file for the admin to use and for kubeadm itself ### Synopsis + 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. @@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig admin [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for admin - --kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for admin
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md index 53044fcc43..cd72365ae5 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md @@ -3,6 +3,7 @@ Generates all kubeconfig files necessary to establish the control plane and the ### Synopsis + Generates all kubeconfig files necessary to establish the control plane and the admin kubeconfig file. Alpha Disclaimer: this command is currently alpha. @@ -24,13 +25,64 @@ kubeadm alpha phase kubeconfig all [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for all - --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 -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for all
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificate
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md index a68635e925..87a07d1bd5 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md @@ -3,6 +3,7 @@ Generates a kubeconfig file for the controller manager to use ### Synopsis + 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. @@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig controller-manager [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for controller-manager - --kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for controller-manager
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md index 0de4158adf..5d5129756c 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md @@ -3,6 +3,7 @@ Generates a kubeconfig file for the kubelet to use. Please note that this should ### Synopsis + 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. @@ -15,13 +16,64 @@ kubeadm alpha phase kubeconfig kubelet [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for kubelet - --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 -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for kubelet
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificate
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md index 349ec85671..5a5551d891 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md @@ -3,6 +3,7 @@ Generates a kubeconfig file for the scheduler to use ### Synopsis + 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. @@ -13,12 +14,57 @@ kubeadm alpha phase kubeconfig scheduler [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for scheduler - --kubeconfig-dir string The port where to save the kubeconfig file (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for scheduler
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md index 565d78f02a..0813ad24ea 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md @@ -3,6 +3,7 @@ Outputs a kubeconfig file for an additional user ### Synopsis + Outputs a kubeconfig file for an additional user. Alpha Disclaimer: this command is currently alpha. @@ -20,13 +21,64 @@ kubeadm alpha phase kubeconfig user [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --client-name string The name of user. It will be used as the CN if client certificates are created - -h, --help help for user - --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) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--client-name string
The name of user. It will be used as the CN if client certificates are created
-h, --help
help for user
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig file
--token string
The token that should be used as the authentication mechanism for this kubeconfig (instead of client certificates)
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md index 5d916dd769..f1df1a88c6 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md @@ -3,6 +3,7 @@ Mark a node as master ### Synopsis + 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. @@ -23,10 +24,43 @@ kubeadm alpha phase mark-master [flags] ### Options -``` - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - -h, --help help for mark-master - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") - --node-name string The node name to which label and taints should apply -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for mark-master
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--node-name string
The node name to which label and taints should apply
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md index 12bb4cdbd1..5156b96fd9 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md @@ -3,11 +3,27 @@ Run pre-flight checks ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for preflight -``` + + + + + + + + + + + + + + + +
-h, --help
help for preflight
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md index e602621719..b42b1bc7c2 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md @@ -3,6 +3,7 @@ Run master pre-flight checks ### Synopsis + Run master pre-flight checks, functionally equivalent to what implemented by kubeadm init. Alpha Disclaimer: this command is currently alpha. @@ -20,7 +21,22 @@ kubeadm alpha phase preflight master [flags] ### Options -``` - -h, --help help for master -``` + + + + + + + + + + + + + + + +
-h, --help
help for master
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md index 18844acad1..34a2ee9873 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md @@ -3,6 +3,7 @@ Run node pre-flight checks ### Synopsis + Run node pre-flight checks, functionally equivalent to what implemented by kubeadm join. Alpha Disclaimer: this command is currently alpha. @@ -20,7 +21,22 @@ kubeadm alpha phase preflight node [flags] ### Options -``` - -h, --help help for node -``` + + + + + + + + + + + + + + + +
-h, --help
help for node
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md index 2bd8f4999c..1815a4afa1 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md @@ -3,11 +3,27 @@ Makes a kubeadm cluster self-hosted ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for selfhosting -``` + + + + + + + + + + + + + + + +
-h, --help
help for selfhosting
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md index 72f49a4beb..548f4a3a42 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md @@ -3,6 +3,7 @@ Converts a static Pod-hosted control plane into a self-hosted one ### Synopsis + Converts static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API. See the documentation for self-hosting limitations. @@ -25,16 +26,50 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags] ### Options -``` - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for convert-from-staticpods - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for convert-from-staticpods
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md index 5d2250b8e9..8ba97c8914 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md @@ -3,6 +3,7 @@ Uploads the currently used configuration for kubeadm to a ConfigMap ### 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. Alternatively, you can use kubeadm config. @@ -22,9 +23,36 @@ kubeadm alpha phase upload-config [flags] ### Options -``` - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental! - -h, --help help for upload-config - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!
-h, --help
help for upload-config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md index 9ff02c3b9a..392a006cc6 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md @@ -4,6 +4,7 @@ Output shell completion code for the specified shell (bash or zsh). ### Synopsis + Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubeadm commands. This can be done by sourcing it from @@ -48,7 +49,22 @@ source <(kubeadm completion zsh) ### Options -``` - -h, --help help for completion -``` + + + + + + + + + + + + + + + +
-h, --help
help for completion
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md index fd50c17110..97a7460d28 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md @@ -4,6 +4,7 @@ Manage configuration for a kubeadm cluster persisted in a ConfigMap in the clust ### Synopsis + 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 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 -``` - -h, --help help for config - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md index 1221d78444..6b349c6033 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md @@ -3,6 +3,7 @@ Upload configuration about the current state, so that 'kubeadm upgrade' can late ### Synopsis + 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 -``` - -h, --help help for upload -``` + + + + + + + + + + + + + + + +
-h, --help
help for upload
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md index d1e2bfe45e..ce9ecef53b 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md @@ -4,6 +4,7 @@ Upload a configuration file to the in-cluster ConfigMap for kubeadm configuratio ### Synopsis + 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 same config file before upgrading to v1.8 using 'kubeadm upgrade'. @@ -17,14 +18,50 @@ kubeadm config upload from-file [flags] ### Options -``` - --config string Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental. - -h, --help help for from-file -``` + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for from-file
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md index 68bfc3ec66..abae4d5316 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md @@ -4,6 +4,7 @@ Create the in-cluster configuration file for the first time from using flags. ### Synopsis + 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 same flags before upgrading to v1.8 using 'kubeadm upgrade'. @@ -17,31 +18,134 @@ kubeadm config upload from-flags [flags] ### Options -``` - --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. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --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. - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --cri-socket string Specify the CRI socket to connect to. (default "/var/run/dockershim.sock") - --feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for from-flags - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1.10") - --node-name string Specify the node name. - --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. - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") - --token string The token to use for establishing bidirectional trust between nodes and masters. - --token-ttl duration The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire. (default 24h0m0s) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--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.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for from-flags
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.
--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.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
--token string
The token to use for establishing bidirectional trust between nodes and masters.
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md index 3e4ea11198..a2ded40f2d 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md @@ -4,6 +4,7 @@ View the kubeadm configuration stored inside the cluster. ### Synopsis + 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. @@ -15,13 +16,43 @@ kubeadm config view [flags] ### Options -``` - -h, --help help for view -``` + + + + + + + + + + + + + + + +
-h, --help
help for view
+ + ### Options inherited from parent commands -``` - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md index e3850c08d4..d9139f947e 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md @@ -3,6 +3,7 @@ Run this command in order to set up the Kubernetes master. ### Synopsis + Run this command in order to set up the Kubernetes master. ``` @@ -11,29 +12,141 @@ kubeadm init [flags] ### Options -``` - --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. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --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. - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental. - --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. - --feature-gates string A set of key=value pairs that describe feature gates for various features. Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for init - --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. - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1.10") - --node-name string Specify the node name. - --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. - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --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'. - --token string The token to use for establishing bidirectional trust between nodes and masters. - --token-ttl duration The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire. (default 24h0m0s) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--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.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.
--dry-run
Don't apply any changes; just output what would be done.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for init
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.
--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.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.
--token string
The token to use for establishing bidirectional trust between nodes and masters.
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md index a0cfd444ac..88388b2be4 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md @@ -4,6 +4,7 @@ Run this on any machine you wish to join an existing cluster ### Synopsis + When joining a kubeadm initialized cluster, we need to establish bidirectional trust. This is split into discovery (having the Node trust the Kubernetes Master) and TLS bootstrap (having the Kubernetes @@ -52,23 +53,99 @@ kubeadm join [flags] ### Options -``` - --config string Path to kubeadm config file. - --cri-socket string Specify the CRI socket to connect to. (default "/var/run/dockershim.sock") - --discovery-file string A file or url from which to load cluster information. - --discovery-token string A token used to validate cluster information fetched from the master. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --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: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -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. - --node-name string Specify the node name. - --tls-bootstrap-token string A token used for TLS bootstrapping. - --token string Use this token for both discovery-token and tls-bootstrap-token. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.
--discovery-file string
A file or url from which to load cluster information.
--discovery-token string
A token used to validate cluster information fetched from the master.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--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:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for join
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--node-name string
Specify the node name.
--tls-bootstrap-token string
A token used for TLS bootstrapping.
--token string
Use this token for both discovery-token and tls-bootstrap-token.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md index d0416a5377..49036f02a3 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md @@ -3,6 +3,7 @@ Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm j ### Synopsis + Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join'. ``` @@ -11,10 +12,43 @@ kubeadm reset [flags] ### Options -``` - --cert-dir string The path to the directory where the certificates are stored. If specified, clean this directory. (default "/etc/kubernetes/pki") - --cri-socket string The path to the CRI socket to use with crictl when cleaning up containers. (default "/var/run/dockershim.sock") - -h, --help help for reset - --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. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path to the directory where the certificates are stored. If specified, clean this directory.
--cri-socket string     Default: "/var/run/dockershim.sock"
The path to the CRI socket to use with crictl when cleaning up containers.
-h, --help
help for reset
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md index 9cccec30f5..a4dfb9a605 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md @@ -4,6 +4,7 @@ Manage bootstrap tokens. ### Synopsis + 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. @@ -28,9 +29,36 @@ kubeadm token [flags] ### Options -``` - --dry-run Whether to enable dry-run mode or not - -h, --help help for token - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
-h, --help
help for token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md index 1539a65475..f2622eae98 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md @@ -4,6 +4,7 @@ Create bootstrap tokens on the server. ### Synopsis + 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. @@ -18,20 +19,92 @@ kubeadm token create [token] ### Options -``` - --config string Path to kubeadm config file (WARNING: Usage of a configuration file is experimental) - --description string A human friendly description of how this token is used. - --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]) - -h, --help help for create - --print-join-command Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token. - --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]) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string
A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]".
-h, --help
help for create
--print-join-command
Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.
--ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire.
--usages stringSlice     Default: [signing,authentication]
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].
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md index 6b0a0985c7..8a3c1b1624 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md @@ -4,6 +4,7 @@ Delete bootstrap tokens on the server. ### Synopsis + 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 @@ -16,14 +17,50 @@ kubeadm token delete [token-value] ### Options -``` - -h, --help help for delete -``` + + + + + + + + + + + + + + + +
-h, --help
help for delete
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md index 23ce269833..35c70727fd 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md @@ -4,6 +4,7 @@ Generate and print a bootstrap token, but do not create it on the server. ### Synopsis + This command will print out a randomly-generated bootstrap token that can be used with the "init" and "join" commands. @@ -21,14 +22,50 @@ kubeadm token generate [flags] ### Options -``` - -h, --help help for generate -``` + + + + + + + + + + + + + + + +
-h, --help
help for generate
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md index 0723ba84c0..dd1726026b 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md @@ -4,6 +4,7 @@ List bootstrap tokens on the server. ### Synopsis + This command will list all bootstrap tokens for you. @@ -13,14 +14,50 @@ kubeadm token list [flags] ### Options -``` - -h, --help help for list -``` + + + + + + + + + + + + + + + +
-h, --help
help for list
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The KubeConfig file to use when talking to the cluster (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md index 4f9b7f9595..5c6ba4673d 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md @@ -3,6 +3,7 @@ Upgrade your cluster smoothly to a newer version with this command. ### Synopsis + Upgrade your cluster smoothly to a newer version with this command. ``` @@ -11,19 +12,71 @@ kubeadm upgrade [flags] ### Options -``` - --allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. - --allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. - --config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - -h, --help help for upgrade - --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. - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") - --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for upgrade
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md index fed14151d7..df44de32d6 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md @@ -3,6 +3,7 @@ Upgrade your Kubernetes cluster to the specified version. ### Synopsis + Upgrade your Kubernetes cluster to the specified version. ``` @@ -11,29 +12,120 @@ kubeadm upgrade apply [version] ### Options -``` - --dry-run Do not change any state, just output what actions would be performed. - --etcd-upgrade Perform the upgrade of etcd. (default true) - -f, --force Force upgrading although some requirements might not be met. This also implies non-interactive mode. - -h, --help help for apply - --image-pull-timeout duration The maximum amount of time to wait for the control plane pods to be downloaded. (default 15m0s) - -y, --yes Perform the upgrade and do not prompt for confirmation (non-interactive mode). -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Do not change any state, just output what actions would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.
-f, --force
Force upgrading although some requirements might not be met. This also implies non-interactive mode.
-h, --help
help for apply
--image-pull-timeout duration     Default: 15m0s
The maximum amount of time to wait for the control plane pods to be downloaded.
-y, --yes
Perform the upgrade and do not prompt for confirmation (non-interactive mode).
+ + ### Options inherited from parent commands -``` - --allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. - --allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. - --config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - --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. - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") - --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md index 1d0e6a0134..55bff85193 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md @@ -3,6 +3,7 @@ Check which versions are available to upgrade to and validate whether your curre ### Synopsis + 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 -``` - -h, --help help for plan -``` + + + + + + + + + + + + + + + +
-h, --help
help for plan
+ + ### Options inherited from parent commands -``` - --allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. - --allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. - --config string Path to kubeadm config file. WARNING: Usage of a configuration file is experimental! - --feature-gates string A set of key=value pairs that describe feature gates for various features.Options are: -Auditing=true|false (ALPHA - default=false) -CoreDNS=true|false (BETA - default=false) -DynamicKubeletConfig=true|false (ALPHA - default=false) -SelfHosting=true|false (ALPHA - default=false) -StoreCertsInSecrets=true|false (ALPHA - default=false) - --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. - --kubeconfig string The KubeConfig file to use when talking to the cluster. (default "/etc/kubernetes/admin.conf") - --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + diff --git a/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md b/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md index fd56ee78cc..52cbb40aa4 100644 --- a/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +++ b/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md @@ -3,6 +3,7 @@ Print the version of kubeadm ### Synopsis + Print the version of kubeadm ``` @@ -11,8 +12,29 @@ kubeadm version [flags] ### Options -``` - -h, --help help for version - -o, --output string Output format; available options are 'yaml', 'json' and 'short' -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for version
-o, --output string
Output format; available options are 'yaml', 'json' and 'short'
+ +