System requirements¶

Make sure you review the resource allocation detail for MSR prior to installation. Below, we offer detail for both a minimum resource allotment as well as guidelines for an optimum resource allotment.

Minimum resource allotment¶

Verify that at a minimum your system can allocate the following resources solely to the running of MSR:

Component	Requirement
Nodes	One Linux/AMD64 worker node, running Kubernetes 1.21 - 1.27 1: 16 GB RAM 4 vCPUs
Kubernetes command line tool	kubectl
Kubernetes configuration files	kubeconfig Component necessary for accessing the Kubernetes cluster. Note If you are installing MSR 3.0.x on an MKE Kubernetes cluster, you must download the MKE client bundle to obtain the `kubeconfig` file.
Certificate management	cert-manager installed on the cluster Minimum required version: `1.7.2`
Kubernetes package management	Helm Minimum required version: `3.7.0`
Metadata storage	One 64 GB Kubernetes persistent volume 2 that supports the `ReadWriteOnce` volume access mode, or a `StorageClass` that can provision such a volume
Image data storage	Use any of the following: One Kubernetes persistent volume 2 that supports the `ReadWriteMany` volume access mode, or a `StorageClass` that can provision such a volume One cloud object storage bucket, such as Amazon S3 For more information, refer to Storage.
Image-scanning CVE database	A PostgreSQL server with sufficient storage for a 24 GB database. This can be either: An MSR-deployed dedicated PostgreSQL server, an option that requires: Postgres Operator installed on the cluster Minimum required version: `1.9.0` 1 4 GB of RAM and 1 vCPU available, for reservation on a Kubernetes worker node One Kubernetes persistent volume 2 with 24 GB of available storage that supports the `ReadWriteOnce` volume access mode, or a `StorageClass` that can provision such a volume An existing PostgreSQL server with sufficient storage for a 24 GB database

Recommended resource allotment¶

For optimal performance, Mirantis recommends that you allocate the following resources solely to MSR:

Component	Requirement
Nodes	Three Linux/AMD64 worker nodes, running Kubernetes 1.21 - 1.27 1, each with: 16 GB RAM 4 vCPUs
Kubernetes command line tool	kubectl
Kubernetes configuration files	kubeconfig Component necessary for accessing the Kubernetes cluster. Note If you are installing MSR 3.0.x on an MKE Kubernetes cluster, you must download the MKE client bundle to obtain the `kubeconfig` file.
Certificate management	cert-manager installed on the cluster Minimum required version: `1.7.2`
Kubernetes package management	Helm Minimum required version: `3.7.0`
Metadata storage	Three 64 GB Kubernetes persistent volumes 2 that support the `ReadWriteOnce` volume access mode, or a `StorageClass` that can provision such volumes
Image data storage	Use any of the following: One Kubernetes persistent volume 2 with 25 - 100 GB of available storage that supports the `ReadWriteMany` volume access mode, or a `StorageClass` that can provision such a volume One cloud object storage bucket, such as Amazon S3, with 25 - 100 GB of available storage For more information, refer to Storage.
Image-scanning CVE database	A high availability PostgreSQL server with sufficient storage for a 24 GB database. This can be either: An MSR-deployed dedicated PostgreSQL server, an option that requires: Postgres Operator installed on the cluster Minimum required version: `1.9.0` 1 Two Kubernetes nodes, each with 4 GB of RAM and 1 vCPU available for reservation Two persistent volumes 2, each with 24 GB of available storage, that support the `ReadWriteOnce` volume access mode, or a `StorageClass` that can provision such volumes An existing high availability PostgreSQL server with sufficient storage for a 24 GB database, which supports synchronous replication

1(1,2,3,4): Postgres Operator up through 1.8.2 uses the PodDisruptionBudget policy/v1beta1 Kubernetes API, which is no longer served as of Kubernetes 1.25. As such, various features of MSR may not function properly if Postgres Operator 1.8.2 or earlier is installed alongside MSR on Kube v1.25 or later.
2(1,2,3,4,5,6): For persistent volume configuration information, refer to the Kubernetes documentation, Configure a Pod to Use a PersistentVolume for Storage.