Comment on page
Portainer consists of two elements, the Portainer Server and the Portainer Agent. Both elements run as lightweight containers on Kubernetes. This document will outline how to connect Portainer to your existing infrastructure to deploy MicroK8s and install the Portainer Agent. If you do not have a working Portainer Server instance yet, please refer to the Portainer Server installation guide first.
In order to connect to and deploy MicroK8s and the Portainer Agent on your existing infrastructure, you will need:
- One or more Linux-based machines on which MicroK8s will be deployed. We have primarily tested on Ubuntu 20.04 LTS but most comparable Linux distributions should work. These machines can be bare metal servers or virtual machines.
- Root or sudo SSH access to the above machines on port
22. This is needed in order to install MicroK8s. Portainer supports both password-based and key-based authentication.
snaptool installed on the above machines. You can find installation instructions for most Linux distributions at the Snapcraft website. The
snaptool is used to install MicroK8s and any selected addons.
- Communication between the Portainer Server and the above machines, as well as communication between the individual machines in the cluster. This is to ensure the Portainer Server can reach the machines both for the initial installation and for communication with the Portainer Agent once the cluster is up and running, and so that the cluster nodes can communicate with each other.
- For the installation, internet access (specifically to Docker Hub and registry.k8s.io) from the machines where MicroK8s will be deployed. This is a requirement at present in order for the setup to complete successfully. Once setup is complete, internet access can be disabled. However, this may affect enabling of some addons.
By necessity, our MicroK8s deployment makes some configuration decisions for you.
- The Portainer Agent is deployed using NodePort, on port
- There may be some configuration differences between versions of MicroK8s deployed. One notable difference is from version 1.25, if the
ingressaddon is installed an additional ingress named
nginxis configured. This does not occur on version 1.24. We recommend referring to the MicroK8s release notes for further detail.
- The deployment does not configure any storage classes on your cluster (unless the
hostpath-storageaddon is installed, though this is not recommended for multiple node clusters). Due to the vast amount of potential storage class configurations, this is not something we currently provide automatically. We recommend configuring a storage class once provision completes.
To create and deploy MicroK8s and the Portainer Agent to your machines, from the menu select Environments then click Add Environment.
Select Create a Kubernetes cluster and click Start wizard.
Fill in the fields based on the table below:
You can also choose to generate a new SSH key pair by clicking the Generate new RSA SSH key pair button, or upload an existing private key by clicking the Upload SSH private key button. You can find more detailed instructions for generating a new SSH key in our SSH credentials documentation.
Once you have a set of credentials configured, you can proceed to configuring your cluster. Fill out the fields based on the table below:
Once you have selected a credential set and entered the node IPs, you can click Test connections to ensure the credentials work for all the IP addresses and that they are reachable from the Portainer Server instance. If there are any issues connecting to the nodes they will be displayed.
You can now proceed to configuring MicroK8s itself. Fill out the fields based on the table below:
As an optional step you can expand the More settings section to customize the deployment further.
Once you have entered your cluster configuration details, click Provision environment to begin the provision. Portainer will start provisioning your cluster with the options you selected. If you have other environments to configure click Next to proceed, otherwise click Close to return to the list of environments.
From the Environments page you will be able to see the progress of any running Kubernetes environment provisions. The status will be updated as the provision completes, and if the provision runs into problems an error will be displayed here. You can hover over the status or error for additional detail.
Once the provision completes, you will be able to access the environment as you would any other Portainer-configured environment.