multipass-microk8s.md

MicroK8s in Multipass

This guide will take you through the process of setting up MicroK8s in Multipass for testing Juju Dashboard.

Note: this setup is recommended for testing only and will require additional steps to view the dashboard each time the Multipass container is booted.

This guide builds upon some docs from each project that may be useful if you run into issues:

• Installing MicroK8s with multipass
• How to use MicroK8s with Juju
• Deploy Juju Dashboard
• Building and Testing the k8s charm

To begin, launch and enter into a new Multipass container:

multipass launch -c 2 -d 20G -m 8G --name microk8s
multipass shell microk8s

Now install MicroK8s. Newer versions of Juju require strict MicroK8s (you can check for newer strict channels using snap info microk8s).

sudo snap install microk8s --channel=1.28-strict/stable

You will need to be in the microk8s group so run:

sudo usermod -a -G snap_microk8s ubuntu

To reload your groups exit the multipass shell and then enter it again:

multipass shell microk8s

Now enable the storage and DNS add-ons:

sudo microk8s status --wait-ready
sudo microk8s.enable hostpath-storage
sudo microk8s.enable dns
sudo microk8s status --wait-ready

Install Juju:

sudo snap install juju --channel=latest
mkdir -p ~/.local/share

Bootstrap a new controller in MicroK8s:

juju bootstrap microk8s micro
juju change-user-password admin

Switch to the controller model:

juju switch controller

You have a choice of either using the charm from Charmhub or building the charm locally.

Deploy from Charmhub

To deploy from Charmhub run:

juju deploy juju-dashboard-k8s dashboard

Now move on to the post deployment instructions.

Build the charm

You will need to install Docker Engine. The simplest method is to use the install script:

sudo apt update && sudo apt-get install uidmap -y
curl -sSL https://get.docker.com/ | sh
dockerd-rootless-setuptool.sh install
sudo usermod -aG docker $USER

Now exit and then enter the shell to reload your groups:

multipass shell microk8s

Fetch the dashboard:

git clone https://github.com/canonical/juju-dashboard.git
cd juju-dashboard

Build and import the Docker image:

DOCKER_BUILDKIT=1 docker build -t juju-dashboard .
docker image save juju-dashboard | microk8s ctr image import -

Now get the dashboard charm:

cd ~
git clone https://github.com/canonical/juju-dashboard-charm.git
cd juju-dashboard-charm/k8s-charm/

Install Charmcraft:

sudo snap install charmcraft --classic
lxd init --auto

Build the charm:

charmcraft pack

Get the ID of the Docker image you built earlier:

docker image inspect juju-dashboard | grep "Id"

Then deploy the charm using the image ID:

juju deploy --resource dashboard-image=[docker-image-id] ./juju-dashboard*.charm dashboard

Now you can move on to the post deployment steps.

Post deployment

Once your charm has been deployed run:

juju integrate controller dashboard

Wait for the charm to have been deployed (you can check with juju status) then you will need to forward the dashboard port so that you can access the dashboard from outside the Multipass container.

microk8s.kubectl port-forward dashboard-0 8080:8080 --namespace=controller-micro --address=0.0.0.0

Exit the Multipass shell and find the IP of the Multipass container:

multipass info microk8s

Now you can access the dashboard at http://[multipass.ip]:8080.

Once you're finished with MicroK8s you can stop the Multipass container with:

multipass stop

If you don't need it anymore you can remove it with:

multipass delete microk8s
multipass purge

Reboot instructions

Each time you start the Multipass container you will need to do the following steps:

Remove the dashboard with:

juju switch controller
juju remove-application dashboard

Then redeploy the dashboard using the method you used previously.

If you deployed from Charmhub then deploy again in the same way:

juju deploy juju-dashboard-k8s dashboard

If you deployed from a locally built charm then run:

cd juju-dashboard-charm/k8s-charm/
docker image inspect juju-dashboard | grep "Id"
juju deploy --resource dashboard-image=[docker-image-id] ./juju-dashboard*.charm dashboard

For both methods you will need to integrate the dashboard:

juju integrate controller dashboard

Check the status with juju status and wait for the dashboard to be deployed and then run:

microk8s.kubectl port-forward dashboard-0 8080:8080 --namespace=controller-micro --address=0.0.0.0

You should now be able to access the dashboard again.