Skip to main content

Installing the tools

Install cli tools​

In this workshop, you will deploy Kratix on a local Kubernetes cluster, and deploy Kratix workloads on another Kubernetes cluster. You will need the following tools:

  1. kind CLI / Kubernetes-in-Docker (KinD):
    Used to create and manage local Kubernetes clusters in Docker.
    See the quick start guide to install.

  2. docker CLI / Docker:
    Used to orchestrate containers. kind requires that you have Docker installed and configured.
    See Get Docker to install.

  3. kubectl / Kubernetes command-line tool:
    The CLI for Kubernetes—allows you to run commands against Kubernetes clusters.
    See the install guide.

  4. yq / YAML parsing command-line tool:
    The CLI for Kubernetes—allows you to run parse and transform YAML files. This is only used in Part II.
    See the install guide.

  5. mc / MinIO Client:
    The CLI for MinIO—allows you to run commands against MinIO clusters.
    See the install guide.

  6. git / Git:
    The CLI for Git—allows you to clone the Kratix repository.
    See the install guide.

info

You can run the workshop without KinD. Ideally, you will have access to two Kubernetes clusters.

One cluster will be the Platform cluster, where Kratix will be installed. Whenever you see --context kind-platform, replace it with the context of your platform cluster.

The other worker will be the Worker cluster. Whenever you see --context kind-worker, replace it with the context of your worker cluster.

If you want to try it on a single cluster, you can omit the --context flag and argument entirely.

Install the WorkerResourcesBuilder​

For Part II of this workshop, you will need to install the WorkerResourcesBuilder binary. This is a tool that will help you inject Promise dependencies into your Promise definition. Please install the binary for your operating system:

mkdir -p bin
curl -sLo ./bin/worker-resource-builder.tar.gz https://github.com/syntasso/kratix/releases/download/v0.0.4/worker-resource-builder_0.0.4_darwin_amd64.tar.gz
tar -xvf ./bin/worker-resource-builder.tar.gz -C ./bin
mv ./bin/worker-resource-builder-v* ./bin/worker-resource-builder
chmod +x ./bin/worker-resource-builder

Make sure to add the binary to your PATH environment variable.

Docker Resources​

In order to complete all tutorials in this series, you must allocate enough resources to Docker. Ensure you allocate at least:

  • 5 CPU
  • 12GB Memory
  • 4GB swap

This can be managed through your tool of choice (e.g. Docker Desktop, Rancher, etc).

You are now ready to create the clusters for the workshop!