How dhrjklt/diracx-charts works
Main Components
• Helm Chart & Templates – The “diracx” folder and its “templates” subdirectory contain all the Kubernetes YAML templates (Deployments, Services, Ingress, ConfigMaps, Jobs, etc.) for deploying the DiracX services.
• Core Application Components – This includes the DiracX API (main back-end service) and the DiracX Web frontend (“diracx-web”). Represent these as separate deployment blocks.
• Dependent Services & Infrastructure – The chart includes dependencies for:
• MySQL (for the database)
• OpenSearch/Elasticsearch (for logs or other data storage)
• Dex (for identity and authentication)
• Minio (as an object store)
• RabbitMQ (for messaging)
• Additional telemetry and monitoring components: OpenTelemetry Collector, Prometheus, Jaeger, Grafana
• The cert-manager issuer (via packaged subchart) which handles certificate management.
• Development/Demo Components – Note the “demo” directory and the “run_demo.sh” script, which set up a local Kubernetes cluster using tools like Docker and Kind.
• CI/CD and GitHub Workflows – Under the “.github” directory, workflows (like main.yml) manage testing and integration, showing that automated deployment and testing are on the roadmap.
Out Relationships and Interactions
• At the top level, illustrate the Kubernetes cluster as the overarching environment where all deployments run.
• Within the cluster, separate the deployment of DiracX into its two major components:
• The API/back-end (diracx)
• The Web frontend (diracx-web)
• Surround these with their dependent services:
• Communication with Dex for authentication.
• Minio for object storage interactions.
• RabbitMQ for messaging between microservices.
• For telemetry, show the OpenTelemetry collector gathering traces/metrics from various components, with outputs directed to Prometheus (for metrics), Jaeger (for tracing), and Grafana (for visualization). Note the conditional nature of these components (experimental use when enabled).
• Overall dependency management by Helm. This includes the templating system itself and the managed dependencies (most provided as packaged tgz files inside the “diracx/charts” directory).
Architectural Patterns and Principles
• GitOps/Declarative approach deployed in Kubernetes with Helm charts.
• The use of sub-charts to manage dependencies indicates a microservices-inspired, loosely coupled architecture.
• Separation of concerns: infrastructure (Helm/Kubernetes objects), middleware (RabbitMQ, Dex, etc.), persistent layers (MySQL, OpenSearch), and observability (OpenTelemetry, Prometheus, Jaeger, Grafana).
• That the deployment strategy supports both development with live reloading and production setups by toggling initialization steps via configuration values.
Technologies and Frameworks
• Kubernetes for orchestration.
• Helm for templating configurations.
• Docker/Kind for local development setups (referenced by run_demo.sh).
• OpenTelemetry and related observability tools.
• GitHub Actions as part of your CI/CD pipeline.
Final Detailing
• Including a secondary, simplified “demo” view that highlights how the run_demo.sh script sets environment variables and mounts volumes for local development.