GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

Installation Requirements

View the prerequisites and minimum infrastructure required to install Modzy

Installation Prerequisites

Before provisioning the infrastructure required to install and run the Modzy platform, the below prerequisites are also required.

Domain, DNS, and SSL Certificate

  • To install Modzy, you will need control of an internet domain. A fully qualified domain name (FQDN) for the planned Modzy instance is required for provisioning.
  • Modzy requires two DNS entries to function: the domain you'd like to use for Modzy itself, and a wildcard entry underneath that. For example, if you're primary domain is example.com, then you might create the following two entries: modzy.example.com and *.modzy.example.com
  • You must obtain a valid TLS certificate from your organization or use a service (such as Let’s Encrypt) to request a certificate for the FQDN that includes the two DNS entries mentioned in the previous bullet. The certificate and key files are required for platform configuration after installation. This certificate will be used by the API and the image registry.

SAML Identity Provider Client Configuration

The following items are needed to configure the Modzy client in the SAML Identity Provider:

  • SSL URL: https://FQDN/saml/SSO

  • Audience URI (SP Entity ID): com.modzy.saml.sp

    Where FQDN is the fully qualified domain name for the Modzy instance (Ex.: mymodzy.mydomain.com) and must match the FQDN input parameter the Modzy instance is to be provisioned with.

Minimum Infrastructure Requirements

In order to deploy Modzy, the infrastructure below is required which is not provided by Modzy. The requirements do not include specifications for the inference nodes that would be used run to your AI/ML jobs. The type, size, and quantity of inference nodes vary by workload.

ResourceQtySpecificationAWS EquivalentAzure EquivalentNotes
Kubernetes Control Plane1version 1.21EKS Control PlaneAKS Kubernetes Service
Worker Nodes38 vCPU, 32GB RAM
100G SSD
m5.2xlarge.
EBS storage
D4ds v4These nodes are used exclusively to run the Modzy application.
Object Storage11TB recommendedS3Blob storageObject Storage can be any S3-protocol object storage equivalent, such as Minio, Ceph or NetApp.
Postgres Database1PostgreSQL v11+ (12.2 recommended)RDS Postgres db.t3.largeAzure Database for PostgreSQLAll persistent data is under client control. HA, backup, and retention are per client's internal policy.
NAT Gateway1Customer ExistingNATNAT
SAML identity provider1Customer ExistingAny SAML 2.0-compatible Identity Provider
Inference NodesXCustomer specifiedCustomer specifiedCustomer specifiedThese nodes run inferencing – one node per PE and at least 1TB object storage based on the requirements of the models.
Load Balancer Optional Customer ExistingELBALBWe recommend Round-robin DNS if no LB exists.
Modzy Management Optional t3.smallD2 v4This node is optional and only used to stage initialization and installation scripts.
720

(Left): Existing customer infrastructure required to interface with Modzy. (Middle): Created by the Modzy platform installer. (Right): On-demand inference nodes, according to the requirements of models running in the system.

Modzy Edge

This section provides minimum requirements for running Modzy Edge.

Minimum Device Requirements

To use Modzy Edge on an edge device, that device must meet some minimum hardware requirements. These requirements are typically easy to meet in the cloud, or on-prem, but Modzy Edge also works with many small form-factor devices.

Operating SystemLinux
CPURequires an ARM 32-bit, ARM 64-bit, or x86 (AMD or Intel) 64-bit processor, with at least 2 cores
RAM2+ GiB of RAM is recommended, but more may be required for running larger models or multiple models at once
GPUNot required, but Modzy Edge supports NVIDIA GPUs
TPUNot required and not yet supported (though models will still run on a CPU)
Device Storage16+ GiB of storage is recommended, but more may be required for storing model results
DependenciesDocker v20.10.x or newer

Validated Small Form-factor Devices

Modzy Edge has been tested on the following small form-factor edge devices

  • Nvidia Jetson Nano 4GB
  • Raspberry Pi 3 Model B+