Back to Portainer

Requirements and prerequisites

start/requirements-and-prerequisites.md

1.23.238.5 KB
Original Source

Requirements and prerequisites

Requirements specific to your environment will be covered in the installation process.

Valid 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 Business Edition (BE)

Portainer VersionRelease DateDocker VersionKubernetes VersionPodman VersionArchitectures
Business 2.39.0 LTSFebruary 26, 202628.5.1 29.2.11.32 1.33 1.345.6.0ARM64, x86_64
Business 2.38.1 STSFebruary 13, 202628.5.1 29.2.11.32 1.33 1.345.6.0ARM64, x86_64
Business 2.38.0 STSJanuary 29, 202628.5.1 29.1.21.32 1.33 1.345.6.0ARM64, x86_64
Business 2.37.0 STSDecember 11, 202528.5.1 29.1.11.32 1.33 1.345.6.0ARM64, x86_64
Business 2.33.5 LTSNovember 27, 202528.5.1 29.0.01.32 1.33 1.345.6.0ARM64, x86_64
Business 2.36.0 STSNovember 27, 202528.5.1 29.0.01.32 1.33 1.345.6.0ARM64, x86_64
Business 2.33.4 LTSNovember 20, 202527.5.1 28.5.11.32 1.33 1.345.6.0ARM64, x86_64
Business 2.33.3 LTSOctober 30, 202527.5.1 28.5.11.32 1.33 1.345.6.0ARM64, x86_64
Business 2.35.0 STSOctober 16, 202527.5.1 28.4.01.31 1.32 1.335.6.0ARM64, x86_64
Business 2.33.2 LTSSeptember 25, 202527.5.1 28.4.01.31 1.32 1.335.6.0ARM64, x86_64
Business 2.34.0 STSSeptember 18, 202527.5.1 28.3.31.31 1.32 1.335.5.1ARM64, x86_64
Business 2.33.1 LTSAugust 27, 202527.5.1 28.3.21.31 1.32 1.335.5.1ARM64, x86_64
Business 2.33.0 LTSAugust 20, 202527.5.1 28.3.21.31 1.32 1.335.5.1ARM64, x86_64
Business 2.32.0July 24, 202527.5.1 28.2.21.31 1.32 1.335.4.0ARM64, x86_64
Business 2.31.3July 3, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Business 2.27.9 LTSJuly 2, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.31.2June 26, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Business 2.27.8 LTSJune 25, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.31.1June 19, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Business 2.27.7 LTSJune 17, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.31.0June 12, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Business 2.30.1May 20, 202527.5.1 28.1.11.30 1.31 1.325.4.0ARM64, x86_64
Business 2.30.0May 15, 202527.5.1 28.1.11.30 1.31 1.325.4.0ARM64, x86_64
Business 2.27.6 LTSMay 9, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.27.5. LTSMay 2, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.29.2April 24, 202527.0.3 28.0.01.30 1.31 1.325.2.3ARM64, x86_64
Business 2.29.1April 23, 202527.0.3 28.0.01.30 1.31 1.325.23ARM64, x86_64
Business 2.29.0April 16, 202527.0.3 28.0.01.30 1.31 1.325.2.3ARM64, x86_64
Business 2.27.4 LTSApril 15, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.28.1March 20, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.28.0March 19. 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.27.2 LTSMarch 19, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.27.1 LTSFebruary 27, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.27.0 LTSFebruary 20, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Business 2.26.1January 21, 202526.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.26.0January 15, 202526.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.25.1December 20, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.21.5December 20, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.25.0December 16, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.24.1December 3, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.24.0November 20, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.21.4 LTSOctober 25, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.23.0October 16, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.21.3 LTSOctober 8, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.22.0October 3, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Business 2.21.2 LTSSeptember 24, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.21.1 LTSSeptember 10, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.21.0 LTSAugust 27, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Business 2.20.3May 21, 202425.0.51.24 1.26 1.27N/AARM64, x86_64
Business 2.20.2May 1, 202425.0.51.24 1.26 1.27N/AARM64, x86_64
Business 2.19.5April 22, 202423.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.20.1April 5, 202423.0.6 24.0.61.24 1.26 1.27N/AARM64, x86_64
Business 2.20.0March 19, 202423.0.6 24.0.61.24 1.26 1.27N/AARM64, x86_64
Business 2.19.4December 6, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.19.3November 22, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.19.2November 13, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.19.1September 20, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.19.0August 31, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Business 2.18.4July 7, 202323.0.6 24.0.41.22 1.23 1.24N/AARM64, x86_64
Business 2.18.3May 22, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Business 2.18.2May 1, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64

Portainer Community Edition (CE)

