---
schema_version: "1"
id: cc7ffc60ae80a618784aa638d6ee20455208ce94586521bc136457c9e3995d1c
title: Anypoint Platform PCE Prerequisites
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/private-cloud/latest/install-checklist.md
canonical_url: https://docs.mulesoft.com/private-cloud/latest/install-checklist
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 3b4e34527702d7b32f5dd2054d439e81b773295f097cfd21fa6bb4856bc6f7b2
description: MuleSoft Documentation Site
release: "4.3"
latest: true
---
---
product: Anypoint Platform Private Cloud Edition
version: 4.3
is-latest-version: true
---

# Anypoint Platform PCE Prerequisites

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can install Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) version 4.x and
later in the Kubernetes (K8s) cluster that you provision and manage.

MuleSoft performed installations on popular K8s providers, which are listed in the following
sections. The hardware and software requirements for installing Anypoint Platform PCE on your chosen
provider are dictated by that provider, unless otherwise specified in this document.

Before you begin, make sure that your organization’s operations, networking, and security teams
review the listed infrastructure prerequisites. These include the K8s cluster, hardware, software,
networking, shared filesystem, container registry, installer node, and storage requirements.

> [!NOTE] Contact MuleSoft Professional Services prior to installing Anypoint Platform PCE, as they
> are involved with your installation.
>
> Installing Anypoint Platform PCE requires specific versions of operating systems, shared
> filesystem components, and other software. Most issues experienced with Anypoint Platform PCE
> occur because the required environment was not set up prior to installing or upgrading.

## Kubernetes Cluster Requirements

- Supported Kubernetes providers:

  - Amazon EKS

  - Rancher Kubernetes Engine (RKE2)

  - Red Hat OpenShift

  - vSphere Kubernetes Service (VKS)

- Cluster configurations:

  - Run Kubernetes control plane components on dedicated nodes. Preferably, allocate three nodes for
    the Kubernetes control plane.

  - Have cluster worker nodes exclusively dedicated to Anypoint Platform PCE workloads. Don’t run
    any Anypoint Platform PCE pods on the K8s control plane nodes. Check the prerequisites to make
    sure that PCE workloads can be scheduled and run on worker nodes.

> [!NOTE] Running Anypoint Platform PCE workloads on K8s control plane nodes can degrade both
> Anypoint Platform PCE and cluster performance.

## Hardware Requirements

Anypoint Platform PCE runs as a Kubernetes application and these are the minimum required hardware
for all services to be scheduled and running:

- 32 vCPUs

- 128 GiB Memory

- x86\_64 Architecture

You can provision and distribute these resources across a minimum of four worker nodes. PCE requires
at least three worker nodes as hosts for data services that are deployed and configured in a cluster
setup with three replicas. Make sure these three replicas run on three separate nodes to honor the
anti-affinity rules.

### Sample Worker Node Configurations

Anypoint Platform PCE offers flexibility in how you configure your Kubernetes worker nodes. You can
use different numbers of worker nodes (for example, 4, 5, 8, or 10 nodes) with varying resource
allocations per node. The key requirement is that your cluster’s total resources meet or exceed the
minimum requirements of 32 vCPUs and 128 GiB memory.

This table shows sample worker node configurations that MuleSoft’s performance teams tested and
validated:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Number of Worker Nodes</th><th>Node Composition</th><th>Total Resources</th></tr></thead><tbody><tr><td><p>4</p></td><td><p>8 vCPU and 32 GiB memory</p></td><td><p>32 vCPU and 128 GiB memory</p></td></tr><tr><td><p>10</p></td><td><p>4 vCPU and 16 GiB memory</p></td><td><p>40 vCPU and 160 GiB memory</p></td></tr></tbody></table>

> [!NOTE] These configurations are reference examples to help you understand how Anypoint Platform
> PCE can work with different worker node configurations. They are not strict requirements. You can
> customize your cluster configuration based on your infrastructure and operational needs, as long
> as the total resource requirements are met.

### Load Balancer Configuration

You can configure your load balancer to use any method for distributing client requests. Use a a
round robin strategy for better results in most contexts. Make sure the load balancer is accessible
through an IP address that is available to all machines on your network.

Make sure your load balancer routes these TCP ports:

