Attention

You are viewing an older version of the documentation. The latest version is v3.3.

Deploy a KIND Cluster

This section explains the procedure to configure and run the Edge Conductor tool to deploy a KIND cluster.

Note: KIND is not intended for production use.

KIND Cluster - Preparation

Follow the Hardware and Software Requirements for Edge Conductor Day-0 Host to prepare the Day-0 host hardware and software.

Note: For each KIND node, two CPU cores and 2 gigabytes (GB) memory are needed additionally.

Follow the instructions in Build and Install Edge Conductor Tool to build and install the Edge Conductor tool. Go to the _workspace folder to run the Edge Conductor tool.

KIND Cluster - Top Config

Create kind-top-config.yml for KIND cluster as shown in the following example:

Cluster:
   type: "kind"
   config: "config/cluster/kind_cluster.yml"

Services:
   client: dev-kind

In this example, the config/cluster/kind_cluster.yml file in the Edge Conductor _workspace folder will be used to describe the KIND cluster. You can modify this file or specify a compatible KIND description file.

The client dev-kind is specified in the Services section to deploy a list of tested services on KIND.

For other config sections and detailed description, refer to Top Config.

KIND Cluster - Custom Config

Prepare a custom config file customcfg.yml based on Custom Config. Note that the custom config file is a mandatory parameter for conductor init.

KIND Cluster - Initialize Edge Conductor Environment

Run the following commands to initialize the Edge Conductor environment:

./conductor init -c kind-top-config.yml -m customcfg.yml

KIND Cluster - Build and Deploy

Run the following command to build the KIND cluster:

./conductor cluster build

You will see an output similar to:

INFO[0000] Edge Conductor - Build Cluster
INFO[0000] ==
INFO[0000] Current workflow: cluster-build
...
INFO[0005] workflow finished
INFO[0005] ==
INFO[0005] Done

Run the command:

./conductor cluster deploy

You will see an output similar to:

INFO[0000] Edge Conductor - Deploy Cluster
INFO[0000] ==
INFO[0000] Current workflow: cluster-deploy
...
INFO[0000] Deploying kind...
Creating cluster "kind" ...
✓ Ensuring node image (kindest/node:v1.21.1)
✓ Preparing nodes
✓ Writing configuration
✓ Starting control-plane
✓ Installing CNI
✓ Installing StorageClass
...
INFO[0005] workflow finished
INFO[0005] ==
INFO[0005] Done

The kubeconfig will be copied to the default path ~/.kube/config.

Check KIND Cluster

Install the kubectl tool (v1.20.0) to interact with the target cluster.

kubectl get nodes

For more details, refer to Interact with Nodes.