Portainer VersionRelease DateDocker VersionKubernetes VersionPodman VersionArchitectures
Community 2.39.0 LTSFebruary 26, 202628.5.1 29.2.11.32 1.33 1.345.6.0ARM64, x86_64
Community 2.38.1 STSFebruary 13, 202628.5.1 29.2.11.32 1.33 1.345.6.0ARM64, x86_64
Community 2.38.0 STSJanuary 29, 202628.5.1 29.1.21.32 1.33 1.345.6.0ARM64, x86_64
Community 2.37.0 STSDecember 11, 202528.5.1 29.1.11.32 1.33 1.345.6.0ARM64, x86_64
Community 2.33.5 LTSNovember 27, 202528.5.1 29.0.01.32 1.33 1.345.6.0ARM64, x86_64
Community 2.36.0 STSNovember 27, 202528.5.1 29.0.01.32 1.33 1.345.6.0ARM64, x86_64
Community 2.33.4 LTSNovember 20, 202528.5.1 29.0.01.32 1.33 1.345.6.0ARM64, x86_64
Community 2.33.3 LTSOctober 30, 202527.5.1 28.5.11.32 1.33 1.345.6.0ARM64, x86_64
Community 2.35.0 STSOctober 16, 202527.5.1 28.4.01.31 1.32 1.335.6.0ARM64, x86_64
Community 2.33.2 LTSSeptember 25, 202527.5.1 28.4.01.31 1.32 1.335.6.0ARM64, x86_64
Community 2.34.0 STSSeptember 18, 202527.5.1 28.3.31.31 1.32 1.335.5.1ARM64, x86_64
Community 2.33.1 LTSAugust 27, 202527.5.1 28.3.21.31 1.32 1.335.5.1ARM64, x86_64
Community 2.33.0 LTSAugust 20, 202527.5.1 28.3.21.31 1.32 .1335.5.1ARM64, x86_64
Community 2.32.0July 24, 202527.5.1 28.2.21.31 1.32 1.335.4.0ARM64, x86_64
Community 2.31.3July 3, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Community 2.27.9 LTSJuly 2, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.31.2June 26, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Community 2.27.8 LTSJune 25, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.31.1June 19, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Community 2.27.7 LTSJune 17. 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.31.0June 12, 202527.5.1 28.1.11.31 1.32 1.335.4.0ARM64, x86_64
Community 2.30.1May 20, 202527.5.1 28.1.11.30 1.31 1.325.4.0ARM64, x86_64
Community 2.30.0May 15, 202527.5.1 28.1.11.30 1.31 1.325.4.0ARM64, x86_64
Community 2.27.6 LTSMay 9, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.27.5 LTSMay 2, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.29.2April 24, 202527.0.3 28.0.01.30 1.31 1.325.2.3ARM64, x86_64
Community 2.29.1April 23, 202527.0.3 28.0.01.30 1.31 1.325.2.3ARM64, x86_64
Community 2.29.0April 16, 202527.0.3 28.0.01.30 1.31 1.325.2.3ARM64, x86_64
Community 2.27.4 LTSApril 15, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.28.1March 20, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.28.0March 19, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.27.2 LTSMarch 19, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.27.1 LTSFebruary 27, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.27.0 LTSFebruary 20, 202526.0.2 27.0.31.29 1.30 1.315.2.3ARM64, x86_64
Community 2.26.1January 21, 202526.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.26.0January 15, 202526.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.25.1December 20, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.21.5December 20, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.25.0December 16, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.24.1December 3, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.24.0November 15, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.21.4October 25, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.23.0October 16, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.21.3October 8, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.22.0October 3, 202426.0.2 27.0.11.28 1.29 1.305.2.2ARM64, x86_64
Community 2.21.2September 24, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.21.1September 10, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.21.0August 27, 202426.0.2 27.0.11.28 1.29 1.30N/AARM64, x86_64
Community 2.20.3May 21, 202425.0.51.24 1.26 1.27N/AARM64, x86_64
Community 2.20.2May 1, 202425.0.51.24 1.26 1.27N/AARM64, x86_64
Community 2.19.5April 22, 202423.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.20.1April 5, 202423.0.6 24.0.61.24 1.26 1.27N/AARM64, x86_64
Community 2.20.0March 19, 202423.0.6 24.0.61.24 1.26 1.27N/AARM64, x86_64
Community 2.19.4December 6, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.19.3November 22, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.19.2November 13, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.19.1September 20, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.19.0August 31, 202323.0.6 24.0.41.23 1.24 1.26N/AARM64, x86_64
Community 2.18.4July 7, 202323.0.6 24.0.41.22 1.23 1.24N/AARM64, x86_64
Community 2.18.3May 22, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Community 2.18.2May 1, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Community 2.18.1April 18, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Community 2.17.1February 22, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Community 2.17.0February 7, 202320.10.9 20.10.13 20.10.171.22 1.23 1.24N/AARM64, x86_64
Community 2.16.2November 21, 202220.10.9 20.10.13 20.10.171.21.7 1.22 1.23N/AARM64, x86_64
Community 2.16.1November 9, 202220.10.9 20.10.13 20.10.171.21.7 1.22 1.23N/AARM64, x86_64
Community 2.16.0October 31, 202220.10.9 20.10.13 20.10.171.21.7 1.22 1.23N/AARM64, x86_64
Community 2.15.1September 16, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.15.0September 6, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.14.2July 26, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.14.1July 12, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.14.0June 28, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.13.1May 12, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.13.0May 9, 202220.10.9 20.10.12 20.10.131.21.7 1.22 1.23N/AARM64, x86_64
Community 2.11.1February 8, 202220.10.8 20.10.11 20.10.121.20.13 1.21.7 1.22.4N/AARM64, x86_64
Community 2.11.0December 9, 202120.10.6 20.10.8 20.10.111.19.11 1.20.7 1.21 1.22N/AARM64, x86_64
Community 2.9.3November 22, 202120.10.5 20.10.61.19.11 1.20.7 1.21 1.22N/AARM64, x86_64
Community 2.9.2October 26, 202120.10.5 20.10.61.19 1.20 1.21 1.22N/AARM64, x86_64
Community 2.9.1October 11, 202120.10.5 20.10.61.19 1.20 1.21 1.22N/AARM64, x86_64
Community 2.9.0September 23, 202120.10.5 20.10.61.19 1.20 1.21 1.22N/AARM64, x86_64
Community 2.6.3August 27, 202120.10.5 20.10.61.19 1.20 1.21 1.22N/AARM64, x86_64
Community 2.6.2August 2, 202120.10.5 20.10.61.19 1.20.2 1.21N/AARM64, x86_64
Community 2.6.1July 12, 202120.10.5 20.10.61.19 1.20.2 1.21N/AARM64, x86_64
Community 2.6.0June 25, 202120.10.5 20.10.61.19 1.20.2 1.21N/AARM64, x86_64
Community 2.5.1May 18, 202120.10.5 20.10.61.19 1.20.2 1.21N/AARM64, x86_64
Community 2.5.0May 18, 202120.10.51.19 1.20.2 1.21N/AARM64, x86_64
Community 2.1.xFebruary 2, 202120.10.21.20.0N/AARM64, x86_64

