This article describes the supported deployment options for the MeshIQ Platform in containerized environments.
Prerequisites
- Docker is installed.
- Kubernetes is available (for Helm deployments).
- A supported container registry is accessible.
- Required storage classes and networking are configured.
- You have access to the MeshIQ container images and deployment packages.
Deployment Procedure
- The following Docker images are required for a complete MeshIQ Platform deployment, regardless of the deployment method (Helm, Docker Compose, or Docker Swarm). You can pull these images manually from the meshIQ public repository when deploying in an air-gapped environment. Otherwise, your chosen orchestration tool automatically pulls the required images during deployment.
| Docker Image | Component |
|---|---|
| domain | AP/Domain |
| job-scheduler-cep | Job Scheduler |
| cep-wgs | Workgroup Server |
| nsqcm | Connection Managers |
| manage | Manage UI/Frontend |
| control-center | Control Center UI/navxwsm |
| cep-track | Multi-use image for CEP related services (CEP Gateway, CEP Scheduler, and CEP Service) |
| ds-api | Data Services API |
| track | Track UI/Frontend |
| grafana | Grafana with the MeshIQ Data Source Plugin |
| observe | Observe UI/Frontend |
| meshiq-gateway | Gateway UI/Frontend |
- Deploy the MeshIQ Platform by using one of the following methods:
- Helm charts
- Docker Compose
- Docker Swarm
All three methods provide the full functionality of the MeshIQ Platform.
Docker Compose and Docker Swarm are lightweight deployment options that do not require a cluster and can be deployed directly on bare-metal systems. Unlike Helm charts, they do not provide a package repository for managing deployment configurations.
We recommend using Helm charts because they provide greater flexibility for configuration, simplify upgrades, and support easy rollbacks.
For more information about deploying the MeshIQ Platform with Helm charts, see Deploy the MeshIQ Platform with Helm Charts.
- After deploying the MeshIQ Platform, verify that all services are running and then access the MeshIQ user interfaces.
Upgrading the Deployment
When a new MeshIQ Platform release becomes available, updated Docker images for the affected components and an updated Helm chart are published for the new release.
To upgrade the platform
- Download the latest Helm chart.
- Review the release notes for any prerequisites or changes.
- Run the Helm upgrade command.
- Verify that all platform services are running successfully.
Use Helm rollback to restore the previous version if you encounter issues after upgrading.
Cloud-Specific Considerations
Amazon EKS
Before deploying the MeshIQ Platform on Amazon EKS, configure a default StorageClass.
Configure a Default StorageClass for an EKS Cluster
- Verify that the EKS cluster has a default
StorageClassconfigured. - If no default
StorageClassis configured, do one of the following:
- Configure an existing
StorageClassas the default by adding the following annotation to theStorageClassYAML file:storageclass.kubernetes.io/is-default-class: "true"
- Set
global.storage.classin the Helm values file to a validStorageClassconfigured on the cluster.
- Apply the updated StorageClass configuration.
Newly created EKS clusters might include a StorageClass that is
not configured as the default.
Microsoft Azure
- Configure and use the Kubernetes
LoadBalancerservice to expose the MeshIQ Platform services.
Oracle Cloud Infrastructure (OCI)
- Configure storage classes and networking according to Oracle Cloud Infrastructure recommendations.