# tmforum-oda/oda-canvas architecture

> Architecture diagram of the GitHub repository tmforum-oda/oda-canvas, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tmforum-oda/oda-canvas
- Repository: https://github.com/tmforum-oda/oda-canvas

## Overview

- The ODA Canvas Core – this is the central orchestration layer that manages overall lifecycle, initiates deployments and integrates with the various operators.
- Operator Subsystems – these are independent, loosely coupled services. They include:
– The Component Management operator (handles lifecycle and decomposition of a component into its sub-resources).
– The API Management operators (with separate implementations for different API Gateways or Service Meshes such as Istio, Kong, Apache APISIX, Apigee, Azure APIM, etc.).
– The Identity Config operator (for configuring identity management services).
– The Secrets Management operator (optional but present for secret configuration).
– The Dependent APIs operator (to assist with dependency discovery and integration).
- Canvas Portal – the user interface and back-end services for managing the canvas (visible in subdirectories like canvas-portal, which also include a web front-end, REST controllers, service layers, and helm configurations).
- CI/CD and Deployment Pipelines – deducible from extensive GitHub workflows, automation generators, Helm chart repositories (charts/*), and Dockerfiles. This illustrates building, releasing, and deploying various operators and base images.
- Supporting Tools & Test Frameworks – the feature definition-and-test-kit, automation scripts, and logging/observability configurations (e.g., Observability-design.md) round out the picture.

##### How these components interact
- The ODA Canvas Core communicates with each operator via API calls or messaging events (indicated by “Event-based-integration-design.md” and orchestrated workflows).
- The Canvas Portal serves as the UI/Service façade, interfacing with the back-end and indirectly invoking operators.
- The CI/CD pipeline (with GitHub actions workflows and automation generators) is responsible for building images, running tests, and deploying Helm charts.
- Modular integration: each operator’s deployment and lifecycle is controlled via chart installations (notice the extensive charts directory for various operators).

##### Architectural patterns and technologies
- Microservices/Multi-tenant design, where each operator is an independent service.
- Use of containers/Docker images as shown in numerous Dockerfiles and baseimages.
- Helm charts for Kubernetes management & deployment.
- Event-driven and RESTful APIs enforcing decoupling.
- CI/CD automation pipelines using GitHub Actions.
- The use of Jinja2 templating for workflow generation and scripting within automation components.

##### Final suggestions
- Clearly label every component with both its function and any pertinent technology (e.g., “Helm Chart Deployment for API Operator (Istio)”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    CICD["CI/CD & Deployment Pipelines"]:::cicd
    Portal["Canvas Portal (UI & Service Layers)"]:::portal
    Core["ODA Canvas Core"]:::core

    subgraph "Operator Subsystems"
        Component["Component Management Operator"]:::operator
        AP_Istio["API Management Operator - Istio"]:::operator
        AP_Kong["API Management Operator - Kong"]:::operator
        AP_APISIX["API Management Operator - Apache APISIX"]:::operator
        AP_Apigee["API Management Operator - Apigee"]:::operator
        AP_Azure["API Management Operator - Azure APIM"]:::operator
        Identity["Identity Configuration Operator"]:::operator
        Secrets["Secrets Management Operator"]:::operator
        Dependent["Dependent APIs Operator"]:::operator
    end

    Tools["Supporting Tools & Test Frameworks"]:::cicd

    subgraph "External Systems"
        K8s["Kubernetes Cluster"]:::external
        APIGateway["External API Gateways/Service Mesh"]:::external
        IdentityProv["External Identity Providers"]:::external
    end

    Portal -->|"invokes"| Core
    Core -->|"orchestrates"| Component
    Core -->|"orchestrates"| AP_Istio
    Core -->|"orchestrates"| AP_Kong
    Core -->|"orchestrates"| AP_APISIX
    Core -->|"orchestrates"| AP_Apigee
    Core -->|"orchestrates"| AP_Azure
    Core -->|"orchestrates"| Identity
    Core -->|"orchestrates"| Secrets
    Core -->|"orchestrates"| Dependent

    CICD -->|"builds&deploys"| Core
    CICD -->|"builds&deploys"| Component
    CICD -->|"builds&deploys"| AP_Istio
    CICD -->|"builds&deploys"| AP_Kong
    CICD -->|"builds&deploys"| AP_APISIX
    CICD -->|"builds&deploys"| AP_Apigee
    CICD -->|"builds&deploys"| AP_Azure
    CICD -->|"builds&deploys"| Identity
    CICD -->|"builds&deploys"| Secrets
    CICD -->|"builds&deploys"| Dependent
    CICD -->|"triggersTests"| Tools

    Component -->|"deploysTo"| K8s
    AP_Istio -->|"integratesWith"| APIGateway
    AP_Kong -->|"integratesWith"| APIGateway
    AP_APISIX -->|"integratesWith"| APIGateway
    AP_Apigee -->|"integratesWith"| APIGateway
    AP_Azure -->|"integratesWith"| APIGateway
    Identity -->|"configures"| IdentityProv
    Core -->|"monitors"| K8s

    click Core "https://github.com/tmforum-oda/oda-canvas/tree/main/canvas-portal/portal-core"
    click Component "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/component-management"
    click AP_Istio "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/api-management/istio"
    click AP_Kong "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/api-management/kong"
    click AP_APISIX "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/api-management/apache-apisix"
    click AP_Apigee "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/api-management/apigee"
    click AP_Azure "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/api-management/azure-apim"
    click Identity "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/identity-config"
    click Secrets "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/secretsmanagementOperator-hc"
    click Dependent "https://github.com/tmforum-oda/oda-canvas/tree/main/source/operators/dependentApiSimpleOperator"
    click Portal "https://github.com/tmforum-oda/oda-canvas/tree/main/canvas-portal"
    click CICD "https://github.com/tmforum-oda/oda-canvas/tree/main/.github/workflows"
    click Tools "https://github.com/tmforum-oda/oda-canvas/tree/main/automation/generators"

    classDef core fill:#fde2e2,stroke:#d12c2c,stroke-width:2px;
    classDef operator fill:#e2eef6,stroke:#2c7dd1,stroke-width:2px;
    classDef portal fill:#e2f9e6,stroke:#2cd17d,stroke-width:2px;
    classDef cicd fill:#fff4e2,stroke:#d17a2c,stroke-width:2px;
    classDef external fill:#f0f0f0,stroke:#777,stroke-width:2px;
```
