Version: Next

MicroK8s on remote machines

important

We are only providing this guide as a reference. Due to the complexity of different installations, we can only provide open source support for clusters running Ubuntu 20.04 or higher as host OS on a local cluster.

Please visit our Website and contact us for other bare metal installation options.

You can set up and access Onepanel on a remote computer that you can access via SSH.

This can be a VM in the cloud, or Multipass running locally. In either case, it has to be running Ubuntu 20.04 or higher.

Set up your VM
- Cloud VM
- Multipass
Set up your VM according to your cloud provider instructions.
important
Onepanel requires at least 40GB of hard disk space, so if your VM doesn't have that much you'll have to mount an external disk. In that case, make sure to do step 5.
note
All further instructions are in your remote computer/vm unless otherwise indicated.
Install MicroK8s
sudo snap install microk8s --channel=1.19/stable --classic
Update your permissions
sudo usermod -a -G microk8s $USER
sudo chown -f -R $USER ~./kube
Log out and in for changes to take effect
Wait for microk8s to be ready
microk8s status --wait-ready
Update API server config
sudo nano /var/snap/microk8s/current/args/kube-apiserver
Add to the top
--service-account-signing-key-file=${SNAP_DATA}/certs/serviceaccount.key
--service-account-key-file=${SNAP_DATA}/certs/serviceaccount.key
--service-account-issuer=api
--service-account-api-audiences=api,nats
Restart microk8s for the changes to take effect
microk8s stop && microk8s start && microk8s status --wait-ready
(Optional) Mount external disks
If you are using a VM in the cloud, you need at least 40GB of hard disk space. Mount your disk if you haven't already. We'll assume your disk is mounted at /data
We need to tell microk8s to use the mounted disk so we have more storage space.
Create the following directories
sudo mkdir -p /data/var/lib/containerd
sudo mkdir -p /data/run/containerd
Edit the containerd arguments
sudo nano /var/snap/microk8s/current/args/containerd
Change the contents to
--config ${SNAP_DATA}/args/containerd.toml
--root /data/var/lib/containerd
--state /data/run/containerd
--address ${SNAP_COMMON}/run/containerd.sock
Then, restart microk8s
microk8s stop && microk8s start && microk8s status --wait-ready
Enable microk8s addons
sudo microk8s enable storage dns rbac
microk8s status --wait-ready
Configure DNS
- Cloud VM
- Multipass
i. Edit the resolvconf
sudo nano /var/snap/microk8s/current/args/kubelet
Add to the top
--resolv-conf=/run/systemd/resolve/resolv.conf
ii. Edit coredns configmap so we point to the resolv.conf file
microk8s kubectl edit cm coredns -n kube-system
Set the forward section to:
forward . /etc/resolv.conf 8.8.8.8 8.8.4.4
iii. Restart microk8s
microk8s stop && microk8s start && microk8s status --wait-ready
Install Onepanel
curl -sLO https://github.com/onepanelio/onepanel/releases/download/v0.21.0/opctl-linux-amd64
chmod +x opctl-linux-amd64
sudo mv ./opctl-linux-amd64 /usr/local/bin/opctl
Initialize Onepanel
opctl init --provider microk8s \
--enable-metallb \
--artifact-repository-provider abs
note
I used Azure Block Storage (abs) as the artifact-repository-provider above, but you can use s3, abs, or gcs
Populate params.yaml by following the instructions in the template, and referring to configuration file sections for more detailed information.
Here's a mostly filled out params.yaml for a quickstart. You'll need to fill out artifactRepository
application:
defaultNamespace: example
domain: onepanel.test
fqdn: app.onepanel.test
insecure: true
nodePool:
label: node.kubernetes.io/instance-type
options:
- name: 'Local machine'
value: 'local'
provider: microk8s
# You need to fill this part out according to your artifact repository provider
artifactRepository:
# FILL ME OUT
database:
databaseName: onepanel
driverName: postgres
host: postgres
password: sample12!
port: 5432
username: admin
metalLb:
addresses:
- 192.168.99.0/32
Deploy onepanel
microk8s config > kubeconfig
KUBECONFIG=./kubeconfig opctl apply
Label your nodes
To allow Workspaces to run on your machine(s) you need to label them.
First, get the names of your nodes by running:
microk8s kubectl get nodes
You will get results similar to below:
NAME STATUS ROLES AGE VERSION
sample Ready <none> 11m v1.19.8-34+811e9feeade1d3
Then, for each node name, add the label from your application.nodePool.label from your params.yaml, above we used,
nodePool:
label: node.kubernetes.io/instance-type
options:
- name: 'Local machine'
value: local
and the node above is called sample, you can label the node as follows:
microk8s kubectl label node sample node.kubernetes.io/instance-type=local
Expose onepanel using Nginx
Since Onepanel is running inside a VM, we need to expose it so we can access it on our local computers. To do so, we use nginx.
First, install nginx.
sudo apt-get install nginx
Then, configure nginx to expose Onepanel
sudo nano /etc/nginx/sites-available/default
Change this
location / {
# First attempt to serve request as file, then
# as directory, then fall back to displaying a 404.
try_files $uri $uri/ =404;
}
to
location / {
proxy_pass http://192.168.99.0; # the ip address you gave metallb
proxy_set_header Host $host;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
Then, stop editing and run
sudo nginx -s reload
Configure DNS
On your local machine, we need to point DNS so it knows about Onepanel.
Get the IP address of your VM. For VMs in the cloud, this is given to you. In multipass you can see it with multipass list
For this example, we'll assume the IP is: 15.92.2.237
Then, edit your hosts file using a text editor. The location depends on your operation system.
- Linux
- Mac
- Windows
/etc/hosts
and add to the top
# <ip> <fqdn>
15.92.2.237 app.onepanel.test
Use Onepanel
In your VM, Get your authentication login with
microk8s config > kubeconfig
KUBECONFIG=./kubeconfig opctl auth token
Open up app.onepanel.test in your browser, paste in the credentials, and you are good to go!

important

important

note

note