kubeadm init phase
In v1.8.0, kubeadm introduced the kubeadm alpha phase command with the aim of making kubeadm more modular. In v1.13.0 this command graduated to kubeadm init phase. This modularity enables you to invoke atomic sub-steps of the bootstrap process. Hence, you can let kubeadm do some parts and fill in yourself where you need customizations.
kubeadm init phase is consistent with the kubeadm init workflow,
and behind the scene both use the same code.
kubeadm init phase preflight
Using this command you can execute preflight checks on a control-plane node.
Run master pre-flight checks
Synopsis
Run master pre-flight checks, functionally equivalent to what implemented by kubeadm init.
kubeadm init phase preflight [flags]
Examples
# Run master pre-flight checks 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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase certs
Can be used to create all required certificates by kubeadm.
- certs
- all
- apiserver-etcd-client
- apiserver-kubelet-client
- apiserver
- ca
- etcd-ca
- healthcheck-client
- etcd-peer
- etcd-server
- front-proxy-ca
- front-proxy-client
- certs_sa
Certificate generation
Synopsis
This command is not meant to be run on its own. See list of available subcommands.
kubeadm init phase certs [flags]
Options
| -h, --help | |
| help for certs | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates all certificates
Synopsis
Generates all certificates
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". | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the client 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the Client 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
Default SANs are kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc.cluster.local, 10.96.0.1, 127.0.0.1
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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". | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the client 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the credentials 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.
Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the certificate for serving etcd
Synopsis
Generates the certificate for serving etcd, and saves them into etcd/server.cert and etcd/server.key files.
Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
If both files already exist, kubeadm skips the generation step and existing files will be used.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the client for the front proxy
Synopsis
Generates the client for the front proxy, and saves 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.
Alpha Disclaimer: this command is currently alpha.
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
Alpha Disclaimer: this command is currently alpha.
kubeadm init phase certs sa [flags]
Options
| -h, --help | |
| help for sa | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase kubeconfig
You can create all required kubeconfig files by calling the all subcommand or call then individually.
Generates 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.
kubeadm init phase kubeconfig [flags]
Options
| -h, --help | |
| help for kubeconfig | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates all kubeconfig files
Synopsis
Generates all kubeconfig files
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates a kubeconfig file for the admin to use and for kubeadm itself
Synopsis
Generates the kubeconfig file for the admin and for kubeadm itself, and saves it to admin.conf file.
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates a kubeconfig file for the controller manager to use
Synopsis
Generates the kubeconfig file for the controller manager to use and saves it to controller-manager.conf file
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
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.
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase kubelet-start
This phase will write the kubelet configuration file and environment file and then start the kubelet.
Writes kubelet settings and (re)starts the kubelet
Synopsis
Writes a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)starts kubelet.
kubeadm init phase kubelet-start [flags]
Examples
# Writes a dynamic environment file with kubelet flags from a InitConfiguration file.
kubeadm init phase kubelet-start --config masterconfig.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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase control-plane
Using this phase you can create all required static Pod files for the control plane components.
Generates all static Pod manifest files necessary to establish the control plane
Synopsis
This command is not meant to be run on its own. See list of available subcommands.
kubeadm init phase control-plane [flags]
Options
| -h, --help | |
| help for control-plane | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates all static Pod manifest files
Synopsis
Generates all static Pod manifest files
kubeadm init phase control-plane 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. | |
| --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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the kube-apiserver static Pod manifest
Synopsis
Generates the kube-apiserver static Pod manifest
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the kube-controller-manager static Pod manifest
Synopsis
Generates the kube-controller-manager static Pod manifest
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates the kube-scheduler static Pod manifest
Synopsis
Generates the kube-scheduler static Pod manifest
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> | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase etcd
Use the following phase to create a local etcd instance based on a static Pod file.
Generates static Pod manifest file for local etcd.
Synopsis
This command is not meant to be run on its own. See list of available subcommands.
kubeadm init phase etcd [flags]
Options
| -h, --help | |
| help for etcd | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Generates 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.
kubeadm init phase etcd local [flags]
Examples
# Generates the static Pod manifest file for etcd, functionally
# equivalent to what is generated by kubeadm init.
kubeadm init phase etcd local
# Generates the static Pod manifest file for etcd using options
# read from a configuration file.
kubeadm init phase etcd local --config config.yaml
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 | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase upload-certs
Use the following phase to upload control-plane certificates to the cluster. By default the certs and encryption key expire after two hours.
Upload certificates to kubeadm-certs
Synopsis
This command is not meant to be run on its own. See list of available subcommands.
kubeadm init phase upload-certs [flags]
Options
--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.
Options inherited from parent commands
--rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem.
kubeadm init phase mark-control-plane
Use the following phase to label and taint the node with the node-role.kubernetes.io/master="" key-value pair.
Mark a node as a control-plane
Synopsis
Mark a node as a control-plane
kubeadm init phase mark-control-plane [flags]
Examples
# Applies control-plane label and taint to the current node, functionally equivalent to what executed by kubeadm init.
kubeadm init phase mark-control-plane --config config.yml
# Applies control-plane label and taint to a specific node
kubeadm init phase mark-control-plane --node-name myNode
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase bootstrap-token
Use the following phase to configure bootstrap tokens.
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.
kubeadm init phase bootstrap-token [flags]
Examples
# Makes all the bootstrap token configurations and creates 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'. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase upload-config
You can use this command to upload the kubeadm configuration to your cluster. Alternatively, you can use kubeadm config.
Uploads 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.
kubeadm init phase upload-config [flags]
Options
| -h, --help | |
| help for upload-config | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Uploads all configuration to a config map
Synopsis
Uploads all configuration to a config map
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Uploads 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.
Alternatively, you can use kubeadm config.
kubeadm init phase upload-config kubeadm [flags]
Examples
# uploads 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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Uploads 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.
kubeadm init phase upload-config kubelet [flags]
Examples
# Uploads 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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
kubeadm init phase addon
You can install all the available addons with the all subcommand, or
install them selectively.
Installs required addons for passing Conformance tests
Synopsis
This command is not meant to be run on its own. See list of available subcommands.
kubeadm init phase addon [flags]
Options
| -h, --help | |
| help for addon | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Installs all the addons
Synopsis
Installs all the addons
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". | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Installs the kube-proxy addon to a Kubernetes cluster
Synopsis
Installs the kube-proxy addon components via the API server.
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. | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
Installs 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.
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". | |
Options inherited from parent commands
| --rootfs string | |
| [EXPERIMENTAL] The path to the 'real' host root filesystem. | |
To use kube-dns instead of CoreDNS you have to pass a configuration file:
# for installing a DNS addon only
kubeadm init phase addon coredns --config=someconfig.yaml
# for creating a complete control plane node
kubeadm init --config=someconfig.yaml
# for listing or pulling images
kubeadm config images list/pull --config=someconfig.yaml
# for upgrades
kubeadm upgrade apply --config=someconfig.yamlThe file has to contain a DNS field inClusterConfiguration
and also a type for the addon - kube-dns (default value is CoreDNS).
apiVersion: kubeadm.k8s.io/v1beta1
kind: ClusterConfiguration
dns:
type: "kube-dns"For more details on each field in the v1beta1 configuration you can navigate to our
API reference pages.
What’s next
- kubeadm init to bootstrap a Kubernetes control-plane node
- kubeadm join to connect a node to the cluster
- kubeadm reset to revert any changes made to this host by
kubeadm initorkubeadm join - kubeadm alpha to try experimental functionality
Feedback
Was this page helpful?
Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.