<table><caption>Table 1. TCP Port Routing Requirements</caption> <colgroup><col> <col> <col></colgroup><thead><tr><th>Load Balancer Port</th><th>Instance Port</th><th>Internal Usage</th></tr></thead><tbody><tr><td><p><code>80</code></p></td><td><p><code>30080</code></p></td><td><p>HTTP redirects to HTTPs</p></td></tr><tr><td><p><code>443</code></p></td><td><p><code>30443</code></p></td><td><p>HTTPS port</p></td></tr><tr><td><p><code>8083</code></p></td><td><p><code>30883</code></p></td><td><p>HTTPS port for Mule runtimes to authenticate and renew certificates</p></td></tr><tr><td><p><code>8889</code></p></td><td><p><code>30889</code></p></td><td><p>WebSocket port for Mule runtimes to connect</p></td></tr></tbody></table>

In each case, configure your load balancer to listen on the load balancer port and redirect incoming
requests to the instance port. Your Anypoint Platform PCE installation includes an internal NGINX
server that listens on each of the configured instance ports, and then performs the action listed in
the Internal Usage column.

Make sure your load balancer polls the address `HTTP:10256/healthz` to run a health check on your
platform servers and confirm that they are accessible.

> [!NOTE] Don’t configure SSL certificates in your load balancer. The platform handles the TLS
> termination with the certificates configured using Access Management. See
> [Configure Anypoint Platform PCE](https://docs.mulesoft.com/private-cloud/latest/config-workflow).

For more information, see the provider specific requirements:

- [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html)

  AWS EKS is only tested with default networking add-ons.

- [Rancher Kubernetes Engine (RKE2) - Hardware](https://docs.rke2.io/install/requirements#hardware)

- [Red Hat OpenShift](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/installation_overview/ocp-installation-overview)

- [vSphere Kubernetes Service (VKS)](https://techdocs.broadcom.com/us/en/vmware-cis/vcf/vsphere-supervisor-services-and-standalone-components/latest/managing-vsphere-kubernetes-service/running-tkg-service-clusters/tkg-service-components.html)

## Software Requirements

Provider specific node OS requirements:

- [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html)

- [Rancher Kubernetes Engine (RKE2) - Software](https://docs.rke2.io/install/requirements#operating-systems)

  Validated against RHEL 9.6 and Kubernetes 1.34.

- [Red Hat OpenShift](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/installation_overview/ocp-installation-overview)

  Validated against Red Hat Enterprise Linux CoreOS (RHCOS) 9.6 and OpenShift 4.21.

## Networking Requirements

Use these ports to communicate with Anypoint Platform PCE:

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Protocol</th><th>Port / Range</th><th>Purpose</th><th>Source</th><th>Destination</th></tr></thead><tbody><tr><td><p>TCP</p></td><td><p>30080</p></td><td><p>HTTP public access</p></td><td><p>Load balancer</p></td><td><p>Anypoint Platform PCE nodes</p></td></tr><tr><td><p>TCP</p></td><td><p>30443</p></td><td><p>HTTPS public access</p></td><td><p>Load balancer</p></td><td><p>Anypoint Platform PCE nodes</p></td></tr><tr><td><p>TCP</p></td><td><p>30889</p></td><td><p>Mule Runtime Websocket</p></td><td><p>Load balancer</p></td><td><p>Anypoint Platform PCE nodes</p></td></tr><tr><td><p>TCP</p></td><td><p>30883</p></td><td><p>Mule Runtime Authentication Service (for certificate renewals)</p></td><td><p>Load balancer</p></td><td><p>Anypoint Platform PCE nodes</p></td></tr></tbody></table>

Anypoint Platform PCE nodes need to hit the platform API address on the load balancer via HTTPS.

For more information, see the provider specific requirements:

- [Amazon EKS - Networking](https://docs.aws.amazon.com/eks/latest/userguide/eks-networking.html)

- [Rancher Kubernetes Engine (RKE2) - Networking](https://docs.rke2.io/install/requirements#operating-systems)

- [Red Hat OpenShift - Networking](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/networking_overview/understanding-networking)

## Shared Filesystem Requirements

Anypoint Platform PCE requires a `ReadWriteMany` (RWX) shared filesystem. Starting with Anypoint
Platform PCE 4.3.0, you can provide this filesystem using either of the following storage modes:

- **NFS mode** — Bind the platform to an existing NFS server through a pre-installed Container
  Storage Interface (CSI) driver in the Kubernetes cluster. This is the only supported mode in
  versions before 4.3.0.

- **StorageClass mode** — Provide a single RWX-capable Kubernetes `StorageClass` (for example,
  backed by CephFS) and let Anypoint Platform PCE dynamically provision the shared volumes. This
  mode removes the requirement to operate an external NFS server.

In StorageClass mode, Anypoint Platform PCE requests these persistent volumes:

- Design Center: 2 PVCs, 300 GiB each

- Backup and restore: 1 PVC, 1 TiB

The two modes are mutually exclusive. You cannot change the storage mode on an existing cluster. The
installer rejects an in-place upgrade from NFS mode to StorageClass mode so that data on the
previous volumes is not orphaned. Switching the NFS CSI driver during an upgrade does not require
additional storage changes.

For detailed configuration instructions, including CSI driver setup, EFS-specific volume handle
setup, NFS mount option overrides, and `StorageClass` requirements, see
[Shared Filesystem Prerequisites](https://docs.mulesoft.com/private-cloud/latest/verify-nfs).

## Container Registry Requirements

These are the requirements:

- Must be secured over TLS.

- Must be accessible from installer nodes and Kubernetes clusters.

- Must be secured with either a username and password, or Certificate-based authentication. Make
  sure that the new or updated certificates are distributed to all nodes to facilitate uninterrupted
  TLS communication.

## Installer Node Requirements

These are the requirements:

- Operating system: RHEL, Ubuntu, or any Linux-based systems.

- Storage required a minimum 100GB.

- Access to Kubernetes cluster using kubeconfig.yaml

  - The cluster needs `cluster:admin` access, as Anypoint Platform PCE installer needs to create
    resources of different types.

  - The cluster needs `read/write` access in the pce-core namespace to run Anypoint Platform PCE
    installer jobs and other supporting services.

- Access and connectivity to private container registry

- For OpenShift use SecurityContextConstraints for installing Anypoint Platform PCE.

Before executing the `pcectl` binary for Anypoint Platform PCE 4.2, make sure that you follow these
requirements:

- Use a Linux based operating system

- Use glibc (GNU C library) version 2.28 or higher  
  To check the glibc version, run this command:

  ldd --version

- Use Python version 3.12 or newer  
  To check your Python version, run this command:

  python --version

- Use gpg (GnuPG) version 2.1 or higher  
  To check your gpg version, run this command:

  gpg --version

## Storage Requirements

These are the requirements:

In Anypoint Platform PCE version 4.2 and later, all the persistent data is stored in the Persistent
Volume Claims (PVCs). Kubernetes Storage Class commands the PVCs.

These services use PVCs with minimum and default storage size:

- SeaweedFS - S3 Object Store service - Total 120Gi

- Stolon - PostgreSQL HA database - Total 100 Gi

- Prometheus - TSDB for k8s metrics (optional) - Default 50Gi

The storage class for the previous services can be the same. Depending on the type of underlying
infrastructure or storage solution you select, the storage class configuration can vary.

You can update the PVC storage size during the installation by updating the `input.yaml` file. See
these sections to update the storage size:

```json
# Storage class configuration for persistent data services
storageConfiguration:
 pceobjectstore:
   type: "persistentVolumeClaim"
   storageClass: "<storage-class-name>"
   controlPlaneSize: "20Gi" # Optional. Defaults to 10Gi
   volumeSize: "200Gi" # Optional. Defaults to 100Gi
   volumeIndexSize: "20Gi" # Optional. Defaults to 10Gi
 stolon:
   type: "persistentVolumeClaim"
   storageClass: "<storage-class-name>"
   size: "300Gi" # Optional. Defaults to 100Gi
```

In the previous example, you can see the storage for SeaweedFS that is Object Store has increased to
240GiB and stolon has increased to 300 Gi.

Similarly, to set the storage size for monitoring stack, use this configuration:

```json
# Configuration options for monitoring stack
monitoringAppConfiguration:
 monitoringStack:
   enabled:  True # Defaults to True. Must be set to False for Openshift clusters.
   values: | # Optional. If not provided, the default values will be used.
      prometheus:
        prometheusSpec:
          storageSpec:
            volumeClaimTemplate:
              spec:
                storageClassName: 'local-path',
                accessModes: ["ReadWriteOnce"]
                resources:
                  requests:
                    storage: 50Gi
```

## Platform Configuration

To make Anypoint Platform PCE accessible, configure these specifications in the input configuration
file before installing Anypoint Platform PCE:

- Platform DNS

- File System DNS

- First User Account details

  - Org Name

  - Username

  - Email

  - Password

- Platform certificate and certificate key with the Subject Alternative Name (SAN) of the platform
  DNS.

## See Also

- [Installing or Upgrading Anypoint Platform Private Cloud Edition (Anypoint Platform PCE)](https://docs.mulesoft.com/private-cloud/latest/install-workflow)