02 - Setup your environment

This part of the tutorial focuses on how to set up your environment and install the required dependencies.

Set up MicroK8s

Charmed Airbyte relies on Kubernetes (K8s) as a container orchestration system. For this tutorial, you will use MicroK8s, a lightweight distribution of K8s.

Install MicroK8s and provide your user with the required permissions. You can do so by adding it to the snap_microk8s group and giving permissions to the ~/.kube directory:

sudo snap install microk8s --channel 1.34-strict/stable
newgrp snap_microk8s
sudo usermod -a -G snap_microk8s $USER
sudo chown -f -R $USER ~/.kube

Enable the necessary MicroK8s add-ons as follows:

sudo microk8s enable hostpath-storage dns

For ease in future use, you can set up a short alias for the Kubernetes CLI with:

sudo snap alias microk8s.kubectl kubectl

Set up Juju

Charmed Airbyte uses Juju as the orchestration engine for software operators. Install and connect it to your MicroK8s cloud with the following steps.

Firstly, install juju from a snap:

sudo snap install juju --channel 3.6/stable

Note: This charm requires juju with channel >= 3.1.

Since the Juju package is strictly confined, you also need to manually create a path:

mkdir -p ~/.local/share

Juju recognises a MicroK8s cloud automatically, as you can see by running juju clouds:

# >>> Cloud      Regions  Default    Type  Credentials  Source    Description
# >>> localhost  1        localhost  lxd   0            built-in  LXD Container Hypervisor
# >>> microk8s   1        localhost  k8s   1            built-in  A Kubernetes Cluster

If for any reason MicroK8s is not recognised, register it manually using juju add-k8s microk8s.

Next, install a Juju controller into your MicroK8s cloud. For this example, the controller is named “airbyte-controller”:

juju bootstrap microk8s airbyte-controller

Finally, create a model on this controller. For this example, the model is named “airbyte-model”. Juju will create a Kubernetes namespace “airbyte-model”:

juju add-model airbyte-model

After this, you should see something similar to the below when running juju status:

# >>> Model           Controller           Cloud/Region        Version  SLA          Timestamp
# >>> airbyte-model  airbyte-controller  microk8s/localhost  3.6.12    unsupported  12:45:50+03:00

# >>> Model "admin/airbyte-model" is empty.

---

See next: Deploy supporting charms