{% hint style="info" %} If you find an issue with an unlisted configuration, before reporting a bug, update your environment to a valid configuration and try to replicate the issue. {% endhint %}

Persistent storage

The Portainer Server requires persistent storage in order to maintain the database and configuration information it needs to function. The installation process provides a basic storage configuration for your platform. By default, both Docker and Kubernetes provide local (to the node) storage only, and if cluster-wide persistent storage is desired we recommend implementing it at the infrastructure level.

Additionally, you will want to ensure that your persistent storage for Portainer's data volume is right-sized for your needs. If you intend to use Portainer's Git deployment functionality for example, you will need to be aware that as part of the deployment from Git, Portainer will clone the remote repository locally to the Portainer data volume, which in the case of larger or multiple Git repos may consume significant amounts of disk space.

For larger or performance-critical deployments, we suggest you look to provision persistent storage with the highest possible throughput and lowest available latency. SSD-level performance (~3.5 MB/s, 30,000 IOPS or above, under 10ms write IO latency) is ideal. Be careful when using cloud provider storage both in terms of latency and "burstable" or noisy-neighbor performance characteristics.

If you would like more assistance with verifying your scaled deployment please get in touch with our team.

Ports

In order to access the UI and API, and for the Portainer Server instance and the Portainer Agents to communicate, certain ports need to be accessible.

On the Portainer Server the following ports must be open:

  • TCP port 9443 (or 30779 for Kubernetes with NodePort) for the UI and API
  • TCP port 8000 (or 30776 for Kubernetes with NodePort) for the TCP tunnel server for Edge Agents. This port is optional and only required if using Edge Compute features with Edge Agents.

For the Portainer Agent:

  • TCP port 9001 (or 30778 for Kubernetes with NodePort) must be accessible on the Agent from the Portainer Server instance.

The Portainer Edge Agent does not require any open ports.

{% hint style="info" %} All ports can be changed during installation. {% endhint %}

{% content-ref url="install/" %} install {% endcontent-ref %}

{% content-ref url="install-ce/" %} install-ce {% endcontent-ref %}