CHECK YOU HAVE EVERYTHING YOU NEED
Check the boxes to proceed
We want to make sure that you have everything that you need to install Portainer on your environment. Please complete the checklist below to make sure you're good to go.
Validated Configurations
Every Portainer release goes through functional, release and post-release testing to ensure it works as expected. Because we cannot test against every configuration variant out there, we test against a subset.
The following tables list all of the configurations that we have tested, validated and consider to be functional. If a variant is not listed, it doesn't mean it won't work, it just means it hasn't been tested.
|
Portainer Version
|
Release Date
|
Docker Version
|
Kubernetes Version
|
Architectures
|
|
Business 2.12 (latest)
|
Mar 8, 2022
|
20.10.7 20.10.11 20.10.12
|
1.21.7 1.22 1.23
|
ARM64, x86_64
|
|
Business 2.10
|
Nov 15, 2021
|
20.10.6 20.10.7
|
1.19 1.20.2 1.21 1.22
|
ARM64, x86_64
|
|
Business 2.7
|
Jul 29, 2021
|
20.10.6 20.10.7
|
1.19 1.20.2 1.21
|
ARM64, x86_64
|
|
Business 2.4
|
May 4, 2021
|
20.10.5
|
1.19 1.20.2 1.21
|
ARM64, x86_64
|
|
Business 2.0
|
Dec 3, 2020
|
19.03.13
|
1.17.3 1.18.6 1.19.3
|
ARM64, x86_64
|
Docker installed
To deploy Portainer, Docker must be installed and working.
Docker Desktop installed
Portainer runs as a container and requires that Docker Desktop be installed and working.
Kubernetes installed
To manage a Kubernetes cluster, Kubernetes must be installed and working.
Access to helm / kubectl
The Portainer installation process involves running helm or kubectl commands. You must have access to run one of these on your cluster.
Swarm Mode enabled
To deploy Portainer across your swarm, Swarm Mode must be enabled in your Docker installation and the required swarm nodes added to the cluster. The overlay network for the swam service communication must also be configured and working.
sudo access
To install Portainer Server you will require root or sudo access to the server running Docker.
sudo access to the manager node
To install Portainer Server you will require root or sudo access to the manager node of your Docker Swarm.
Administrator access
To install Portainer Server you will require Administrator access to the server running your container environment.
Administrator access to the manager node
To install Portainer Server you will require Administrator access to the manager node of your Docker Swarm.
Cluster admin rights
The Portainer installation requires Cluster Admin rights on your Kubernetes cluster. This is so Portainer can create the necessary ServiceAccount and ClusterRoleBinding for it to access the Kubernetes cluster.
WSL installed
For Docker Desktop to function fully you will need the Windows Subsystem for Linux (WSL) installed and a Linux distribution selected. For a new installation we recommend WSL2.
Ports
By default, Portainer Server will expose the UI over port 9443 and expose a TCP tunnel server over port 8000. The latter is optional and is only required if you plan to use the Edge compute features with Edge agents.
Ports
Depending on how you choose to expose Portainer, the UI will be exposed on ports 30779 (HTTPS) and 30777 (HTTP) when using NodePort, or ports 9443 (HTTPS) and 9000 (HTTP) when using a Load Balancer.
Swarm node comms
As we use the Portainer Agent to communicate with the nodes in the Docker Swarm, your manager and worker nodes need to be able to communicate with each other on port 9001.
Default StorageClass
Portainer requires data persistence, and as a result needs at least one StorageClass available to use. Portainer will attempt to use the default StorageClass during deployment. If you do not have a StorageClass tagged as default the deployment will likely fail.
