diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md index 3d11478167..3758917b6b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md @@ -5,7 +5,6 @@ kubeadm: easily bootstrap a secure Kubernetes cluster - ┌──────────────────────────────────────────────────────────┐ │ KUBEADM │ │ Easily bootstrap a secure Kubernetes cluster │ @@ -38,29 +37,8 @@ Example usage: ### Options - - - - - - - - - - - - - - - - - - - - - - -
-h, --help
help for kubeadm
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + -h, --help help for kubeadm + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md index ced9d4b528..4211c0b57e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md @@ -3,48 +3,17 @@ Kubeadm experimental sub-commands ### Synopsis - Kubeadm experimental sub-commands ### Options - - - - - - - - - - - - - - - -
-h, --help
help for alpha
- - +``` + -h, --help help for alpha +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md index 8548203f74..8ddf61d005 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md @@ -3,48 +3,17 @@ Commands related to handling kubernetes certificates ### Synopsis - Commands related to handling kubernetes certificates ### Options - - - - - - - - - - - - - - - -
-h, --help
help for certs
- - +``` + -h, --help help for certs +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md new file mode 100644 index 0000000000..c42340618f --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md @@ -0,0 +1,29 @@ + +Generate certificate keys + +### Synopsis + + +This command will print out a secure randomly-generated certificate key that can be used with +the "init" command. + +You can also use "kubeadm init --experimental-upload-certs" without specifying a certificate key and it will +generate and print one for you. + + +``` +kubeadm alpha certs certificate-key [flags] +``` + +### Options + +``` + -h, --help help for certificate-key +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md new file mode 100644 index 0000000000..3cf14558b0 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md @@ -0,0 +1,25 @@ + +Check certificates expiration for a Kubernetes cluster + +### Synopsis + +Checks expiration for the certificates in the local PKI managed by kubeadm. + +``` +kubeadm alpha certs check-expiration [flags] +``` + +### Options + +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for check-expiration +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md index f212b9e12b..4aba5d9618 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md @@ -1,9 +1,8 @@ -Renews certificates for a Kubernetes cluster +Renew certificates for a Kubernetes cluster ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm alpha certs renew [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for renew
- - +``` + -h, --help help for renew +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md new file mode 100644 index 0000000000..fafd0c7641 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md @@ -0,0 +1,35 @@ + +Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself + +### Synopsis + +Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself. + +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. + +``` +kubeadm alpha certs renew admin.conf [flags] +``` + +### Options + +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for admin.conf + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md index 60fa27fb56..ba6e1bb75a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md @@ -1,10 +1,9 @@ -renew all available certificates +Renew all available certificates ### Synopsis - -Renews all known certificates necessary to run the control plan. Renewals are run unconditionally, regardless of expiration date. Renewals can also be run individually for more control. +Renew all known certificates necessary to run the control plane. Renewals are run unconditionally, regardless of expiration date. Renewals can also be run individually for more control. ``` kubeadm alpha certs renew all [flags] @@ -12,85 +11,19 @@ kubeadm alpha certs renew all [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for all
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for all + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md index 3489a9d677..e7c791ed1b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md @@ -1,12 +1,15 @@ -Generates the client apiserver uses to access etcd +Renew the certificate the apiserver uses to access etcd ### Synopsis +Renew the certificate the apiserver uses to access etcd. -Renews the client apiserver uses to access etcd, and saves them into apiserver-etcd-client.cert and apiserver-etcd-client.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew apiserver-etcd-client [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew apiserver-etcd-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-etcd-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver-etcd-client + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md index b6e5f7406f..064e0c24db 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md @@ -1,12 +1,15 @@ -Generates the Client certificate for the API server to connect to kubelet +Renew the certificate for the API server to connect to kubelet ### Synopsis +Renew the certificate for the API server to connect to kubelet. -Renews the Client certificate for the API server to connect to kubelet, and saves them into apiserver-kubelet-client.cert and apiserver-kubelet-client.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew apiserver-kubelet-client [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew apiserver-kubelet-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-kubelet-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver-kubelet-client + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md index d45c3ca73a..92b62d83d0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md @@ -1,12 +1,15 @@ -Generates the certificate for serving the Kubernetes API +Renew the certificate for serving the Kubernetes API ### Synopsis +Renew the certificate for serving the Kubernetes API. -Renews the certificate for serving the Kubernetes API, and saves them into apiserver.cert and apiserver.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew apiserver [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew apiserver [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md new file mode 100644 index 0000000000..7339fc04b8 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md @@ -0,0 +1,35 @@ + +Renew the certificate embedded in the kubeconfig file for the controller manager to use + +### Synopsis + +Renew the certificate embedded in the kubeconfig file for the controller manager to use. + +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. + +``` +kubeadm alpha certs renew controller-manager.conf [flags] +``` + +### Options + +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for controller-manager.conf + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md index 3c798047f3..f1b796a08b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md @@ -1,12 +1,15 @@ -Generates the client certificate for liveness probes to healtcheck etcd +Renew the certificate for liveness probes to healtcheck etcd ### Synopsis +Renew the certificate for liveness probes to healtcheck etcd. -Renews the client certificate for liveness probes to healtcheck etcd, and saves them into etcd/healthcheck-client.cert and etcd/healthcheck-client.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew etcd-healthcheck-client [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew etcd-healthcheck-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-healthcheck-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-healthcheck-client + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md index b8cf86bad1..e5c46d5245 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md @@ -1,12 +1,15 @@ -Generates the credentials for etcd nodes to communicate with each other +Renew the certificate for etcd nodes to communicate with each other ### Synopsis +Renew the certificate for etcd nodes to communicate with each other. -Renews the credentials for etcd nodes to communicate with each other, and saves them into etcd/peer.cert and etcd/peer.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew etcd-peer [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew etcd-peer [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-peer
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-peer + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md index 123111cd55..997a607bd8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md @@ -1,12 +1,15 @@ -Generates the certificate for serving etcd +Renew the certificate for serving etcd ### Synopsis +Renew the certificate for serving etcd. -Renews the certificate for serving etcd, and saves them into etcd/server.cert and etcd/server.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew etcd-server [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew etcd-server [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-server
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-server + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md index ed9f18495a..2945b45b2f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md @@ -1,12 +1,15 @@ -Generates the client for the front proxy +Renew the certificate for the front proxy client ### Synopsis +Renew the certificate for the front proxy client. -Renews the client for the front proxy, and saves them into front-proxy-client.cert and front-proxy-client.key files. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. -Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them. +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. ``` kubeadm alpha certs renew front-proxy-client [flags] @@ -14,85 +17,19 @@ kubeadm alpha certs renew front-proxy-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for front-proxy-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
- - +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for front-proxy-client + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md new file mode 100644 index 0000000000..58dc3900a9 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md @@ -0,0 +1,35 @@ + +Renew the certificate embedded in the kubeconfig file for the scheduler manager to use + +### Synopsis + +Renew the certificate embedded in the kubeconfig file for the scheduler manager to use. + +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. + +After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. + +``` +kubeadm alpha certs renew scheduler.conf [flags] +``` + +### Options + +``` + --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for scheduler.conf + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --use-api Use the Kubernetes certificate API to renew certificates +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md index 24b0f4d901..0481bb1d2a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md @@ -3,50 +3,19 @@ Kubeconfig file utilities ### Synopsis - Kubeconfig file utilities. Alpha Disclaimer: this command is currently alpha. ### Options - - - - - - - - - - - - - - - -
-h, --help
help for kubeconfig
- - +``` + -h, --help help for kubeconfig +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md index c12f50d3cf..5bcc47139c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md @@ -1,10 +1,9 @@ -Outputs a kubeconfig file for an additional user +Output a kubeconfig file for an additional user ### Synopsis - -Outputs a kubeconfig file for an additional user. +Output a kubeconfig file for an additional user. Alpha Disclaimer: this command is currently alpha. @@ -15,91 +14,25 @@ kubeadm alpha kubeconfig user [flags] ### Examples ``` - # Outputs a kubeconfig file for an additional user named foo + # Output a kubeconfig file for an additional user named foo kubeadm alpha kubeconfig user --client-name=foo ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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
--org stringSlice
The orgnizations of the client certificate. It will be used as the O if client certificates are created
--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 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 + --org strings The orgnizations of the client certificate. It will be used as the O if client certificates are created + --token string The token that should be used as the authentication mechanism for this kubeconfig, instead of client certificates +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md index 5479cf594e..d975aae963 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md @@ -3,48 +3,17 @@ Commands related to handling the kubelet ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ### Options - - - - - - - - - - - - - - - -
-h, --help
help for kubelet
- - +``` + -h, --help help for kubelet +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md index be9d4fcc26..0040242ff2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md @@ -3,48 +3,17 @@ Utilities for kubelet configuration ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ### Options - - - - - - - - - - - - - - - -
-h, --help
help for config
- - +``` + -h, --help help for config +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md index 20ad0bbf4c..ca6e808504 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md @@ -1,10 +1,9 @@ -Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. +Download the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet ### Synopsis - -Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. +Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. Alpha Disclaimer: this command is currently alpha. @@ -15,66 +14,24 @@ kubeadm alpha kubelet config download [flags] ### Examples ``` - # Downloads the kubelet configuration from the ConfigMap in the cluster. Autodetects the kubelet version. + # Download the kubelet configuration from the ConfigMap in the cluster. Autodetect the kubelet version. kubeadm alpha phase kubelet config download - # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. - kubeadm alpha phase kubelet config download --kubelet-version v1.12.0 + # Download the kubelet configuration from the ConfigMap in the cluster. Use a specific desired kubelet version. + kubeadm alpha phase kubelet config download --kubelet-version 1.14.0 ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-h, --help
help for download
--kubeconfig string     Default: "/etc/kubernetes/kubelet.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubelet-version string
The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'.
- - +``` + -h, --help help for download + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubelet-version string The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md index fdad69928b..3d772d05b9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md @@ -1,10 +1,9 @@ -EXPERIMENTAL: Enables or updates dynamic kubelet configuration for a Node +EXPERIMENTAL: Enable or update dynamic kubelet configuration for a Node ### Synopsis - -Enables or updates dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. +Enable or update dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. @@ -17,8 +16,8 @@ kubeadm alpha kubelet config enable-dynamic [flags] ### Examples ``` - # Enables dynamic kubelet configuration for a Node. - kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version v1.12.0 + # Enable dynamic kubelet configuration for a Node. + kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version 1.14.0 WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. @@ -26,64 +25,16 @@ kubeadm alpha kubelet config enable-dynamic [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-h, --help
help for enable-dynamic
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubelet-version string
The desired version for the kubelet
--node-name string
Name of the node that should enable the dynamic kubelet configuration
- - +``` + -h, --help help for enable-dynamic + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubelet-version string The desired version for the kubelet + --node-name string Name of the node that should enable the dynamic kubelet configuration +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md index a4543c9ee7..95951d4bbe 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md @@ -1,50 +1,19 @@ -Makes a kubeadm cluster self-hosted +Make 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 +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md index 4f04e48126..eaa946f2c1 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md @@ -1,10 +1,9 @@ -Converts a static Pod-hosted control plane into a self-hosted one +Convert 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. +Convert static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API. See the documentation for self-hosting limitations. @@ -17,85 +16,25 @@ kubeadm alpha selfhosting pivot [flags] ### Examples ``` - # Converts a static Pod-hosted control plane into a self-hosted one. + # Convert a static Pod-hosted control plane into a self-hosted one. kubeadm alpha phase self-hosting convert-from-staticpods ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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
-f, --force
Pivot the cluster without prompting for confirmation
-h, --help
help for pivot
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
-s, --store-certs-in-secrets
Enable storing certs in secrets
- - +``` + --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -f, --force Pivot the cluster without prompting for confirmation + -h, --help help for pivot + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + -s, --store-certs-in-secrets Enable storing certs in secrets +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md index 37481780b1..4618befd9b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md @@ -1,10 +1,9 @@ -Output shell completion code for the specified shell (bash or zsh). +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 @@ -39,7 +38,7 @@ source $HOME/.bash_profile # Load the kubeadm completion code for bash into the current shell source <(kubeadm completion bash) -# Write bash completion code to a file and source if from .bash_profile +# Write bash completion code to a file and source it from .bash_profile kubeadm completion bash > ~/.kube/kubeadm_completion.bash.inc printf "\n# Kubeadm shell completion\nsource '$HOME/.kube/kubeadm_completion.bash.inc'\n" >> $HOME/.bash_profile source $HOME/.bash_profile @@ -50,43 +49,13 @@ source <(kubeadm completion zsh) ### Options - - - - - - - - - - - - - - - -
-h, --help
help for completion
- - +``` + -h, --help help for completion +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md index 6c615daacd..bc085de08a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md @@ -1,10 +1,9 @@ -Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster. +Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster ### 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 @@ -17,50 +16,14 @@ kubeadm config [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - -
-h, --help
help for config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + -h, --help help for config + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md index 4b1073d17b..6c9be5ac3c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md @@ -1,10 +1,9 @@ -Interact with container images used by kubeadm. +Interact with container images used by kubeadm ### Synopsis - -Interact with container images used by kubeadm. +Interact with container images used by kubeadm ``` kubeadm config images [flags] @@ -12,50 +11,14 @@ kubeadm config images [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for images
- - +``` + -h, --help help for images +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md index fac2d052f2..28a2f0a7dc 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md @@ -1,10 +1,9 @@ -Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized ### Synopsis - -Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized ``` kubeadm config images list [flags] @@ -12,71 +11,18 @@ kubeadm config images list [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
-h, --help
help for list
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
- - +``` + --config string Path to kubeadm config file. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -h, --help help for list + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md index 7cb2173a26..611524df9c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md @@ -1,10 +1,9 @@ -Pull images used by kubeadm. +Pull images used by kubeadm ### Synopsis - -Pull images used by kubeadm. +Pull images used by kubeadm ``` kubeadm config images pull [flags] @@ -12,78 +11,19 @@ kubeadm config images pull [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file.
--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:
-h, --help
help for pull
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
- - +``` + --config string Path to kubeadm config file. + --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -h, --help help for pull + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md index 11bf770de8..ba1361453e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md @@ -1,13 +1,13 @@ -Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version. +Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version ### Synopsis - This command lets you convert configuration objects of older versions to the latest supported version, locally in the CLI tool without ever touching anything in the cluster. In this version of kubeadm, the following API versions are supported: + - kubeadm.k8s.io/v1beta1 - kubeadm.k8s.io/v1beta2 @@ -26,64 +26,16 @@ kubeadm config migrate [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-h, --help
help for migrate
--new-config string
Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT.
--old-config string
Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory.
- - +``` + -h, --help help for migrate + --new-config string Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT. + --old-config string Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md index ea98b1fa30..159b87581d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md @@ -3,7 +3,6 @@ Print configuration ### Synopsis - This command prints configurations for subcommands provided. ``` @@ -12,50 +11,14 @@ kubeadm config print [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for print
- - +``` + -h, --help help for print +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md index afdc7c3d4e..239a969a82 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md @@ -4,7 +4,6 @@ Print default init configuration, that can be used for 'kubeadm init' ### Synopsis - This command prints objects such as the default init configuration that is used for 'kubeadm init'. Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but @@ -17,57 +16,15 @@ kubeadm config print init-defaults [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - -
--component-configs stringSlice
A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed.
-h, --help
help for init-defaults
- - +``` + --component-configs strings A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed. + -h, --help help for init-defaults +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md index d26a83dc92..57d5024988 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md @@ -4,7 +4,6 @@ Print default join configuration, that can be used for 'kubeadm join' ### Synopsis - This command prints objects such as the default join configuration that is used for 'kubeadm join'. Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but @@ -17,57 +16,15 @@ kubeadm config print join-defaults [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - -
--component-configs stringSlice
A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed.
-h, --help
help for join-defaults
- - +``` + --component-configs strings A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed. + -h, --help help for join-defaults +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md deleted file mode 100644 index b4e825099a..0000000000 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md +++ /dev/null @@ -1,61 +0,0 @@ - -Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster. - -### Synopsis - - -Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster. - -``` -kubeadm config upload [flags] -``` - -### Options - - - - - - - - - - - - - - - - -
-h, --help
help for upload
- - - -### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - - diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md deleted file mode 100644 index 51d7987479..0000000000 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md +++ /dev/null @@ -1,74 +0,0 @@ - -Upload a configuration file to the in-cluster ConfigMap for kubeadm configuration. - -### 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'. - -The configuration is located in the "kube-system" namespace in the "kubeadm-config" ConfigMap. - - -``` -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
- - - -### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - - diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md deleted file mode 100644 index 08c1adb2f1..0000000000 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md +++ /dev/null @@ -1,144 +0,0 @@ - -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'. - -The configuration is located in the "kube-system" namespace in the "kubeadm-config" ConfigMap. - - -``` -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     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:
-h, --help
help for from-flags
--kubernetes-version string     Default: "stable-1"
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".
- - - -### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - - diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md index a389c5d947..a311347b32 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md @@ -1,10 +1,9 @@ -View the kubeadm configuration stored inside the cluster. +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. @@ -16,50 +15,14 @@ kubeadm config view [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for view
- - +``` + -h, --help help for view +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md index ebd50c07e2..c7faf70640 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md @@ -1,43 +1,46 @@ -Run this command in order to set up the Kubernetes control plane. +Run this command in order to set up the Kubernetes control plane ### Synopsis -The `init` command executes the following phases: +Run this command in order to set up the Kubernetes control plane + +The "init" command executes the following phases: ``` -preflight Run master pre-flight checks -kubelet-start Writes kubelet settings and (re)starts the kubelet +preflight Run pre-flight checks +kubelet-start Write kubelet settings and (re)start the kubelet certs Certificate generation - /ca Generates the self-signed Kubernetes CA to provision identities for other Kubernetes components - /apiserver Generates the certificate for serving the Kubernetes API - /apiserver-kubelet-client Generates the Client certificate for the API server to connect to kubelet - /front-proxy-ca Generates the self-signed CA to provision identities for front proxy - /front-proxy-client Generates the client for the front proxy - /etcd-ca Generates the self-signed CA to provision identities for etcd - /etcd-server Generates the certificate for serving etcd - /etcd-peer Generates the credentials for etcd nodes to communicate with each other - /etcd-healthcheck-client Generates the client certificate for liveness probes to healtcheck etcd - /apiserver-etcd-client Generates the client apiserver uses to access etcd - /sa Generates a private key for signing service account tokens along with its public key -kubeconfig Generates all kubeconfig files necessary to establish the control plane and the admin kubeconfig file - /admin Generates a kubeconfig file for the admin to use and for kubeadm itself - /kubelet Generates a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes - /controller-manager Generates a kubeconfig file for the controller manager to use - /scheduler Generates a kubeconfig file for the scheduler to use -control-plane Generates all static Pod manifest files necessary to establish the control plane + /etcd-ca Generate the self-signed CA to provision identities for etcd + /apiserver-etcd-client Generate the certificate the apiserver uses to access etcd + /etcd-healthcheck-client Generate the certificate for liveness probes to healtcheck etcd + /etcd-server Generate the certificate for serving etcd + /etcd-peer Generate the certificate for etcd nodes to communicate with each other + /ca Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components + /apiserver Generate the certificate for serving the Kubernetes API + /apiserver-kubelet-client Generate the certificate for the API server to connect to kubelet + /front-proxy-ca Generate the self-signed CA to provision identities for front proxy + /front-proxy-client Generate the certificate for the front proxy client + /sa Generate a private key for signing service account tokens along with its public key +kubeconfig Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file + /admin Generate a kubeconfig file for the admin to use and for kubeadm itself + /kubelet Generate a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes + /controller-manager Generate a kubeconfig file for the controller manager to use + /scheduler Generate a kubeconfig file for the scheduler to use +control-plane Generate all static Pod manifest files necessary to establish the control plane /apiserver Generates the kube-apiserver static Pod manifest /controller-manager Generates the kube-controller-manager static Pod manifest /scheduler Generates the kube-scheduler static Pod manifest -etcd Generates static Pod manifest file for local etcd. - /local Generates the static Pod manifest file for a local, single-node local etcd instance. -upload-config Uploads the kubeadm and kubelet configuration to a ConfigMap - /kubeadm Uploads the kubeadm ClusterConfiguration to a ConfigMap - /kubelet Uploads the kubelet component config to a ConfigMap +etcd Generate static Pod manifest file for local etcd + /local Generate the static Pod manifest file for a local, single-node local etcd instance +upload-config Upload the kubeadm and kubelet configuration to a ConfigMap + /kubeadm Upload the kubeadm ClusterConfiguration to a ConfigMap + /kubelet Upload the kubelet component config to a ConfigMap +upload-certs Upload certificates to kubeadm-certs mark-control-plane Mark a node as a control-plane bootstrap-token Generates bootstrap tokens used to join a node to a cluster -addon Installs required addons for passing Conformance tests - /coredns Installs the CoreDNS addon to a Kubernetes cluster - /kube-proxy Installs the kube-proxy addon to a Kubernetes cluster +addon Install required addons for passing Conformance tests + /coredns Install the CoreDNS addon to a Kubernetes cluster + /kube-proxy Install the kube-proxy addon to a Kubernetes cluster ``` @@ -47,176 +50,35 @@ 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     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:
-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.
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
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-phases stringSlice
List of phases to be skipped
--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. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--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
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --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") + --certificate-key string Key used to encrypt the control-plane certificates in the kubeadm-certs Secret. + --config string Path to a kubeadm configuration file. + --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + --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. No feature gates are available in this release. + -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. + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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-certificate-key-print Don't print the key used to encrypt the control-plane certificates. + --skip-phases strings List of phases to be skipped + --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 control-plane nodes. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef + --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) + --upload-certs Upload control-plane certificates to the kubeadm-certs Secret. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md index b2946caf1f..c469017dfd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md @@ -1,50 +1,19 @@ -use this command to invoke single phase of the init workflow +Use this command to invoke single phase of the init workflow ### Synopsis - -use this command to invoke single phase of the init workflow +Use this command to invoke single phase of the init workflow ### Options - - - - - - - - - - - - - - - -
-h, --help
help for phase
- - +``` + -h, --help help for phase +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md index 1ddc02f451..53aea81144 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md @@ -1,9 +1,8 @@ -Installs required addons for passing Conformance tests +Install required addons for passing Conformance tests ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm init phase addon [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for addon
- - +``` + -h, --help help for addon +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md index 76e1055467..f27dd95699 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md @@ -1,10 +1,9 @@ -Installs all the addons +Install all the addons ### Synopsis - -Installs all the addons +Install all the addons ``` kubeadm init phase addon all [flags] @@ -12,113 +11,23 @@ kubeadm init phase addon all [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     Default: 6443
Port for the API Server to bind to.
--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:
-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. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--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".
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --config string Path to a kubeadm configuration file. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -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. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md index a358676d53..1e7c742f97 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md @@ -1,10 +1,9 @@ -Installs the CoreDNS addon to a Kubernetes cluster +Install the CoreDNS addon to a Kubernetes cluster ### Synopsis - -Installs the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. +Install the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. ``` kubeadm init phase addon coredns [flags] @@ -12,92 +11,20 @@ kubeadm init phase addon coredns [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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:
-h, --help
help for coredns
--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. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--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".
- - +``` + --config string Path to a kubeadm configuration file. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -h, --help help for coredns + --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. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md index f967ae1647..2af54fcf9d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md @@ -1,10 +1,9 @@ -Installs the kube-proxy addon to a Kubernetes cluster +Install the kube-proxy addon to a Kubernetes cluster ### Synopsis - -Installs the kube-proxy addon components via the API server. +Install the kube-proxy addon components via the API server. ``` kubeadm init phase addon kube-proxy [flags] @@ -12,92 +11,20 @@ kubeadm init phase addon kube-proxy [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     Default: 6443
Port for the API Server to bind to.
--config string
Path to 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. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--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.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --config string Path to a kubeadm configuration file. + -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. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md index c853d7d2fb..da037aa124 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md @@ -3,7 +3,6 @@ Generates bootstrap tokens used to join a node to a cluster ### Synopsis - Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a the control-plane node. This command makes all the configurations required to make bootstrap tokens works and then creates an initial token. @@ -15,71 +14,23 @@ kubeadm init phase bootstrap-token [flags] ### Examples ``` - # Makes all the bootstrap token configurations and creates an initial token, functionally + # Make all the bootstrap token configurations and create an initial token, functionally # equivalent to what generated by kubeadm init. kubeadm init phase bootstrap-token ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for bootstrap-token
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for bootstrap-token + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --skip-token-print Skip printing of the default bootstrap token generated by 'kubeadm init'. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md index 538a7a1b33..0c7c04d9ef 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md @@ -3,7 +3,6 @@ Certificate generation ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm init phase certs [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for certs
- - +``` + -h, --help help for certs +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md index 910b94afbe..6798a92d1e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md @@ -1,10 +1,9 @@ -Generates all certificates +Generate all certificates ### Synopsis - -Generates all certificates +Generate all certificates ``` kubeadm init phase certs all [flags] @@ -12,85 +11,19 @@ kubeadm init phase certs all [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-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.
-h, --help
help for all
--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".
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --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 a kubeadm configuration file. + -h, --help help for all + --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") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md index 01e798e144..03af7712c0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md @@ -1,10 +1,9 @@ -Generates the client apiserver uses to access etcd +Generate the certificate the apiserver uses to access etcd ### Synopsis - -Generates the client apiserver uses to access etcd, and saves them into apiserver-etcd-client.cert and apiserver-etcd-client.key files. +Generate the certificate the apiserver uses to access etcd, and save them into apiserver-etcd-client.cert and apiserver-etcd-client.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,71 +15,17 @@ kubeadm init phase certs apiserver-etcd-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-etcd-client
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver-etcd-client +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md index b3e30655c4..3ef0865521 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md @@ -1,10 +1,9 @@ -Generates the Client certificate for the API server to connect to kubelet +Generate the certificate for the API server to connect to kubelet ### Synopsis - -Generates the Client certificate for the API server to connect to kubelet, and saves them into apiserver-kubelet-client.cert and apiserver-kubelet-client.key files. +Generate the certificate for the API server to connect to kubelet, and save them into apiserver-kubelet-client.cert and apiserver-kubelet-client.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,71 +15,17 @@ kubeadm init phase certs apiserver-kubelet-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-kubelet-client
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver-kubelet-client +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md index a36c16aee3..9562ffd8fe 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md @@ -1,10 +1,9 @@ -Generates the certificate for serving the Kubernetes API +Generate the certificate for serving the Kubernetes API ### Synopsis - -Generates the certificate for serving the Kubernetes API, and saves them into apiserver.cert and apiserver.key files. +Generate the certificate for serving the Kubernetes API, and save them into apiserver.cert and apiserver.key files. Default SANs are kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc.cluster.local, 10.96.0.1, 127.0.0.1 @@ -18,99 +17,21 @@ kubeadm init phase certs apiserver [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-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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver
--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".
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --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 a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for apiserver + --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") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md index 257da0ea6a..cc5d479e7b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md @@ -1,10 +1,9 @@ -Generates the self-signed Kubernetes CA to provision identities for other Kubernetes components +Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components ### Synopsis - -Generates the self-signed Kubernetes CA to provision identities for other Kubernetes components, and saves them into ca.cert and ca.key files. +Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components, and save them into ca.cert and ca.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,57 +15,15 @@ kubeadm init phase certs ca [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for ca
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for ca +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md index 210b0d1dd2..48345f6b01 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md @@ -1,10 +1,9 @@ -Generates the self-signed CA to provision identities for etcd +Generate the self-signed CA to provision identities for etcd ### Synopsis - -Generates the self-signed CA to provision identities for etcd, and saves them into etcd/ca.cert and etcd/ca.key files. +Generate the self-signed CA to provision identities for etcd, and save them into etcd/ca.cert and etcd/ca.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,57 +15,15 @@ kubeadm init phase certs etcd-ca [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for etcd-ca
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for etcd-ca +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md index 65e5c41bed..c4428459b7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md @@ -1,10 +1,9 @@ -Generates the client certificate for liveness probes to healtcheck etcd +Generate the certificate for liveness probes to healtcheck etcd ### Synopsis - -Generates the client certificate for liveness probes to healtcheck etcd, and saves them into etcd/healthcheck-client.cert and etcd/healthcheck-client.key files. +Generate the certificate for liveness probes to healtcheck etcd, and save them into etcd/healthcheck-client.cert and etcd/healthcheck-client.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,71 +15,17 @@ kubeadm init phase certs etcd-healthcheck-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-healthcheck-client
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-healthcheck-client +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md index 2e045ae1e1..fd9f355a6a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md @@ -1,10 +1,9 @@ -Generates the credentials for etcd nodes to communicate with each other +Generate the certificate for etcd nodes to communicate with each other ### Synopsis - -Generates the credentials for etcd nodes to communicate with each other, and saves them into etcd/peer.cert and etcd/peer.key files. +Generate the certificate for etcd nodes to communicate with each other, and save them into etcd/peer.cert and etcd/peer.key files. Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 @@ -18,71 +17,17 @@ kubeadm init phase certs etcd-peer [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-peer
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-peer +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md index a960d01e4f..19489e9f16 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md @@ -1,10 +1,9 @@ -Generates the certificate for serving etcd +Generate the certificate for serving etcd ### Synopsis - -Generates the certificate for serving etcd, and saves them into etcd/server.cert and etcd/server.key files. +Generate the certificate for serving etcd, and save them into etcd/server.cert and etcd/server.key files. Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 @@ -18,71 +17,17 @@ kubeadm init phase certs etcd-server [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-server
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for etcd-server +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md index bff25d78cd..dcf4e16da2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md @@ -1,10 +1,9 @@ -Generates the self-signed CA to provision identities for front proxy +Generate the self-signed CA to provision identities for front proxy ### Synopsis - -Generates the self-signed CA to provision identities for front proxy, and saves them into front-proxy-ca.cert and front-proxy-ca.key files. +Generate the self-signed CA to provision identities for front proxy, and save them into front-proxy-ca.cert and front-proxy-ca.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,57 +15,15 @@ kubeadm init phase certs front-proxy-ca [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for front-proxy-ca
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for front-proxy-ca +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md index 9a051340a1..8594356941 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md @@ -1,10 +1,9 @@ -Generates the client for the front proxy +Generate the certificate for the front proxy client ### Synopsis - -Generates the client for the front proxy, and saves them into front-proxy-client.cert and front-proxy-client.key files. +Generate the certificate for the front proxy client, and save them into front-proxy-client.cert and front-proxy-client.key files. If both files already exist, kubeadm skips the generation step and existing files will be used. @@ -16,71 +15,17 @@ kubeadm init phase certs front-proxy-client [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for front-proxy-client
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --csr-dir string The path to output the CSRs and private keys to + --csr-only Create CSRs instead of generating certificates + -h, --help help for front-proxy-client +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md index 951b773eac..d820c1db4a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md @@ -1,10 +1,9 @@ -Generates a private key for signing service account tokens along with its public key +Generate a private key for signing service account tokens along with its public key ### 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. +Generate the private key for signing service account tokens along with its public key, and save them into sa.key and sa.pub files. If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -14,43 +13,14 @@ kubeadm init phase certs sa [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for sa
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + -h, --help help for sa +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md index 38cc40ed90..e3b47df73f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md @@ -1,9 +1,8 @@ -Generates all static Pod manifest files necessary to establish the control plane +Generate 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. ``` @@ -12,43 +11,13 @@ kubeadm init phase control-plane [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for control-plane
- - +``` + -h, --help help for control-plane +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md index 322a545318..d5a229d47e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md @@ -1,138 +1,46 @@ -Generates all static Pod manifest files +Generate all static Pod manifest files ### Synopsis - -Generates all static Pod manifest files +Generate all static Pod manifest files ``` kubeadm init phase control-plane all [flags] ``` +### Examples + +``` + # Generates all static Pod manifest files for control plane components, + # functionally equivalent to what is generated by kubeadm init. + kubeadm init phase control-plane all + + # Generates all static Pod manifest files using options read from a configuration file. + kubeadm init phase control-plane all --config config.yaml +``` + ### 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     Default: 6443
Port for the API Server to bind to.
--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 to save and store the certificates.
--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:
-h, --help
help for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--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.
--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"
Use alternative range of IP address for service VIPs.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (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 to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --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. No feature gates are available in this release. + -h, --help help for all + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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. + --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = + --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md index 6ebc0d2724..a73f6979de 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md @@ -3,7 +3,6 @@ Generates the kube-apiserver static Pod manifest ### Synopsis - Generates the kube-apiserver static Pod manifest ``` @@ -12,106 +11,22 @@ kubeadm init phase control-plane apiserver [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     Default: 6443
Port for the API Server to bind to.
--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 to save and store the certificates.
--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:
-h, --help
help for apiserver
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (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 to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -h, --help help for apiserver + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md index 19fb762a7e..a12e82f3c9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md @@ -3,7 +3,6 @@ Generates the kube-controller-manager static Pod manifest ### Synopsis - Generates the kube-controller-manager static Pod manifest ``` @@ -12,85 +11,19 @@ kubeadm init phase control-plane controller-manager [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
--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
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--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.
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + --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 + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --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. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md index 9cf579ab56..13219cef36 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md @@ -3,7 +3,6 @@ Generates the kube-scheduler static Pod manifest ### Synopsis - Generates the kube-scheduler static Pod manifest ``` @@ -12,78 +11,18 @@ kubeadm init phase control-plane scheduler [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for scheduler
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
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>
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for scheduler + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") + --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") + --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md index fa2a91f055..e6c93bc7e2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md @@ -1,9 +1,8 @@ -Generates static Pod manifest file for local etcd. +Generate static Pod manifest file for local etcd ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm init phase etcd [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for etcd
- - +``` + -h, --help help for etcd +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md index ced1517a3b..c07f3d39ca 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md @@ -1,10 +1,9 @@ -Generates the static Pod manifest file for a local, single-node local etcd instance. +Generate the static Pod manifest file for a local, single-node local etcd instance ### Synopsis - -Generates the static Pod manifest file for a local, single-node local etcd instance. +Generate the static Pod manifest file for a local, single-node local etcd instance ``` kubeadm init phase etcd local [flags] @@ -24,64 +23,16 @@ kubeadm init phase etcd local [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for local
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
- - +``` + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for local + --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md index 8931be52e7..e903238a9e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md @@ -1,9 +1,8 @@ -Generates all kubeconfig files necessary to establish the control plane and the admin kubeconfig file +Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm init phase kubeconfig [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for kubeconfig
- - +``` + -h, --help help for kubeconfig +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md index a10f9aaf65..4173da018f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md @@ -1,10 +1,9 @@ -Generates a kubeconfig file for the admin to use and for kubeadm itself +Generate 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. +Generate the kubeconfig file for the admin and for kubeadm itself, and save it to admin.conf file. ``` kubeadm init phase kubeconfig admin [flags] @@ -12,78 +11,18 @@ kubeadm init phase kubeconfig admin [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     Default: 6443
Port for the API Server to bind to.
--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.
-h, --help
help for admin
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for admin + --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md index 698541d273..5182f62548 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md @@ -1,10 +1,9 @@ -Generates all kubeconfig files +Generate all kubeconfig files ### Synopsis - -Generates all kubeconfig files +Generate all kubeconfig files ``` kubeadm init phase kubeconfig all [flags] @@ -12,85 +11,19 @@ kubeadm init phase kubeconfig all [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     Default: 6443
Port for the API Server to bind to.
--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.
-h, --help
help for all
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--node-name string
Specify the node name.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for all + --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") + --node-name string Specify the node name. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md index 3a27c9a950..5e6514887a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md @@ -1,10 +1,9 @@ -Generates a kubeconfig file for the controller manager to use +Generate a kubeconfig file for the controller manager to use ### Synopsis - -Generates the kubeconfig file for the controller manager to use and saves it to controller-manager.conf file +Generate the kubeconfig file for the controller manager to use and save it to controller-manager.conf file ``` kubeadm init phase kubeconfig controller-manager [flags] @@ -12,78 +11,18 @@ kubeadm init phase kubeconfig controller-manager [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     Default: 6443
Port for the API Server to bind to.
--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.
-h, --help
help for controller-manager
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for controller-manager + --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md index 2ba61026cb..4d08ce4bcf 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md @@ -1,10 +1,9 @@ -Generates a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes +Generate a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes ### Synopsis - -Generates the kubeconfig file for the kubelet to use and saves it to kubelet.conf file. +Generate the kubeconfig file for the kubelet to use and save it to kubelet.conf file. Please note that this should only be used for cluster bootstrapping purposes. After your control plane is up, you should request all kubelet credentials from the CSR API. @@ -14,85 +13,19 @@ kubeadm init phase kubeconfig kubelet [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     Default: 6443
Port for the API Server to bind to.
--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.
-h, --help
help for kubelet
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--node-name string
Specify the node name.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for kubelet + --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") + --node-name string Specify the node name. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md index 892e77c829..72784a9508 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md @@ -1,10 +1,9 @@ -Generates a kubeconfig file for the scheduler to use +Generate a kubeconfig file for the scheduler to use ### Synopsis - -Generates the kubeconfig file for the scheduler to use and saves it to scheduler.conf file. +Generate the kubeconfig file for the scheduler to use and save it to scheduler.conf file. ``` kubeadm init phase kubeconfig scheduler [flags] @@ -12,78 +11,18 @@ kubeadm init phase kubeconfig scheduler [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     Default: 6443
Port for the API Server to bind to.
--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.
-h, --help
help for scheduler
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
- - +``` + --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) + --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") + --config string Path to a kubeadm configuration file. + -h, --help help for scheduler + --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md index 69a28ad329..4ee94fe1d0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md @@ -1,10 +1,9 @@ -Writes kubelet settings and (re)starts the kubelet +Write kubelet settings and (re)start the kubelet ### Synopsis - -Writes a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)starts kubelet. +Write a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)start kubelet. ``` kubeadm init phase kubelet-start [flags] @@ -14,69 +13,21 @@ kubeadm init phase kubelet-start [flags] ``` # Writes a dynamic environment file with kubelet flags from a InitConfiguration file. - kubeadm init phase kubelet-start --config masterconfig.yaml + kubeadm init phase kubelet-start --config config.yaml ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-h, --help
help for kubelet-start
--node-name string
Specify the node name.
- - +``` + --config string Path to a kubeadm configuration file. + --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + -h, --help help for kubelet-start + --node-name string Specify the node name. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md index 4c0d119be5..f30046cc55 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md @@ -3,7 +3,6 @@ Mark a node as a control-plane ### Synopsis - Mark a node as a control-plane ``` @@ -22,57 +21,15 @@ kubeadm init phase mark-control-plane [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for mark-control-plane
--node-name string
Specify the node name.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for mark-control-plane + --node-name string Specify the node name. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md index b5f2626e72..499c88dfcd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md @@ -1,10 +1,9 @@ -Run master pre-flight checks +Run pre-flight checks ### Synopsis - -Run master pre-flight checks, functionally equivalent to what implemented by kubeadm init. +Run pre-flight checks for kubeadm init. ``` kubeadm init phase preflight [flags] @@ -13,63 +12,21 @@ kubeadm init phase preflight [flags] ### Examples ``` - # Run master pre-flight checks using a config file. + # Run pre-flight checks for kubeadm init using a config file. kubeadm init phase preflight --config kubeadm-config.yml ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for preflight
--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.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for preflight + --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. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md index aed553b8c3..d30c662537 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md @@ -14,9 +14,9 @@ kubeadm init phase upload-certs [flags] ``` --certificate-key string Key used to encrypt the control-plane certificates in the kubeadm-certs Secret. --config string Path to a kubeadm configuration file. - --experimental-upload-certs Upload control-plane certificates to the kubeadm-certs Secret. -h, --help help for upload-certs --skip-certificate-key-print Don't print the key used to encrypt the control-plane certificates. + --upload-certs Upload control-plane certificates to the kubeadm-certs Secret. ``` ### Options inherited from parent commands diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md index 0f20e04b16..c44ed60548 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md @@ -1,9 +1,8 @@ -Uploads the kubeadm and kubelet configuration to a ConfigMap +Upload the kubeadm and kubelet configuration to a ConfigMap ### Synopsis - This command is not meant to be run on its own. See list of available subcommands. ``` @@ -12,43 +11,13 @@ kubeadm init phase upload-config [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for upload-config
- - +``` + -h, --help help for upload-config +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md index 8e697d5c5b..d6ccc063d3 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md @@ -1,10 +1,9 @@ -Uploads all configuration to a config map +Upload all configuration to a config map ### Synopsis - -Uploads all configuration to a config map +Upload all configuration to a config map ``` kubeadm init phase upload-config all [flags] @@ -12,57 +11,15 @@ kubeadm init phase upload-config all [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for all
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for all + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md index 986d5ac0ad..cec14b629f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md @@ -1,10 +1,9 @@ -Uploads the kubeadm ClusterConfiguration to a ConfigMap +Upload the kubeadm ClusterConfiguration to a ConfigMap ### Synopsis - -Uploads the kubeadm ClusterConfiguration 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. +Upload the kubeadm ClusterConfiguration 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. @@ -15,63 +14,21 @@ kubeadm init phase upload-config kubeadm [flags] ### Examples ``` - # uploads the configuration of your cluster + # upload the configuration of your cluster kubeadm init phase upload-config --config=myConfig.yaml ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for kubeadm
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for kubeadm + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md index 8eb48c01ec..549703c970 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md @@ -1,10 +1,9 @@ -Uploads the kubelet component config to a ConfigMap +Upload the kubelet component config to a ConfigMap ### Synopsis - -Uploads kubelet configuration extracted from the kubeadm InitConfiguration object to a ConfigMap of the form kubelet-config-1.X in the cluster, where X is the minor version of the current (API Server) Kubernetes version. +Upload kubelet configuration extracted from the kubeadm InitConfiguration object to a ConfigMap of the form kubelet-config-1.X in the cluster, where X is the minor version of the current (API Server) Kubernetes version. ``` kubeadm init phase upload-config kubelet [flags] @@ -13,63 +12,21 @@ kubeadm init phase upload-config kubelet [flags] ### Examples ``` - # Uploads the kubelet configuration from the kubeadm Config file to a ConfigMap in the cluster. + # Upload the kubelet configuration from the kubeadm Config file to a ConfigMap in the cluster. kubeadm init phase upload-config kubelet --config kubeadm.yaml ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for kubelet
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + --config string Path to a kubeadm configuration file. + -h, --help help for kubelet + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md index 5116ad9850..8e8c47444e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md @@ -4,11 +4,10 @@ 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 -Master trust the Node). +trust the Kubernetes Control Plane) and TLS bootstrap (having the +Kubernetes Control Plane trust the Node). There are 2 main schemes for discovery. The first is to use a shared token along with the IP address of the API server. The second is to @@ -23,8 +22,8 @@ the connection. If you use a shared token for discovery, you should also pass the --discovery-token-ca-cert-hash flag to validate the public key of the -root certificate authority (CA) presented by the Kubernetes Master. The -value of this flag is specified as ":", +root certificate authority (CA) presented by the Kubernetes Control Plane. +The value of this flag is specified as ":", where the supported hash type is "sha256". The hash is calculated over the bytes of the Subject Public Key Info (SPKI) object (as in RFC7469). This value is available in the output of "kubeadm init" or can be @@ -34,12 +33,12 @@ may be repeated multiple times to allow more than one public key. If you cannot know the CA public key hash ahead of time, you can pass the --discovery-token-unsafe-skip-ca-verification flag to disable this verification. This weakens the kubeadm security model since other nodes -can potentially impersonate the Kubernetes Master. +can potentially impersonate the Kubernetes Control Plane. The TLS bootstrap mechanism is also driven via a shared token. This is -used to temporarily authenticate with the Kubernetes Master to submit a +used to temporarily authenticate with the Kubernetes Control Plane to submit a certificate signing request (CSR) for a locally created key pair. By -default, kubeadm will set up the Kubernetes Master to automatically +default, kubeadm will set up the Kubernetes Control Plane to automatically approve these signing requests. This token is passed in with the --tls-bootstrap-token abcdef.1234567890abcdef flag. @@ -47,133 +46,51 @@ Often times the same token is used for both parts. In this case, the --token flag can be used instead of specifying each token individually. +The "join [api-server-endpoint]" command executes the following phases: ``` -kubeadm join [flags] +preflight Run join pre-flight checks +control-plane-prepare Prepare the machine for serving a control plane + /download-certs [EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret + /certs Generate the certificates for the new control plane components + /kubeconfig Generate the kubeconfig for the new control plane components + /control-plane Generate the manifests for the new control plane components +kubelet-start Write kubelet settings, certificates and (re)start the kubelet +control-plane-join Join a machine as a control plane instance + /etcd Add a new local etcd member + /update-status Register the new control-plane node into the ClusterStatus maintained in the kubeadm-config ConfigMap + /mark-control-plane Mark a node as a control-plane +``` + + +``` +kubeadm join [api-server-endpoint] [flags] ``` ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on.
--apiserver-bind-port int32     Default: 6443
If the node should host a new control plane instance, the port for the API Server to bind to.
--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 API server.
--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.
--experimental-control-plane
Create a new control plane instance on this node
-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.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
- - +``` + --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. + --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) + --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. + --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node + --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + --discovery-file string For file-based discovery, a file or URL from which to load cluster information. + --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. + --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. + --experimental-control-plane Create a new control plane instance on this node + -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. + --skip-phases strings List of phases to be skipped + --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. + --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md index a5562c5dc4..23872078a6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md @@ -1,9 +1,9 @@ -use this command to invoke single phase of the join workflow +Use this command to invoke single phase of the join workflow ### Synopsis -use this command to invoke single phase of the join workflow +Use this command to invoke single phase of the join workflow ### Options diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md index e65c5248f4..6885cc60bb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md @@ -1,9 +1,9 @@ -Joins a machine as a control plane instance +Join a machine as a control plane instance ### Synopsis -Joins a machine as a control plane instance +Join a machine as a control plane instance ``` kubeadm join phase control-plane-join [flags] diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md index d2f288fd98..327f3353c8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md @@ -1,9 +1,9 @@ -Joins a machine as a control plane instance +Join a machine as a control plane instance ### Synopsis -Joins a machine as a control plane instance +Join a machine as a control plane instance ``` kubeadm join phase control-plane-join all [flags] @@ -14,6 +14,7 @@ kubeadm join phase control-plane-join all [flags] ``` --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --experimental-control-plane Create a new control plane instance on this node -h, --help help for all --node-name string Specify the node name. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md index 05ebd37d41..d4282b445b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md @@ -14,6 +14,7 @@ kubeadm join phase control-plane-join etcd [flags] ``` --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --experimental-control-plane Create a new control plane instance on this node -h, --help help for etcd --node-name string Specify the node name. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md index 9a06263e38..eb8f6e1de3 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md @@ -13,6 +13,7 @@ kubeadm join phase control-plane-join mark-control-plane [flags] ``` --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --experimental-control-plane Create a new control plane instance on this node -h, --help help for mark-control-plane --node-name string Specify the node name. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md index 00a10bb606..f01287ded9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md @@ -14,6 +14,7 @@ kubeadm join phase control-plane-join update-status [flags] ``` --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --experimental-control-plane Create a new control plane instance on this node -h, --help help for update-status --node-name string Specify the node name. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md index 1ed4d231ba..10535c0c41 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md @@ -1,9 +1,9 @@ -Prepares the machine for serving a control plane. +Prepare the machine for serving a control plane ### Synopsis -Prepares the machine for serving a control plane. +Prepare the machine for serving a control plane ``` kubeadm join phase control-plane-prepare [flags] diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md index 30e3351584..11707f8006 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md @@ -1,9 +1,9 @@ -Prepares the machine for serving a control plane. +Prepare the machine for serving a control plane ### Synopsis -Prepares the machine for serving a control plane. +Prepare the machine for serving a control plane ``` kubeadm join phase control-plane-prepare all [api-server-endpoint] [flags] @@ -16,6 +16,7 @@ kubeadm join phase control-plane-prepare all [api-server-endpoint] [flags] --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --discovery-file string For file-based discovery, a file or URL from which to load cluster information. --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md index f429b7536c..2392b884de 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md @@ -1,9 +1,9 @@ -Generates the certificates for the new control plane components +Generate the certificates for the new control plane components ### Synopsis -Generates the certificates for the new control plane components +Generate the certificates for the new control plane components ``` kubeadm join phase control-plane-prepare certs [api-server-endpoint] [flags] @@ -14,6 +14,7 @@ kubeadm join phase control-plane-prepare certs [api-server-endpoint] [flags] ``` --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --discovery-file string For file-based discovery, a file or URL from which to load cluster information. --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md index cecc4b2a80..1a856cd3c5 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md @@ -1,9 +1,9 @@ -Generates the manifests for the new control plane components +Generate the manifests for the new control plane components ### Synopsis -Generates the manifests for the new control plane components +Generate the manifests for the new control plane components ``` kubeadm join phase control-plane-prepare control-plane [flags] @@ -15,6 +15,7 @@ kubeadm join phase control-plane-prepare control-plane [flags] --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --experimental-control-plane Create a new control plane instance on this node -h, --help help for control-plane ``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md index cb87677c20..473a8eac46 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md @@ -1,9 +1,9 @@ -[EXPERIMENTAL] Downloads certificates shared among control-plane nodes from the kubeadm-certs Secret +[EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret ### Synopsis -[EXPERIMENTAL] Downloads certificates shared among control-plane nodes from the kubeadm-certs Secret +[EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret ``` kubeadm join phase control-plane-prepare download-certs [api-server-endpoint] [flags] @@ -14,6 +14,7 @@ kubeadm join phase control-plane-prepare download-certs [api-server-endpoint] [f ``` --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --discovery-file string For file-based discovery, a file or URL from which to load cluster information. --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md index 558ed7fd33..187f2ff3bb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md @@ -1,9 +1,9 @@ -Generates the kubeconfig for the new control plane components +Generate the kubeconfig for the new control plane components ### Synopsis -Generates the kubeconfig for the new control plane components +Generate the kubeconfig for the new control plane components ``` kubeadm join phase control-plane-prepare kubeconfig [api-server-endpoint] [flags] @@ -14,6 +14,7 @@ kubeadm join phase control-plane-prepare kubeconfig [api-server-endpoint] [flags ``` --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --discovery-file string For file-based discovery, a file or URL from which to load cluster information. --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md index 6120e664bb..ef670419cf 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md @@ -1,9 +1,9 @@ -Writes kubelet settings, certificates and (re)starts the kubelet +Write kubelet settings, certificates and (re)start the kubelet ### Synopsis -Writes a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)starts kubelet. +Write a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)start kubelet. ``` kubeadm join phase kubelet-start [api-server-endpoint] [flags] diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md index 70643a0da3..14f7d4b100 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md @@ -23,6 +23,7 @@ kubeadm join phase preflight [api-server-endpoint] [flags] --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. --config string Path to kubeadm config file. + --control-plane Create a new control plane instance on this node --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. --discovery-file string For file-based discovery, a file or URL from which to load cluster information. --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md index ee31960853..8ce1e6dfba 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md @@ -1,10 +1,18 @@ -Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join'. +Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join' ### Synopsis +Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join' + +The "reset" command executes the following phases: +``` +preflight Run reset pre-flight checks +update-cluster-status Remove this node from the ClusterStatus object. +remove-etcd-member Remove a local etcd member. +cleanup-node Run cleanup node. +``` -Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join'. ``` kubeadm reset [flags] @@ -12,78 +20,19 @@ kubeadm reset [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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.
-f, --force
Reset the node without prompting for confirmation.
-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.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + --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 Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + -f, --force Reset the node without prompting for confirmation. + -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. + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --skip-phases strings List of phases to be skipped +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md new file mode 100644 index 0000000000..cec28480c0 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md @@ -0,0 +1,19 @@ + +Use this command to invoke single phase of the reset workflow + +### Synopsis + +Use this command to invoke single phase of the reset workflow + +### Options + +``` + -h, --help help for phase +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md new file mode 100644 index 0000000000..2d7c4e9926 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md @@ -0,0 +1,25 @@ + +Run cleanup node. + +### Synopsis + +Run cleanup node. + +``` +kubeadm reset phase cleanup-node [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 Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. + -h, --help help for cleanup-node +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md new file mode 100644 index 0000000000..e40c970712 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md @@ -0,0 +1,25 @@ + +Run reset pre-flight checks + +### Synopsis + +Run pre-flight checks for kubeadm reset. + +``` +kubeadm reset phase preflight [flags] +``` + +### Options + +``` + -f, --force Reset the node without prompting for confirmation. + -h, --help help for preflight + --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. +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md new file mode 100644 index 0000000000..7642494a5b --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md @@ -0,0 +1,24 @@ + +Remove a local etcd member. + +### Synopsis + +Remove a local etcd member for a control plane node. + +``` +kubeadm reset phase remove-etcd-member [flags] +``` + +### Options + +``` + -h, --help help for remove-etcd-member + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md new file mode 100644 index 0000000000..08b87e73ae --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md @@ -0,0 +1,23 @@ + +Remove this node from the ClusterStatus object. + +### Synopsis + +Remove this node from the ClusterStatus object if the node is a control plane node. + +``` +kubeadm reset phase update-cluster-status [flags] +``` + +### Options + +``` + -h, --help help for update-cluster-status +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md index 0f57b4a9fd..85aecc6f46 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md @@ -1,10 +1,9 @@ -Manage bootstrap tokens. +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. @@ -20,7 +19,7 @@ What is a bootstrap token more exactly? - The name of the Secret must be named "bootstrap-token-(token-id)". You can read more about bootstrap tokens here: - /docs/admin/bootstrap-tokens/ + https://kubernetes.io/docs/admin/bootstrap-tokens/ ``` @@ -29,54 +28,15 @@ kubeadm token [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - +``` + --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. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` ### Options inherited from parent commands - - - - - - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md index dfb557fcc6..6c35a2166b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md @@ -1,10 +1,9 @@ -Create bootstrap tokens on the server. +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. @@ -19,99 +18,21 @@ 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 stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-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]
- - +``` + --config string Path to a kubeadm configuration file. + --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 "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z" (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]) +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--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. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --dry-run Whether to enable dry-run mode or not + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md index 415ce6e107..8dd1908b43 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md @@ -1,73 +1,30 @@ -Delete bootstrap tokens on the server. +Delete bootstrap tokens on the server ### Synopsis - -This command will delete a given bootstrap token for you. +This command will delete a list of bootstrap tokens for you. The [token-value] is the full Token of the form "[a-z0-9]{6}.[a-z0-9]{16}" or the Token ID of the form "[a-z0-9]{6}" to delete. ``` -kubeadm token delete [token-value] +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     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --dry-run Whether to enable dry-run mode or not + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md index 2194e64203..a49dfb1858 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md @@ -1,10 +1,9 @@ -Generate and print a bootstrap token, but do not create it on the server. +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. @@ -22,57 +21,15 @@ 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     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --dry-run Whether to enable dry-run mode or not + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md index d49fb72c86..b4d2699d13 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md @@ -1,10 +1,9 @@ -List bootstrap tokens on the server. +List bootstrap tokens on the server ### Synopsis - This command will list all bootstrap tokens for you. @@ -14,57 +13,15 @@ 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     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --dry-run Whether to enable dry-run mode or not + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md index dd3d5f9d89..fd29befad9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md @@ -1,10 +1,9 @@ -Upgrade your cluster smoothly to a newer version with this command. +Upgrade your cluster smoothly to a newer version with this command ### Synopsis - -Upgrade your cluster smoothly to a newer version with this command. +Upgrade your cluster smoothly to a newer version with this command ``` kubeadm upgrade [flags] @@ -12,43 +11,13 @@ kubeadm upgrade [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for upgrade
- - +``` + -h, --help help for upgrade +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md index b199ac406f..7a0ad92572 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md @@ -1,10 +1,9 @@ -Upgrade your Kubernetes cluster to the specified version. +Upgrade your Kubernetes cluster to the specified version ### Synopsis - -Upgrade your Kubernetes cluster to the specified version. +Upgrade your Kubernetes cluster to the specified version ``` kubeadm upgrade apply [version] @@ -12,134 +11,26 @@ kubeadm upgrade apply [version] ### 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 a kubeadm configuration file.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.
--dry-run
Do not change any state, just output what actions would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
-f, --force
Force upgrading although some requirements might not be met. This also implies non-interactive mode.
-h, --help
help for apply
--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.
--image-pull-timeout duration     Default: 15m0s
The maximum amount of time to wait for the control plane pods to be downloaded.
--kubeconfig string     Default: "/Users/tim/.kube/config"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
-y, --yes
Perform the upgrade and do not prompt for confirmation (non-interactive mode).
- - +``` + --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. + --certificate-renewal Perform the renewal of certificates used by component changed during upgrades. (default true) + --config string Path to a kubeadm configuration file. + --dry-run Do not change any state, just output what actions would be performed. + --etcd-upgrade Perform the upgrade of etcd. (default true) + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -f, --force Force upgrading although some requirements might not be met. This also implies non-interactive mode. + -h, --help help for apply + --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. + --image-pull-timeout duration The maximum amount of time to wait for the control plane pods to be downloaded. (default 15m0s) + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. + -y, --yes Perform the upgrade and do not prompt for confirmation (non-interactive mode). +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md index 0403034bdf..950b91d7ea 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md @@ -3,7 +3,6 @@ Show what differences would be applied to existing static pod manifests. See als ### Synopsis - Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run ``` @@ -12,78 +11,18 @@ kubeadm upgrade diff [version] [flags] ### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--api-server-manifest string     Default: "/etc/kubernetes/manifests/kube-apiserver.yaml"
path to API server manifest
--config string
Path to a kubeadm configuration file.
-c, --context-lines int     Default: 3
How many lines of context in the diff
--controller-manager-manifest string     Default: "/etc/kubernetes/manifests/kube-controller-manager.yaml"
path to controller manifest
-h, --help
help for diff
--scheduler-manifest string     Default: "/etc/kubernetes/manifests/kube-scheduler.yaml"
path to scheduler manifest
- - +``` + --api-server-manifest string path to API server manifest (default "/etc/kubernetes/manifests/kube-apiserver.yaml") + --config string Path to a kubeadm configuration file. + -c, --context-lines int How many lines of context in the diff (default 3) + --controller-manager-manifest string path to controller manifest (default "/etc/kubernetes/manifests/kube-controller-manager.yaml") + -h, --help help for diff + --scheduler-manifest string path to scheduler manifest (default "/etc/kubernetes/manifests/kube-scheduler.yaml") +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md index 0c76e50de5..0c58916493 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md @@ -1,10 +1,16 @@ -Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. +Upgrade commands for a node in the cluster ### Synopsis +Upgrade commands for a node in the cluster + +The "node" command executes the following phases: +``` +control-plane Upgrade the control plane instance deployed on this node, if any +kubelet-config Upgrade the kubelet configuration for this node +``` -Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. ``` kubeadm upgrade node [flags] @@ -12,43 +18,17 @@ kubeadm upgrade node [flags] ### Options - - - - - - - - - - - - - - - -
-h, --help
help for node
- - +``` + --dry-run Do not change any state, just output the actions that would be performed. + -h, --help help for node + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubelet-version string The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used + --skip-phases strings List of phases to be skipped +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md deleted file mode 100644 index 85c5ccd8fe..0000000000 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md +++ /dev/null @@ -1,86 +0,0 @@ - -Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. - -### Synopsis - - -Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the --kubelet-version parameter to determine what the desired kubelet version is. Give - -``` -kubeadm upgrade node config [flags] -``` - -### Examples - -``` - # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. - kubeadm upgrade node config --kubelet-version v1.13.0 - - # Simulates the downloading of the kubelet configuration from the ConfigMap in the cluster with a specific desired - # version. Does not change any state locally on the node. - kubeadm upgrade node config --kubelet-version v1.13.0 --dry-run -``` - -### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--dry-run
Do not change any state, just output the actions that would be performed.
-h, --help
help for config
--kubeconfig string     Default: "/etc/kubernetes/kubelet.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--kubelet-version string
The *desired* version for the kubelet after the upgrade.
- - - -### Options inherited from parent commands - - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - - diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_experimental-control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_experimental-control-plane.md deleted file mode 100644 index 7b85992770..0000000000 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_experimental-control-plane.md +++ /dev/null @@ -1,86 +0,0 @@ - -Upgrades the control plane instance deployed on this node. IMPORTANT. This command should be executed after executing `kubeadm upgrade apply` on another control plane instance - -### Synopsis - - -Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the --kubelet-version parameter to determine what the desired kubelet version is. Give - -``` -kubeadm upgrade node experimental-control-plane [flags] -``` - -### Examples - -``` - # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. - kubeadm upgrade node config --kubelet-version v1.13.0 - - # Simulates the downloading of the kubelet configuration from the ConfigMap in the cluster with a specific desired - # version. Does not change any state locally on the node. - kubeadm upgrade node config --kubelet-version v1.13.0 --dry-run -``` - -### Options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--dry-run
Do not change any state, just output the actions that would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.
-h, --help
help for experimental-control-plane
--kubeconfig string     Default: "/etc/kubernetes/kubelet.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
- - - -### Options inherited from parent commands - - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - - diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md new file mode 100644 index 0000000000..872e9f593d --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md @@ -0,0 +1,19 @@ + +Use this command to invoke single phase of the node workflow + +### Synopsis + +Use this command to invoke single phase of the node workflow + +### Options + +``` + -h, --help help for phase +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md new file mode 100644 index 0000000000..ed0d571997 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md @@ -0,0 +1,25 @@ + +Upgrade the control plane instance deployed on this node, if any + +### Synopsis + +Upgrade the control plane instance deployed on this node, if any + +``` +kubeadm upgrade node phase control-plane [flags] +``` + +### Options + +``` + --dry-run Do not change any state, just output the actions that would be performed. + -h, --help help for control-plane + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md new file mode 100644 index 0000000000..dee8786af7 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md @@ -0,0 +1,26 @@ + +Upgrade the kubelet configuration for this node + +### Synopsis + +Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the KuberneteVersion field in the kubeadm-config ConfigMap to determine what the desired kubelet version is, but the user can override this by using the --kubelet-version parameter. + +``` +kubeadm upgrade node phase kubelet-config [flags] +``` + +### Options + +``` + --dry-run Do not change any state, just output the actions that would be performed. + -h, --help help for kubelet-config + --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --kubelet-version string The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used +``` + +### Options inherited from parent commands + +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md index a58b22d6ba..62d73bd99a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md @@ -1,10 +1,9 @@ -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter ### Synopsis - -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter ``` kubeadm upgrade plan [version] [flags] @@ -12,92 +11,20 @@ kubeadm upgrade plan [version] [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 a kubeadm configuration file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
-h, --help
help for plan
--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: "/Users/tim/.kube/config"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations are searched for an existing KubeConfig file.
--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 a kubeadm configuration file. + --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. + -h, --help help for plan + --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. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") + --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md index 9e824f238c..df927d0759 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md @@ -3,7 +3,6 @@ Print the version of kubeadm ### Synopsis - Print the version of kubeadm ``` @@ -12,50 +11,14 @@ 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' +``` ### Options inherited from parent commands - - - - - - - - - - - - - - - -
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
- - +``` + --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. +``` diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md index b5114e0861..35e38af3f7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md @@ -14,19 +14,41 @@ weight: 90 ## kubeadm alpha certs renew {#cmd-certs-renew} You can renew all Kubernetes certificates using the `all` subcommand or renew them selectively. +For more details about certificate expiration and renewal see the [certificate management documentation](docs/tasks/administer-cluster/kubeadm/kubeadm-certs). {{< tabs name="tab-certs-renew" >}} {{< tab name="renew" include="generated/kubeadm_alpha_certs_renew.md" />}} {{< tab name="all" include="generated/kubeadm_alpha_certs_renew_all.md" />}} +{{< tab name="admin.conf" include="generated/kubeadm_alpha_certs_renew_admin.conf.md" />}} {{< tab name="apiserver-etcd-client" include="generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md" />}} {{< tab name="apiserver-kubelet-client" include="generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md" />}} {{< tab name="apiserver" include="generated/kubeadm_alpha_certs_renew_apiserver.md" />}} +{{< tab name="controller-manager.conf" include="generated/kubeadm_alpha_certs_renew_controller-manager.conf.md" />}} {{< tab name="etcd-healthcheck-client" include="generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md" />}} {{< tab name="etcd-peer" include="generated/kubeadm_alpha_certs_renew_etcd-peer.md" />}} {{< tab name="etcd-server" include="generated/kubeadm_alpha_certs_renew_etcd-server.md" />}} {{< tab name="front-proxy-client" include="generated/kubeadm_alpha_certs_renew_front-proxy-client.md" />}} +{{< tab name="scheduler.conf" include="generated/kubeadm_alpha_certs_renew_scheduler.conf.md" />}} {{< /tabs >}} +## kubeadm alpha certs certificate-key {#cmd-certs-certificate-key} + +This command can be used to generate a new control-plane certificate key. +The key can be passed as `--certificate-key` to `kubeadm init` and `kubeadm join` +to enable the automatic copy of certificates when joining additional control-plane nodes. + +{{< tabs name="tab-certs-certificate-key" >}} +{{< tab name="certificate-key" include="generated/kubeadm_alpha_certs_certificate-key.md" />}} +{{< /tabs >}} + +## kubeadm alpha certs check-expiration {#cmd-certs-check-expiration} + +This command checks expiration for the certificates in the local PKI managed by kubeadm. +For more details about certificate expiration and renewal see the [certificate management documentation](docs/tasks/administer-cluster/kubeadm/kubeadm-certs). + +{{< tabs name="tab-certs-check-expiration" >}} +{{< tab name="check-expiration" include="generated/kubeadm_alpha_certs_check-expiration.md" />}} +{{< /tabs >}} ## kubeadm alpha kubeconfig user {#cmd-phase-kubeconfig} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md index e7ea1eaefe..b740d18e9c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md @@ -28,12 +28,6 @@ has to be used. {{% /capture %}} {{% capture body %}} -## kubeadm config upload from-file {#cmd-config-from-file} -{{< include "generated/kubeadm_config_upload_from-file.md" >}} - -## kubeadm config upload from-flags {#cmd-config-from-flags} -{{< include "generated/kubeadm_config_upload_from-flags.md" >}} - ## kubeadm config view {#cmd-config-view} {{< include "generated/kubeadm_config_view.md" >}} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init-phase.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init-phase.md index c65da6fddb..7cbbfcbddb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init-phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init-phase.md @@ -32,7 +32,7 @@ Can be used to create all required certificates by kubeadm. {{< tab name="etcd-server" include="generated/kubeadm_init_phase_certs_etcd-server.md" />}} {{< tab name="front-proxy-ca" include="generated/kubeadm_init_phase_certs_front-proxy-ca.md" />}} {{< tab name="front-proxy-client" include="generated/kubeadm_init_phase_certs_front-proxy-client.md" />}} -{{< tab name="certs_sa" include="generated/kubeadm_init_phase_certs_sa.md" />}} +{{< tab name="sa" include="generated/kubeadm_init_phase_certs_sa.md" />}} {{< /tabs >}} ## kubeadm init phase kubeconfig {#cmd-phase-kubeconfig} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md index 07d797b708..5a0a1fddf0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -92,7 +92,7 @@ You can also use `--help` to see the list of sub-phases for a certain parent pha sudo kubeadm init phase control-plane --help ``` -`kubeadm init` also expose a flag called `--skip-phases` that can be used to skip certain phases. The flag accepts a list of phase names and the names can be taken from the above ordered list. +`kubeadm init` also exposes a flag called `--skip-phases` that can be used to skip certain phases. The flag accepts a list of phase names and the names can be taken from the above ordered list. An example: @@ -154,6 +154,30 @@ Allowed customization are: Please note that the configuration field `kubernetesVersion` or the command line flag `--kubernetes-version` affect the version of the images. +### Uploading control-plane certificates to the cluster + +By adding the flag `--upload-certs` to `kubeadm init` you can temporary upload +the control-plane certificates to a Secret in the cluster. Please note that this Secret +will expire automatically after 2 hours. The certificates are encrypted using +a 32byte key that can be specified using `--certificate-key`. The same key can be used +to download the certificates when additional control-plane nodes are joining, by passing +`--control-plane` and `--certificate-key` to `kubeadm join`. + +The following phase command can be used to re-upload the certificates after expiration: + +``` +kubeadm init phase upload-certs --upload-certs --certificate-key=SOME_VALUE +``` + +If the flag `--certificate-key` is not passed to `kubeadm init` and +`kubeadm init phase upload-certs` a new key will be generated automatically. + +The following command can be used to generate a new key on demand: + +``` +kubeadm alpha certs certificate-key +``` + ### Using custom certificates {#custom-certificates} By default, kubeadm generates all the certificates needed for a cluster to run. @@ -191,14 +215,18 @@ This is what it looks like: ``` [Service] -Environment="KUBELET_KUBECONFIG_ARGS=--bootstrap-kubeconfig=/etc/kubernetes/bootstrap-kubelet.conf --kubeconfig=/etc/kubernetes/kubelet.conf" -Environment="KUBELET_SYSTEM_PODS_ARGS=--pod-manifest-path=/etc/kubernetes/manifests --allow-privileged=true" -Environment="KUBELET_NETWORK_ARGS=--network-plugin=cni --cni-conf-dir=/etc/cni/net.d --cni-bin-dir=/opt/cni/bin" -Environment="KUBELET_DNS_ARGS=--cluster-dns=10.96.0.10 --cluster-domain=cluster.local" -Environment="KUBELET_AUTHZ_ARGS=--authorization-mode=Webhook --client-ca-file=/etc/kubernetes/pki/ca.crt" -Environment="KUBELET_CADVISOR_ARGS=" -Environment="KUBELET_CERTIFICATE_ARGS=--rotate-certificates=true --cert-dir=/var/lib/kubelet/pki" -ExecStart=/usr/bin/kubelet $KUBELET_KUBECONFIG_ARGS $KUBELET_SYSTEM_PODS_ARGS $KUBELET_NETWORK_ARGS $KUBELET_DNS_ARGS $KUBELET_AUTHZ_ARGS $KUBELET_CADVISOR_ARGS $KUBELET_CERTIFICATE_ARGS $KUBELET_EXTRA_ARGS +Environment="KUBELET_KUBECONFIG_ARGS=--bootstrap-kubeconfig=/etc/kubernetes/bootstrap-kubelet.conf +--kubeconfig=/etc/kubernetes/kubelet.conf" +Environment="KUBELET_CONFIG_ARGS=--config=/var/lib/kubelet/config.yaml" +# This is a file that "kubeadm init" and "kubeadm join" generates at runtime, populating +the KUBELET_KUBEADM_ARGS variable dynamically +EnvironmentFile=-/var/lib/kubelet/kubeadm-flags.env +# This is a file that the user can use for overrides of the kubelet args as a last resort. Preferably, +#the user should use the .NodeRegistration.KubeletExtraArgs object in the configuration files instead. +# KUBELET_EXTRA_ARGS should be sourced from this file. +EnvironmentFile=-/etc/default/kubelet +ExecStart= +ExecStart=/usr/bin/kubelet $KUBELET_KUBECONFIG_ARGS $KUBELET_CONFIG_ARGS $KUBELET_KUBEADM_ARGS $KUBELET_EXTRA_ARGS ``` Here's a breakdown of what/why: @@ -269,7 +297,7 @@ using an external CRI implementation. ### Setting the node name By default, `kubeadm` assigns a node name based on a machine's host address. You can override this setting with the `--node-name`flag. -The flag passes the appropriate [`--hostname-override`](/docs/reference/command-line-tools-reference/kubelet/#options) +The flag passes the appropriate [`--hostname-override`](/docs/reference/command-line-tools-reference/kubelet/#options) to the kubelet. Be aware that overriding the hostname can [interfere with cloud providers](https://github.com/kubernetes/website/pull/8873). @@ -305,9 +333,16 @@ know the IP address that the control-plane node will have after it is started. kubeadm token generate ``` -1. Start both the control-plane node and the worker nodes concurrently with this token. - As they come up they should find each other and form the cluster. The same - `--token` argument can be used on both `kubeadm init` and `kubeadm join`. +1. Start both the control-plane node and the worker nodes concurrently with this token. + As they come up they should find each other and form the cluster. The same + `--token` argument can be used on both `kubeadm init` and `kubeadm join`. + +1. Similar can be done for `--certificate-key` when joining additional control-plane + nodes. The key can be generated using: + + ```shell + kubeadm alpha certs certificate-key + ``` Once the cluster is up, you can grab the admin credentials from the control-plane node at `/etc/kubernetes/admin.conf` and use that to talk to the cluster. diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md index 7852e16af1..563f6390ff 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-join.md @@ -98,9 +98,12 @@ kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert For control-plane nodes: ```shell -kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef --experimental-control-plane 1.2.3.4:6443 +kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef --control-plane 1.2.3.4:6443 ``` +You can also call `join` for a control-plane node with `--certificate-key` to copy certificates to this node, +if the `kubeadm init` command was called with `--upload-certs`. + **Advantages:** - Allows bootstrapping nodes to securely discover a root of trust for the @@ -250,7 +253,7 @@ contain a `JoinConfiguration` structure. To print the default values of `JoinConfiguration` run the following command: ```shell -kubeadm config print-default --api-objects=JoinConfiguration +kubeadm config print join-defaults ``` For details on individual fields in `JoinConfiguration` see [the godoc](https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#JoinConfiguration). diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset-phase.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset-phase.md new file mode 100644 index 0000000000..6d17e73c09 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset-phase.md @@ -0,0 +1,53 @@ +--- +title: kubeadm reset phase +weight: 90 +--- +In v1.15.0, kubeadm introduces the `kubeadm reset phase` command with the aim of making kubeadm more modular. This modularity enables you to invoke atomic sub-steps of the reset process. +Hence, you can let kubeadm do some parts and fill in yourself where you need customizations. + +`kubeadm reset phase` is consistent with the [kubeadm reset workflow](/docs/reference/setup-tools/kubeadm/kubeadm-reset/#reset-workflow), +and behind the scene both use the same code. + +## kubeadm reset phase {#cmd-reset-phase} + +{{< tabs name="tab-phase" >}} +{{< tab name="phase" include="generated/kubeadm_reset_phase.md" />}} +{{< /tabs >}} + +## kubeadm reset phase preflight {#cmd-reset-phase-preflight} + +Using this phase you can execute preflight checks on a node that is being reset. + +{{< tabs name="tab-preflight" >}} +{{< tab name="preflight" include="generated/kubeadm_reset_phase_preflight.md" />}} +{{< /tabs >}} + +## kubeadm reset phase update-cluster-status {#cmd-reset-phase-update-cluster-status} + +Using this phase you can remove this control-plane node from the ClusterStatus object. + +{{< tabs name="tab-update-cluster-status" >}} +{{< tab name="update-cluster-status" include="generated/kubeadm_reset_phase_update-cluster-status.md" />}} +{{< /tabs >}} + +## kubeadm reset phase remove-etcd-member {#cmd-reset-phase-remove-etcd-member} + +Using this phase you can remove this control-plane node's etcd member from the etcd cluster. + +{{< tabs name="tab-remove-etcd-member" >}} +{{< tab name="remove-etcd-member" include="generated/kubeadm_reset_phase_remove-etcd-member.md" />}} +{{< /tabs >}} + +## kubeadm reset phase cleanup-node {#cmd-reset-phase-cleanup-node} + +Using this phase you can perform cleanup on this node. + +{{< tabs name="tab-cleanup-node" >}} +{{< tab name="cleanup-node" include="generated/kubeadm_reset_phase_cleanup-node.md" />}} +{{< /tabs >}} + +## What's next +* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node +* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster +* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join` +* [kubeadm alpha](/docs/reference/setup-tools/kubeadm/kubeadm-alpha/) to try experimental functionality diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset.md index 94ecaeb098..5847e6209d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-reset.md @@ -14,7 +14,18 @@ This command reverts any changes made by `kubeadm init` or `kubeadm join`. {{% capture body %}} {{< include "generated/kubeadm_reset.md" >}} -### External etcd clean up! +### Reset workflow {#reset-workflow} + +`kubeadm reset` is responsible for cleaning up a node local file system from files that were created using +the `kubeadm init` or `kubeadm join` commands. For control-plane nodes `reset` also removes the local stacked +etcd member of this node from the etcd cluster and also removes this node's information from the kubeadm +`ClusterStatus` object. `ClusterStatus` is a kubeadm managed Kubernetes API object that holds a list of kube-apiserver endpoints. + +`kubeadm reset phase` can be used to execute the separate phases of the above workflow. +To skip a list of phases you can use the `--skip-phases` flag, which works in a similar way to +the `kubeadm join` and `kubeadm init` phase runners. + +### External etcd clean up `kubeadm reset` will not delete any etcd data if external etcd is used. This means that if you run `kubeadm init` again using the same etcd endpoints, you will see state from previous clusters. diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade-phase.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade-phase.md new file mode 100644 index 0000000000..6224a18e0e --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade-phase.md @@ -0,0 +1,26 @@ +--- +title: kubeadm upgrade phase +weight: 90 +--- +In v1.15.0, kubeadm introduced preliminary support for `kubeadm upgrade node` phases. +Phases for other `kubeadm upgrade` sub-commands such as `apply`, could be added in the +following releases. + +## kubeadm upgrade node phase {#cmd-node-phase} + +Using this phase you can choose to execute the separate steps of the upgrade of +secondary control-plane or worker nodes. Please note that `kubeadm upgrade apply` still has to +be called on a primary control-plane node. + +{{< tabs name="tab-phase" >}} +{{< tab name="phase" include="generated/kubeadm_upgrade_node_phase.md" />}} +{{< tab name="control-plane" include="generated/kubeadm_upgrade_node_phase_control-plane.md" />}} +{{< tab name="kubelet-config" include="generated/kubeadm_upgrade_node_phase_kubelet-config.md" />}} +{{< /tabs >}} + +## What's next +* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node +* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster +* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join` +* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/) to upgrade a kubeadm node +* [kubeadm alpha](/docs/reference/setup-tools/kubeadm/kubeadm-alpha/) to try experimental functionality diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md index b525a62edc..1de1da50b2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md @@ -14,15 +14,16 @@ cluster if necessary. {{% /capture %}} {{% capture body %}} + ## kubeadm upgrade guidance Every upgrade process might be a bit different, so we've documented each minor upgrade process individually. For more version-specific upgrade guidance, see the following resources: - * [1.10 to 1.11 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-11/) - * [1.11 to 1.12 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-12/) * [1.12 to 1.13 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/) - + * [1.13 to 1.14 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-14/) + * [1.14 to 1.15 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-15/) + _For older versions, please refer to older documentation sets on the Kubernetes website._ In Kubernetes v1.11.0 and later, you can use `kubeadm upgrade diff` to see the changes that would be @@ -30,6 +31,11 @@ applied to static pod manifests. To use kube-dns with upgrades in Kubernetes v1.13.0 and later please follow [this guide](docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon). +In Kubernetes v1.15.0 and later, `kubeadm upgrade apply` and `kubeadm upgrade node` will also +automatically renew the kubeadm managed certificates on this node, including those stored in kubeconfig files. +To opt-out, it is possible to pass the flag `--certificate-renewal=false`. For more details about certificate +renewal see the [certificate management documentation](docs/tasks/administer-cluster/kubeadm/kubeadm-certs). + ## kubeadm upgrade plan {#cmd-upgrade-plan} {{< include "generated/kubeadm_upgrade_plan.md" >}} @@ -39,11 +45,8 @@ To use kube-dns with upgrades in Kubernetes v1.13.0 and later please follow [thi ## kubeadm upgrade diff {#cmd-upgrade-diff} {{< include "generated/kubeadm_upgrade_diff.md" >}} -## kubeadm upgrade node config {#cmd-upgrade-node-config} -{{< include "generated/kubeadm_upgrade_node_config.md" >}} - -## kubeadm upgrade node experimental-control-plane {#cmd-experimental-control-plane} -{{< include "generated/kubeadm_upgrade_node_experimental-control-plane.md" >}} +## kubeadm upgrade node {#cmd-upgrade-node} +{{< include "generated/kubeadm_upgrade_node.md" >}} {{% /capture %}}