- Implementation details
- Core design principles
- Constants and well-known values and paths
- kubeadm init workflow internal design
- Preflight checks
- Generate the necessary certificates
- Generate kubeconfig files for control plane components
- Generate static Pod manifests for control plane components
- Generate static Pod manifest for local etcd
- Optional Dynamic Kubelet Configuration
- Wait for the control plane to come up
- (optional and alpha in v1.9) Write base kubelet configuration
- Save the kubeadm ClusterConfiguration in a ConfigMap for later reference
- Mark master
- Configure TLS-Bootstrapping for node joining
- Install addons
- kubeadm join phases internal design
- TLS Bootstrap
- Feedback
Implementation details
FEATURE STATE: Kubernetes v1.10
stableThis feature is stable, meaning:
- The version name is vX where X is an integer.
- Stable versions of features will appear in released software for many subsequent versions.
kubeadm init
and kubeadm join
together provides a nice user experience for creating a best-practice but bare Kubernetes cluster from scratch.However, it might not be obvious how kubeadm does that.
This document provides additional details on what happen under the hood, with the aim of sharing knowledge on Kubernetes cluster best practices.
- Core design principles
- Constants and well-known values and paths
- kubeadm init workflow internal design
- kubeadm join phases internal design
- TLS Bootstrap
Core design principles
The cluster that kubeadm init
and kubeadm join
set up should be:
- Secure: It should adopt latest best-practices like:
- enforcing RBAC
- using the Node Authorizer
- using secure communication between the control plane components
- using secure communication between the API server and the kubelets
- lock-down the kubelet API
- locking down access to the API for system components like the kube-proxy and CoreDNS
- locking down what a Bootstrap Token can access
- etc.
- Easy to use: The user should not have to run anything more than a couple of commands:
kubeadm init
export KUBECONFIG=/etc/kubernetes/admin.conf
kubectl apply -f <network-of-choice.yaml>
kubeadm join —token <token> <master-ip>:<master-port>
- Extendable:
- It should for example not favor any network provider, instead configuring a network is out-of-scope
- Should provide the possibility to use a config file for customizing various parameters
Constants and well-known values and paths
In order to reduce complexity and to simplify development of an on-top-of-kubeadm-implemented deployment solution, kubeadm uses alimited set of constants values for well know-known paths and file names.
The Kubernetes directory /etc/kubernetes
is a constant in the application, since it is clearly the given pathin a majority of cases, and the most intuitive location; other constants paths and file names are:
/etc/kubernetes/manifests
as the path where kubelet should look for static Pod manifests. Names of static Pod manifests are:etcd.yaml
kube-apiserver.yaml
kube-controller-manager.yaml
kube-scheduler.yaml
/etc/kubernetes/
as the path where kubeconfig files with identities for control plane components are stored. Names of kubeconfig files are:kubelet.conf
(bootstrap-kubelet.conf
during TLS bootstrap)controller-manager.conf
scheduler.conf
admin.conf
for the cluster admin and kubeadm itself
- Names of certificates and key files :
ca.crt
,ca.key
for the Kubernetes certificate authorityapiserver.crt
,apiserver.key
for the API server certificateapiserver-kubelet-client.crt
,apiserver-kubelet-client.key
for the client certificate used by the API server to connect to the kubelets securelysa.pub
,sa.key
for the key used by the controller manager when signing ServiceAccountfront-proxy-ca.crt
,front-proxy-ca.key
for the front proxy certificate authorityfront-proxy-client.crt
,front-proxy-client.key
for the front proxy client
kubeadm init workflow internal design
The kubeadm init
internal workflow consists of a sequence of atomic work tasks to perform,as described in kubeadm init
.
The kubeadm init phase
command allows users to invoke individually each task, and ultimately offers a reusable and composableAPI/toolbox that can be used by other Kubernetes bootstrap tools, by any IT automation tool or by advanced userfor creating custom clusters.
Preflight checks
Kubeadm executes a set of preflight checks before starting the init, with the aim to verify preconditions and avoid common cluster startup problems.In any case the user can skip specific preflight checks (or eventually all preflight checks) with the —ignore-preflight-errors
option.
- [warning] If the Kubernetes version to use (specified with the
—kubernetes-version
flag) is at least one minor version higher than the kubeadm CLI version. - Kubernetes system requirements:
- if running on linux:
- [error] if not Kernel 3.10+ or 4+ with specific KernelSpec
- [error] if required cgroups subsystem aren’t in set up
- if using docker:
- [warning/error] if Docker service does not exist, if it is disabled, if it is not active.
- [error] if Docker endpoint does not exist or does not work
- [warning] if docker version >17.03
- If using other cri engine:
- [error] if crictl socket does not answer
- [error] if user is not root
- [error] if the machine hostname is not a valid DNS subdomain
- [warning] if the host name cannot be reached via network lookup
- [error] if kubelet version is lower that the minimum kubelet version supported by kubeadm (current minor -1)
- [error] if kubelet version is at least one minor higher than the required controlplane version (unsupported version skew)
- [warning] if kubelet service does not exist or if it is disabled
- [warning] if firewalld is active
- [error] if API server bindPort or ports 10250/10251/10252 are used
- [Error] if
/etc/kubernetes/manifest
folder already exists and it is not empty - [Error] if
/proc/sys/net/bridge/bridge-nf-call-iptables
file does not exist/does not contain 1 - [Error] if advertise address is ipv6 and
/proc/sys/net/bridge/bridge-nf-call-ip6tables
does not exist/does not contain 1. - [Error] if swap is on
- [Error] if
ip
,iptables
,mount
,nsenter
commands are not present in the command path - [warning] if
ebtables
,ethtool
,socat
,tc
,touch
,crictl
commands are not present in the command path - [warning] if extra arg flags for API server, controller manager, scheduler contains some invalid options
- [warning] if connection to https://API.AdvertiseAddress:API.BindPort goes through proxy
- [warning] if connection to services subnet goes through proxy (only first address checked)
- [warning] if connection to Pods subnet goes through proxy (only first address checked)
- If external etcd is provided:
- [Error] if etcd version less than 3.0.14
- [Error] if etcd certificates or keys are specified, but not provided
- If external etcd is NOT provided (and thus local etcd will be installed):
- [Error] if ports 2379 is used
- [Error] if Etcd.DataDir folder already exists and it is not empty
- If authorization mode is ABAC:
- [Error] if abac_policy.json does not exist
- If authorization mode is WebHook
- [Error] if webhook_authz.conf does not exist
Please note that:
- Preflight checks can be invoked individually with the
kubeadm init phase preflight
command
Generate the necessary certificates
Kubeadm generates certificate and private key pairs for different purposes:
- A self signed certificate authority for the Kubernetes cluster saved into
ca.crt
file andca.key
private key file - A serving certificate for the API server, generated using
ca.crt
as the CA, and saved intoapiserver.crt
file withits private keyapiserver.key
. This certificate should contain following alternative names:- The Kubernetes service’s internal clusterIP (the first address in the services CIDR, e.g.
10.96.0.1
if service subnet is10.96.0.0/12
) - Kubernetes DNS names, e.g.
kubernetes.default.svc.cluster.local
if—service-dns-domain
flag value iscluster.local
, plus default DNS nameskubernetes.default.svc
,kubernetes.default
,kubernetes
- The node-name
- The
—apiserver-advertise-address
- Additional alternative names specified by the user
- The Kubernetes service’s internal clusterIP (the first address in the services CIDR, e.g.
- A client certificate for the API server to connect to the kubelets securely, generated using
ca.crt
as the CA and saved intoapiserver-kubelet-client.crt
file with its private keyapiserver-kubelet-client.key
.This certificate should be in thesystem:masters
organization - A private key for signing ServiceAccount Tokens saved into
sa.key
file along with its public keysa.pub
- A certificate authority for the front proxy saved into
front-proxy-ca.crt
file with its keyfront-proxy-ca.key
- A client cert for the front proxy client, generate using
front-proxy-ca.crt
as the CA and saved intofront-proxy-client.crt
filewith its private keyfront-proxy-client.key
Certificates are stored by default in /etc/kubernetes/pki
, but this directory is configurable using the —cert-dir
flag.
Please note that:
- If a given certificate and private key pair both exist, and its content is evaluated compliant with the above specs, the existing files willbe used and the generation phase for the given certificate skipped. This means the user can, for example, copy an existing CA to
/etc/kubernetes/pki/ca.{crt,key}
, and then kubeadm will use those files for signing the rest of the certs.See also using custom certificates - Only for the CA, it is possible to provide the
ca.crt
file but not theca.key
file, if all other certificates and kubeconfig filesalready are in place kubeadm recognize this condition and activates the ExternalCA , which also implies thecsrsigner
controller incontroller-manager won’t be started - If kubeadm is running in external CA mode;all the certificates must be provided by the user, because kubeadm cannot generate them by itself
- In case of kubeadm is executed in the
—dry-run
mode, certificates files are written in a temporary folder - Certificate generation can be invoked individually with the
kubeadm init phase certs all
command
Generate kubeconfig files for control plane components
Kubeadm kubeconfig files with identities for control plane components:
- A kubeconfig file for kubelet to use,
/etc/kubernetes/kubelet.conf
; inside this file is embedded a client certificate with kubelet identity.This client cert should:- Be in the
system:nodes
organization, as required by the Node Authorization module - Have the Common Name (CN)
system:node:<hostname-lowercased>
- Be in the
- A kubeconfig file for controller-manager,
/etc/kubernetes/controller-manager.conf
; inside this file is embedded a clientcertificate with controller-manager identity. This client cert should have the CNsystem:kube-controller-manager
, as definedby default RBAC core components roles - A kubeconfig file for scheduler,
/etc/kubernetes/scheduler.conf
; inside this file is embedded a client certificate with scheduler identity.This client cert should have the CNsystem:kube-scheduler
, as defined by default RBAC core components roles
Additionally, a kubeconfig file for kubeadm to use itself and the admin is generated and save into the /etc/kubernetes/admin.conf
file.The “admin” here is defined the actual person(s) that is administering the cluster and want to have full control (root) over the cluster.The embedded client certificate for admin should:- Be in the system:masters
organization, as defined by default RBAC user facing role bindings- Include a CN, but that can be anything. Kubeadm uses the kubernetes-admin
CN
Please note that:
ca.crt
certificate is embedded in all the kubeconfig files.- If a given kubeconfig file exists, and its content is evaluated compliant with the above specs, the existing file will be used and the generation phase for the given kubeconfig skipped
- If kubeadm is running in ExternalCA mode, all the required kubeconfig must be provided by the user as well, because kubeadm cannot generate any of them by itself
- In case of kubeadm is executed in the
—dry-run
mode, kubeconfig files are written in a temporary folder - Kubeconfig files generation can be invoked individually with the
kubeadm init phase kubeconfig all
command
Generate static Pod manifests for control plane components
Kubeadm writes static Pod manifest files for control plane components to /etc/kubernetes/manifests
; the kubelet watches this directory for Pods to create on startup.
Static Pod manifest share a set of common properties:
- All static Pods are deployed on
kube-system
namespace - All static Pods gets
tier:control-plane
andcomponent:{component-name}
labels - All static Pods gets
scheduler.alpha.kubernetes.io/critical-pod
annotation (this will be moved over to the proper solutionof using Pod Priority and Preemption when ready) hostNetwork: true
is set on all static Pods to allow control plane startup before a network is configured; as a consequence:- The
address
that the controller-manager and the scheduler use to refer the API server is127.0.0.1
- If using a local etcd server,
etcd-servers
address will be set to127.0.0.1:2379
- The
- Leader election is enabled for both the controller-manager and the scheduler
- Controller-manager and the scheduler will reference kubeconfig files with their respective, unique identities
- All static Pods gets any extra flags specified by the user as described in passing custom arguments to control plane components
- All static Pods gets any extra Volumes specified by the user (Host path)
Please note that:
- All the images, for the
—kubernetes-version
/current architecture, will be pulled fromk8s.gcr.io
;In case an alternative image repository or CI image repository is specified this one will be used; In case a specific container imageshould be used for all control plane components, this one will be used. see using custom imagesfor more details - In case of kubeadm is executed in the
—dry-run
mode, static Pods files are written in a temporary folder - Static Pod manifest generation for master components can be invoked individually with the
kubeadm init phase control-plane all
command
API server
The static Pod manifest for the API server is affected by following parameters provided by the users:
- The
apiserver-advertise-address
andapiserver-bind-port
to bind to; if not provided, those value defaults to the IP address ofthe default network interface on the machine and port 6443 - The
service-cluster-ip-range
to use for services - If an external etcd server is specified, the
etcd-servers
address and related TLS settings (etcd-cafile
,etcd-certfile
,etcd-keyfile
);if an external etcd server is not be provided, a local etcd will be used (via host network) - If a cloud provider is specified, the corresponding
—cloud-provider
is configured, together with the—cloud-config
pathif such file exists (this is experimental, alpha and will be removed in a future version)
Other API server flags that are set unconditionally are:
—insecure-port=0
to avoid insecure connections to the api server—enable-bootstrap-token-auth=true
to enable theBootstrapTokenAuthenticator
authentication module.See TLS Bootstrapping for more details—allow-privileged
totrue
(required e.g. by kube proxy)—requestheader-client-ca-file
tofront-proxy-ca.crt
—enable-admission-plugins
to:NamespaceLifecycle
e.g. to avoid deletion ofsystem reserved namespacesLimitRanger
andResourceQuota
to enforce limits on namespacesServiceAccount
to enforce service account automationPersistentVolumeLabel
attaches region or zone labels toPersistentVolumes as defined by the cloud provider (This admission controller is deprecated and will be removed in a future version.It is not deployed by kubeadm by default with v1.9 onwards when not explicitly opting into usinggce
oraws
as cloud providers)DefaultStorageClass
to enforce default storage class onPersistentVolumeClaim
objectsDefaultTolerationSeconds
NodeRestriction
to limit what a kubelet can modify(e.g. only pods on this node)
—kubelet-preferred-address-types
toInternalIP,ExternalIP,Hostname;
this makeskubectl logs
and other API server-kubeletcommunication work in environments where the hostnames of the nodes aren’t resolvable- Flags for using certificates generated in previous steps:
—client-ca-file
toca.crt
—tls-cert-file
toapiserver.crt
—tls-private-key-file
toapiserver.key
—kubelet-client-certificate
toapiserver-kubelet-client.crt
—kubelet-client-key
toapiserver-kubelet-client.key
—service-account-key-file
tosa.pub
—requestheader-client-ca-file
tofront-proxy-ca.crt
—proxy-client-cert-file
tofront-proxy-client.crt
—proxy-client-key-file
tofront-proxy-client.key
- Other flags for securing the front proxy (API Aggregation) communications:
—requestheader-username-headers=X-Remote-User
—requestheader-group-headers=X-Remote-Group
—requestheader-extra-headers-prefix=X-Remote-Extra-
—requestheader-allowed-names=front-proxy-client
Controller manager
The static Pod manifest for the API server is affected by following parameters provided by the users:
- If kubeadm is invoked specifying a
—pod-network-cidr
, the subnet manager feature required for some CNI network plugins is enabled bysetting:—allocate-node-cidrs=true
—cluster-cidr
and—node-cidr-mask-size
flags according to the given CIDR- If a cloud provider is specified, the corresponding
—cloud-provider
is specified, together with the—cloud-config
pathif such configuration file exists (this is experimental, alpha and will be removed in a future version)
Other flags that are set unconditionally are:
—controllers
enabling all the default controllers plusBootstrapSigner
andTokenCleaner
controllers for TLS bootstrap.See TLS Bootstrapping for more details—use-service-account-credentials
totrue
- Flags for using certificates generated in previous steps:
—root-ca-file
toca.crt
—cluster-signing-cert-file
toca.crt
, if External CA mode is disabled, otherwise to""
—cluster-signing-key-file
toca.key
, if External CA mode is disabled, otherwise to""
—service-account-private-key-file
tosa.key
Scheduler
The static Pod manifest for the scheduler is not affected by parameters provided by the users.
Generate static Pod manifest for local etcd
If the user specified an external etcd this step will be skipped, otherwise kubeadm generates a static Pod manifest file for creatinga local etcd instance running in a Pod with following attributes:
- listen on
localhost:2379
and useHostNetwork=true
- make a
hostPath
mount out from thedataDir
to the host’s filesystem - Any extra flags specified by the user
Please note that:
- The etcd image will be pulled from
k8s.gcr.io
. In case an alternative image repository is specified this one will be used;In case an alternative image name is specified, this one will be used. see using custom images for more details - in case of kubeadm is executed in the
—dry-run
mode, the etcd static Pod manifest is written in a temporary folder - Static Pod manifest generation for local etcd can be invoked individually with the
kubeadm init phase etcd local
command
Optional Dynamic Kubelet Configuration
To use this functionality call kubeadm alpha kubelet config enable-dynamic
. It writes the kubelet init configurationinto /var/lib/kubelet/config/init/kubelet
file.
The init configuration is used for starting the kubelet on this specific node, providing an alternative for the kubelet drop-in file;such configuration will be replaced by the kubelet base configuration as described in following steps.See set Kubelet parameters via a config file for additional info.
Please note that:
- To make dynamic kubelet configuration work, flag
—dynamic-config-dir=/var/lib/kubelet/config/dynamic
should be specifiedin/etc/systemd/system/kubelet.service.d/10-kubeadm.conf
- The kubelet configuration can be changed by passing a
KubeletConfiguration
object tokubeadm init
orkubeadm join
by usinga configuration file—config some-file.yaml
. TheKubeletConfiguration
object can be separated from other objects suchasInitConfiguration
using the—-
separator. For more details have a look at thekubeadm config print-default
command.
Wait for the control plane to come up
This is a critical moment in time for kubeadm clusters.kubeadm waits until localhost:6443/healthz
returns ok
, however in order to detect deadlock conditions, kubeadm fails fastif localhost:10255/healthz
(kubelet liveness) or localhost:10255/healthz/syncloop
(kubelet readiness) don’t return ok
,respectively after 40 and 60 second.
kubeadm relies on the kubelet to pull the control plane images and run them properly as static Pods.After the control plane is up, kubeadm completes the tasks described in following paragraphs.
(optional and alpha in v1.9) Write base kubelet configuration
If kubeadm is invoked with —feature-gates=DynamicKubeletConfig
:
- Write the kubelet base configuration into the
kubelet-base-config-v1.9
ConfigMap in thekube-system
namespace - Creates RBAC rules for granting read access to that ConfigMap to all bootstrap tokens and all kubelet instances(that is
system:bootstrappers:kubeadm:default-node-token
andsystem:nodes
groups) - Enable the dynamic kubelet configuration feature for the initial control-plane node by pointing
Node.spec.configSource
to the newly-created ConfigMap
Save the kubeadm ClusterConfiguration in a ConfigMap for later reference
kubeadm saves the configuration passed to kubeadm init
, either via flags or the config file, in a ConfigMapnamed kubeadm-config
under kube-system
namespace.
This will ensure that kubeadm actions executed in future (e.g kubeadm upgrade
) will be able to determine the actual/current clusterstate and make new decisions based on that data.
Please note that:
- Before uploading, sensitive information like e.g. the token is stripped from the configuration
- Upload of master configuration can be invoked individually with the
kubeadm init phase upload-config
command - If you initialized your cluster using kubeadm v1.7.x or lower, you must create manually the master configuration ConfigMapbefore
kubeadm upgrade
to v1.8 . In order to facilitate this task, thekubeadm config upload (from-flags|from-file)
was implemented
Mark master
As soon as the control plane is available, kubeadm executes following actions:
- Label the master with
node-role.kubernetes.io/master=""
- Taints the master with
node-role.kubernetes.io/master:NoSchedule
Please note that:
- Mark control-plane phase phase can be invoked individually with the
kubeadm init phase mark-control-plane
command
Configure TLS-Bootstrapping for node joining
Kubeadm uses Authenticating with Bootstrap Tokens for joining new nodes to anexisting cluster; for more details see also design proposal.
kubeadm init
ensures that everything is properly configured for this process, and this includes following steps as well assetting API server and controller flags as already described in previous paragraphs.Please note that:
- TLS bootstrapping for nodes can be configured with the
kubeadm init phase bootstrap-token
command, executing all the configuration steps described in following paragraphs; alternatively, each step can be invoked individually
Create a bootstrap token
kubeadm init
create a first bootstrap token, either generated automatically or provided by the user with the —token
flag; as documentedin bootstrap token specification, token should be saved as secrets with name bootstrap-token-<token-id>
under kube-system
namespace.Please note that:
- The default token created by
kubeadm init
will be used to validate temporary user during TLS bootstrap process; those users willbe member ofsystem:bootstrappers:kubeadm:default-node-token
group - The token has a limited validity, default 24 hours (the interval may be changed with the
—token-ttl
flag) - Additional tokens can be created with the
kubeadm token
command, that provide as well other useful functionsfor token management
Allow joining nodes to call CSR API
Kubeadm ensures that users in system:bootstrappers:kubeadm:default-node-token
group are able to access the certificate signing API.
This is implemented by creating a ClusterRoleBinding named kubeadm:kubelet-bootstrap
between the group above and the defaultRBAC role system:node-bootstrapper
.
Setup auto approval for new bootstrap tokens
Kubeadm ensures that the Bootstrap Token will get its CSR request automatically approved by the csrapprover controller.
This is implemented by creating ClusterRoleBinding named kubeadm:node-autoapprove-bootstrap
betweenthe system:bootstrappers:kubeadm:default-node-token
group and the default role system:certificates.k8s.io:certificatesigningrequests:nodeclient
.
The role system:certificates.k8s.io:certificatesigningrequests:nodeclient
should be created as well, grantingPOST permission to /apis/certificates.k8s.io/certificatesigningrequests/nodeclient
.
Setup nodes certificate rotation with auto approval
Kubeadm ensures that certificate rotation is enabled for nodes, and that new certificate request for nodes will get its CSR requestautomatically approved by the csrapprover controller.
This is implemented by creating ClusterRoleBinding named kubeadm:node-autoapprove-certificate-rotation
between the system:nodes
groupand the default role system:certificates.k8s.io:certificatesigningrequests:selfnodeclient
.
Create the public cluster-info ConfigMap
This phase creates the cluster-info
ConfigMap in the kube-public
namespace.
Additionally it is created a role and a RoleBinding granting access to the ConfigMap for unauthenticated users(i.e. users in RBAC group system:unauthenticated
)
Please note that:
- The access to the
cluster-info
ConfigMap is not rate-limited. This may or may not be a problem if you expose your masterto the internet; worst-case scenario here is a DoS attack where an attacker uses all the in-flight requests the kube-apiservercan handle to serving thecluster-info
ConfigMap.
Install addons
Kubeadm installs the internal DNS server and the kube-proxy addon components via the API server.Please note that:
- This phase can be invoked individually with the
kubeadm init phase addon all
command.
proxy
A ServiceAccount for kube-proxy
is created in the kube-system
namespace; then kube-proxy is deployed as a DaemonSet:
- The credentials (
ca.crt
andtoken
) to the master come from the ServiceAccount - The location of the master comes from a ConfigMap
- The
kube-proxy
ServiceAccount is bound to the privileges in thesystem:node-proxier
ClusterRole
DNS
Note that:
- The CoreDNS service is named
kube-dns
. This is done to prevent any interruptionin service when the user is switching the cluster DNS from kube-dns to CoreDNS or vice-versa - In Kubernetes version 1.10 and earlier, you must enable CoreDNS with
—feature-gates=CoreDNS=true
- In Kubernetes version 1.11 and 1.12, CoreDNS is the default DNS server and you mustinvoke kubeadm with
—feature-gates=CoreDNS=false
to install kube-dns instead - In Kubernetes version 1.13 and later, the
CoreDNS
feature gate is no longer available and kube-dns can be installed using the—config
method described here
A ServiceAccount for CoreDNS/kube-dns is created in the kube-system
namespace.
Deploy the kube-dns
Deployment and Service:
- It’s the upstream CoreDNS deployment relatively unmodified
- The
kube-dns
ServiceAccount is bound to the privileges in thesystem:kube-dns
ClusterRole
kubeadm join phases internal design
Similarly to kubeadm init
, also kubeadm join
internal workflow consists of a sequence of atomic work tasks to perform.
This is split into discovery (having the Node trust the Kubernetes Master) and TLS bootstrap (having the Kubernetes Master trust the Node).
see Authenticating with Bootstrap Tokens or the corresponding design proposal.
Preflight checks
kubeadm
executes a set of preflight checks before starting the join, with the aim to verify preconditions and avoid commoncluster startup problems.
Please note that:
kubeadm join
preflight checks are basically a subsetkubeadm init
preflight checks- Starting from 1.9, kubeadm provides better support for CRI-generic functionality; in that case, docker specific controlsare skipped or replaced by similar controls for crictl.
- Starting from 1.9, kubeadm provides support for joining nodes running on Windows; in that case, linux specific controls are skipped.
- In any case the user can skip specific preflight checks (or eventually all preflight checks) with the
—ignore-preflight-errors
option.
Discovery cluster-info
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 provide a file (that is a subset of the standard kubeconfig file).
Shared token discovery
If kubeadm join
is invoked with —discovery-token
, token discovery is used; in this case the node basically retrievesthe cluster CA certificates from the cluster-info
ConfigMap in the kube-public
namespace.
In order to prevent “man in the middle” attacks, several steps are taken:
- First, the CA certificate is retrieved via insecure connection (this is possible because
kubeadm init
granted access tocluster-info
users forsystem:unauthenticated
) - Then the CA certificate goes trough following validation steps:
- Basic validation: using the token ID against a JWT signature
- Pub key validation: using provided
—discovery-token-ca-cert-hash
. This value is available in the output ofkubeadm init
or canbe calculated using standard tools (the hash is calculated over the bytes of the Subject Public Key Info (SPKI) object as in RFC7469).The—discovery-token-ca-cert-hash flag
may be repeated multiple times to allow more than one public key. - As a additional validation, the CA certificate is retrieved via secure connection and then compared with the CA retrieved initially
Please note that:
- Pub key validation can be skipped passing
—discovery-token-unsafe-skip-ca-verification
flag; This weakens the kubeadm securitymodel since others can potentially impersonate the Kubernetes Master.
File/https discovery
If kubeadm join
is invoked with —discovery-file
, file discovery is used; this file can be a local file or downloaded via an HTTPS URL; in case of HTTPS, the host installed CA bundle is used to verify the connection.
With file discovery, the cluster CA certificates is provided into the file itself; in fact, the discovery file is a kubeconfigfile with only server
and certificate-authority-data
attributes set, as described in kubeadm join
reference doc;when the connection with the cluster is established, kubeadm try to access the cluster-info
ConfigMap, and if available, uses it.
TLS Bootstrap
Once the cluster info are known, the file bootstrap-kubelet.conf
is written, thus allowing kubelet to do TLS Bootstrapping(conversely until v.1.7 TLS bootstrapping were managed by kubeadm).
The TLS bootstrap mechanism uses the shared token to temporarily authenticate with the Kubernetes Master to submit a certificatesigning request (CSR) for a locally created key pair.
The request is then automatically approved and the operation completes saving ca.crt
file and kubelet.conf
file to be usedby kubelet for joining the cluster, whilebootstrap-kubelet.conf
is deleted.
Please note that:
- The temporary authentication is validated against the token saved during the
kubeadm init
process (or with additional tokenscreated withkubeadm token
) - The temporary authentication resolve to a user member of
system:bootstrappers:kubeadm:default-node-token
group which was grantedaccess to CSR api during thekubeadm init
process - The automatic CSR approval is managed by the csrapprover controller, according with configuration done the
kubeadm init
process
(optional and alpha in v1.9) Write init kubelet configuration
If kubeadm is invoked with —feature-gates=DynamicKubeletConfig
:
- Read the kubelet base configuration from the
kubelet-base-config-v1.9
ConfigMap in thekube-system
namespace using theBootstrap Token credentials, and write it to disk as kubelet init configuration file/var/lib/kubelet/config/init/kubelet
As soon as kubelet starts with the Node’s own credential (
/etc/kubernetes/kubelet.conf
), update current node configurationspecifying that the source for the node/kubelet configuration is the above ConfigMap.Please note that:To make dynamic kubelet configuration work, flag
—dynamic-config-dir=/var/lib/kubelet/config/dynamic
should be specified in/etc/systemd/system/kubelet.service.d/10-kubeadm.conf
Feedback
Was this page helpful?
Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it onStack Overflow.Open an issue in the GitHub repo if you want toreport a problemorsuggest an improvement.