Page cover image

On Ubuntu

Install gopaddle lite as microk8s add-on on Ubuntu

gopaddle lite - A lifetime free community edition of gopaddle is now available as an add-on to microk8s.


  1. OS distribution: Ubuntu 18.04 or higher; MicroK8s version: 1.25 or higher;

  2. System resource requirements: 4 vCPU (Intel Arch), 8 GB RAM, 50 GB Disk

  3. 'snap' tool must already be installed.

    If not installed, the following steps can be used on Ubuntu 18.04:

    sudo apt-get install snapd -y 
    sudo snap install core

    Set the path for snap tool to be executed as a command:

    export PATH=$PATH:/snap/bin
  4. microk8s must already be installed and must be running.

    If not installed, use the below step to install the same:

    sudo snap install microk8s --classic --channel=1.26

    If already installed, you may want to refresh microk8s:

    sudo snap refresh microk8s --channel=1.26

    Check and ensure that microk8s service is running:

    sudo microk8s status --wait-ready

Steps to install gopaddle lite addon for microk8s

  1. Enable microk8s community addon and enable gopaddle lite addon.

    sudo microk8s enable community
    sudo microk8s enable gopaddle-lite -v 4.2.9

    Optional parameters while enabling the add-on.

    sudo microk8s enable gopaddle-lite [-i <IP Address>] [-v <gopaddle version>] 
    Basic Options: 
    --ip|-i : static IP address to assign to gopaddle endpoint. This can be a public or private IP address of the microk8s node 
    --version|-v : gopaddle lite helm chart version (default 4.2.5)

    If -i option is omitted, then the gopaddle endpoint is decided based on the node's private IP address. Please take a look at the 'gopaddle dashboard endpoint' section for more details.


    sudo microk8s enable gopaddle-lite -i -v 4.2.9
  2. Make a note of the gopaddle lite access endpoint from the above command. You can also obtain the endpoint by listing the node IPs in the cluster. Check the gopaddle dashboard endpoint section for more information.

  3. Wait for gopaddle services to move to running state

    sudo microk8s.kubectl wait --for=condition=ready pod -l released-by=gopaddle -n gp-lite

    If you see this error message timed out waiting for the condition on pods, you can execute the above command once again to wait for all the gopaddle services to move to running state.

  4. Access the gopaddle dashboard. If static IP is provided as an input using -i option in step 1, then accesss the gopaddle UI @ http://<STATIC_IP>:30003 , else access the gopaddle UI @ http://<NODE_IP>:30003 . The Node IP can be determined by executing the command below. If the node has a public IP, open the firewall ports in the next step.

    sudo microk8s.kubectl kubectl get nodes -o wide
  5. Enable Firewall ports (if installing gopaddle lite on a cloud based VM)

The following TCP network ports have to be enabled/opened to use the gopaddle lite dashboard:

  • Ports 30000 to 30006: for accessing gopaddle endpoints .

  • Port 32000: Service node port for Grafana dashboard on Kubernetes

  • Any node port assigned for an application deployed on microk8s

Steps to disable gopaddle addon for microk8s

Issue the below command to disable gopaddle addon for microk8s:

sudo microk8s disable gopaddle-lite

Steps to update gopaddle addon for microk8s

At a later time, if you want to update gopaddle addon repo (that you previously added at the time of installation of gopaddle addon for microk8s), use the below command:

  1. Update the repository

    sudo microk8s addons repo update gp-lite
  2. If any new updates are pulled above, in order for this to take effect, you need to execute the following steps: Disable gopaddle add-on

    Enable gopaddle add-on

Steps to uninstall gopaddle addon for microk8s

Follow the below steps to uninstall gopaddle addon for microk8s:

  1. Disable gopaddle addon for microk8s - see the section above

  2. Delete all PVs created by gopaddle

    After disabling gopaddle addon for microk8s, the persistent volumes used by gopaddle are still around. Use the below command to delete the persistent volumes created by gopaddle:

    sudo microk8s kubectl delete pv -l gp-install-pv=microk8s-hostpath-gp-retain
  3. Delete the storage class

    sudo microk8s kubectl delete sc microk8s-hostpath-gp-retain
  4. Remove the node label added by gopaddle

    sudo microk8s kubectl label nodes <nodename> gp-install-node-
  5. Remove the gopaddle addon repo in microk8s

    sudo microk8s addons repo remove gp-lite

Last updated