Deployment & Operations


Welcome to the deployments and operations guide for the Midaz system. This document provides insights into various deployment strategies and operational practices with a focus on self-hosted setups. SaaS deployments, being fully managed by the Midaz team, require no client-side setup.

Deployment Strategies

Local development

  • Current Support: Midaz is currently deployable locally using Docker Compose, suitable for development and testing.

  • Setup Instructions:

    • Ensure Docker is installed on your local machine. Install Docker.

Self-hosted

  • Future Support: Plans include support for Kubernetes deployments using Helm charts, enabling scalable and manageable deployments in both private and public cloud environments.

  • Infrastructure Requirements:

    • A Kubernetes cluster is necessary to run the Midaz core and associated satellite services such as Authentication, Onboarding, Portfolio and Transactions.

    • The system is designed to be cloud-agnostic, allowing deployment on any cloud platform, including AWS, GCP, and Azure, without vendor lock-in.

SaaS model

  • Management: In the SaaS model, all infrastructure and operational responsibilities are managed by the Midaz team, allowing clients to focus solely on their business needs.

System Requirements and Infrastructure Setup

Self-hosted setup

  • Requirements: Operating Midaz in a self-hosted environment requires a Kubernetes cluster to host the Midaz Core and its satellite services.

  • Deployment Flexibility: The system can be deployed on any cloud platform, including private and public clouds like AWS, GCP, and Azure.

Configuration management and application lifecycle management

  • Configuration: Configuration of Midaz is typically completed during the deployment phase.

  • Authentication Configuration: Secrets for services like Kratos and Hydra in the Authentication domain should be created and managed securely using tools like HashiCorp Vault or cloud-based secret managers.

Monitoring, Logging, and Alerting

Self-hosted

  • Observability: Midaz supports Logs, Tracing, and Metrics to meet observability standards using OpenTelemetry. This allows for integration with any observability tool that supports OpenTelemetry.

Backup, Recovery, and Data Retention Policies

Self-hosted

  • Responsibility: Clients are responsible for managing backup and data retention policies in their self-hosted setups, whether in public or private clouds.

Recommendations

This guide outlines the necessary steps and considerations for deploying and operating Midaz in self-hosted environments. It underscores the importance of robust infrastructure, secure configuration management, and effective observability practices. SaaS clients enjoy the benefit of having all operational complexities managed by the Midaz team, focusing entirely on achieving their business objectives.

For further assistance, please consult our detailed documentation or reach out through our community support channels.

Last updated