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.comand*.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.
| Resource | Qty | Specification | AWS Equivalent | Azure Equivalent | Notes |
|---|---|---|---|---|---|
| Kubernetes Control Plane | 1 | version 1.21 | EKS Control Plane | AKS Kubernetes Service | |
| Worker Nodes | 3 | 8 vCPU, 32GB RAM 100G SSD | m5.2xlarge. EBS storage | D4ds v4 | These nodes are used exclusively to run the Modzy application. |
| Object Storage | 1 | 1TB recommended | S3 | Blob storage | Object Storage can be any S3-protocol object storage equivalent, such as Minio, Ceph or NetApp. |
| Postgres Database | 1 | PostgreSQL v11+ (12.2 recommended) | RDS Postgres db.t3.large | Azure Database for PostgreSQL | All persistent data is under client control. HA, backup, and retention are per client's internal policy. |
| NAT Gateway | 1 | Customer Existing | NAT | NAT | |
| SAML identity provider | 1 | Customer Existing | Any SAML 2.0-compatible Identity Provider | ||
| Inference Nodes | X | Customer specified | Customer specified | Customer specified | These nodes run inferencing – one node per PE and at least 1TB object storage based on the requirements of the models. |
| Load Balancer | Optional | Customer Existing | ELB | ALB | We recommend Round-robin DNS if no LB exists. |
| Modzy Management | Optional | t3.small | D2 v4 | This node is optional and only used to stage initialization and installation scripts. |
(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 System | Linux |
| CPU | Requires an ARM 32-bit, ARM 64-bit, or x86 (AMD or Intel) 64-bit processor, with at least 2 cores |
| RAM | 2+ GiB of RAM is recommended, but more may be required for running larger models or multiple models at once |
| GPU | Not required, but Modzy Edge supports NVIDIA GPUs |
| TPU | Not required and not yet supported (though models will still run on a CPU) |
| Device Storage | 16+ GiB of storage is recommended, but more may be required for storing model results |
| Dependencies | Docker 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+
Updated 7 months ago