Installation
Palette VerteX is available as a self-hosted application that you install in your environment. The self-hosted version is a dedicated Palette VerteX environment hosted on VMware instances or in an existing Kubernetes cluster. Palette VerteX is available in the following modes:
| Supported Platform | Description | Install Guide |
|---|---|---|
| VMware | Install Palette VerteX in VMware environment. | Install on VMware |
| Kubernetes | Install Palette VerteX using a Helm Chart in an existing Kubernetes cluster. | Install on Kubernetes |
Airgap Installation
You can also install Palette VerteX in an airgap environment. For more information, refer to the Airgap Installation section.
| Supported Airgap Platform | Description | Install Guide |
|---|---|---|
| VMware | Install Palette VerteX in VMware environment using your own OCI registry server. | |
| Kubernetes | Install Palette VerteX using a Helm Chart in an existing Kubernetes cluster with your own OCI registry server OR use AWS ECR. | Airgap Install |
The next sections describe specific requirements for installing Palette VerteX.
Size Guidelines
This section lists resource requirements for VerteX for various capacity levels. In VerteX, the terms small, medium, and large are used to describe the instance size of worker pools that Palette is installed on. The following table lists the resource requirements for each size.
The recommended maximum number of deployed nodes and clusters in the environment should not be exceeded. We have tested the performance of VerteX with the recommended maximum number of deployed nodes and clusters. Exceeding these limits can negatively impact performance and result in instability. The active workload limit refers to the maximum number of active nodes and pods at any given time.
| Size | Total Nodes | Node CPU | Node Memory | Node Storage | MongoDB Node Storage Limit | MongoDB Node Memory Limit | MongoDB Node CPU Limit | Total Deployed Workload Cluster Nodes | Deployed Clusters with 10 Nodes |
|---|---|---|---|---|---|---|---|---|---|
| Small | 3 | 8 | 16 GB | 60 GB | 20 GB | 4 GB | 2 | 1000 | 100 |
| Medium (Recommended) | 3 | 16 | 32 GB | 100 GB | 60 GB | 8 GB | 4 | 3000 | 300 |
| Large | 3 | 32 | 64 GB | 120 GB | 80 GB | 12 GB | 6 | 5000 | 500 |
The Spectro manifest requires approximately 10 GB of storage. VerteX deployed clusters use the manifest to identify what images to pull for each microservice that makes up VerteX.
Instance Sizing
| Configuration | Active Workload Limit |
|---|---|
| Small | Up to 1000 nodes each with 30 pods (30,000 pods) |
| Medium (Recommended) | Up to 3000 nodes each with 30 pods (90,000 pods) |
| Large | Up to 5000 nodes each with 30 pods (150,000 pods) |
Kubernetes Requirements
The following table presents the Kubernetes version corresponding to each Palette version. It provides the download URLs for the Operating System and Kubernetes distribution OVA required for the install. Ensure that you use FIPS OVA URL if you require a FIPS compliant installation.
| Palette Version | Kubernetes Version | OVA Download URL | FIPS OVA Download URL |
|---|---|---|---|
| 4.5.15 | 1.29.9 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.11 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.10 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.8 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.5 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.4 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.5.3 | 1.29.9 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova |
| 4.4.20 | 1.28.13 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12813-fips.ova |
| 4.4.18 | 1.28.13 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12813-fips.ova |
| 4.4.14 | 1.28.12 | https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12812-0.ova | https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12812-fips.ova |
| 4.4.11 | 1.28.11 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1289-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1289-fips.ova |
| 4.4.6 | 1.28.9 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1289-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1289-fips.ova |
| 4.3.6 | 1.27.11 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12711-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12711-fips.ova |
| 4.2.13 | 1.26.10 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12610-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12610-fips.ova |
| 4.2.7 | 1.26.10 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12610-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12610-fips.ova |
| 4.1.12 | 1.26.8 | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1268-0.ova | https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1268-fips.ova |
Proxy Requirements
By default, VerteX connects to the internet to download images and packages. If your environment uses a proxy server, ensure the following domains and ports are accessible. The proxy server should meet the following requirements:
-
A proxy used for outgoing connections should support both HTTP and HTTPS traffic.
-
If you are deploying VerteX to a vSphere environment. Ensure the instance Palette is installed through network has access to vCenter.
-
Allow connectivity to domains and ports in the table.
- Review the gRPC and Proxies page to learn more about VerteX's support for gRPC in a proxy environment.
The statements above are not applicable to air-gapped installations. For air-gapped installations, you must download the required images and packages and make them available to the system.
| Top-Level Domain | Port | Description |
|---|---|---|
| ecr.*.amazonaws.com | 443 | AWS ECR Registry |
| spectrocloud.com | 443 | Required content repository and pack registry |
| *.amazonaws.com | 443 | OVA files and other assets generated by us |
| gcr.io | 443 | Assets maintained by us and common third party container images |
| ghcr.io | 443 | Kubernetes VIP images |
| docker.io | 443 | Common third party content |
| googleapis.com | 443 | For pulling images required by our services |
| docker.com | 443 | Common third party container images |
| raw.githubusercontent.com | 443 | Common third party content |
| projectcalico.org | 443 | Calico container images |
| quay.io | 443 | Common third party container images |
| grafana.com | 443 | Grafana container images and manifests |
| github.com | 443 | Common third party content |
| k8s.gcr.io | 443 | Kubernetes images [deprecated] |
| registry.k8s.io | 443 | Kubernetes images |
| docker.pkg.dev | 443 | Common third party content |
| us-docker.pkg.dev | 443 | Required content repository and common third party content |