constellation/bootstrapper
2024-06-25 11:51:23 +02:00
..
cmd/bootstrapper bootstrapper: disable gRPC logging (#3134) 2024-06-05 09:24:08 +02:00
initproto deps: update Go dependencies (#3185) 2024-06-21 10:05:57 +02:00
internal bootstrapper: remove unnecessary stat (#3202) 2024-06-25 11:51:23 +02:00
bootstrapping_arch.svg Bootstrapper 2022-07-14 17:25:18 +02:00
README.md dev-docs: Go package docs (#958) 2023-01-19 15:57:50 +01:00

Bootstrapper

The bootstrapper integrates the instance it is running on as node into the Kubernetes cluster. It is running on every new instance that is created.

bootstrapper architecture

The bootstrapper has two active components:

Init Flow

The InitServer is a gRPC server that is listening for initialization requests. The first instance needs to be initialized by the user, see the initproto for a description of the initialization protocol. The client that talks to this server is part of Constellation's CLI.

On an initialization request, the InitServer initializes a new Kubernetes cluster, essentially calling the InitCluster function of our Kubernetes library, which does a kubeadm init.

Join Flow

The JoinClient is a gRPC client that tries to connect to a JoinService of an already existing cluster. The JoinService validates the instance using aTLS. For details on the used protocol, see the joinservice package.

If the JoinService successfully verifies the instance, it issues a join ticket. The JoinClient then joins the cluster by calling the kubeadm join command, using the token and other needed information from the join ticket.

Synchronization, state machine, lifetime

The bootstrapper is automatically started on every new instance. Both InitServer and JoinClient are started and running in parallel. At some point during either the initialization or the join, a shared lock between the two components is acquired. This lock is used as point of no return. It is a state machine with two states (unlocked, locked) and a single transition from unlocked to locked. There is no way to unlock the node afterward (see nodelock package).

After the bootstrapping, the bootstrapper is stopped.