# oracle-devrel/cd3-automation-toolkit architecture

> Architecture diagram of the GitHub repository oracle-devrel/cd3-automation-toolkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oracle-devrel/cd3-automation-toolkit
- Repository: https://github.com/oracle-devrel/cd3-automation-toolkit

## Overview

##### Main Components Overview
The system should be represented as a multi-layered architecture with these primary components:

a) Input Layer:
- Excel Templates (represented as document symbols)
- Existing OCI Infrastructure (for export functionality)

b) Core Processing Layer:
- CD3 Automation Engine
- Validation Components
- Parser Components

c) Output Layer:
- Terraform Modules
- Resource Manager Configurations
- Jenkins Pipeline Integrations

##### Key Relationships

- Bi-directional flow between OCI Infrastructure and CD3 (for both creation and export)
- Data flow from Excel templates through the processing layer to Terraform output
- Integration points with CI/CD systems

##### Detailed Component Breakdown

Service Modules (shown as grouped components):
**Identity & Security:**
- IAM
- Tagging
- Quotas
- Network Firewall
- KMS

**Infrastructure:**
- Network
- Compute
- Storage
- Database
- Load Balancers
- DNS Management

**Container & Orchestration:**
- OKE (Oracle Kubernetes Engine)
- SDDC

**Management:**
- Resource Manager
- Monitoring
- Logging
- Cloud Guard
- Budgets

##### Integration Points

External system connections:
- Jenkins Pipeline integration
- OCI Resource Manager
- DevOps Git service
- OPA (Open Policy Agent) integration

##### Data Flow Patterns

Three main workflows:

##### Architectural Layers

**Top: User Interface/Input Layer**
**Middle: Processing/Automation Layer**
**Bottom: Infrastructure/Output Layer**

##### Implementation Notes

- Use standard architectural symbols for clarity
- Version control indicators
- Security boundaries clearly
- Scalability points
- Compliance checkpoints

- Automation capabilities
- Bi-directional functionality
- Security integration
- Compliance support
- DevOps enablement

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Input Layer"
        ET["Excel Templates"]:::input
        OCI["OCI Infrastructure"]:::input
    end

    subgraph "Core Processing Layer"
        CD3["CD3 Automation Engine"]:::core
        VAL["Validation Components"]:::core
        PAR["Parser Components"]:::core
    end

    subgraph "Service Modules"
        subgraph "Identity & Security"
            IAM["IAM"]:::security
            TAG["Tagging"]:::security
            QUO["Quotas"]:::security
            NFW["Network Firewall"]:::security
            KMS["KMS"]:::security
        end

        subgraph "Infrastructure"
            NET["Network"]:::infra
            COM["Compute"]:::infra
            STR["Storage"]:::infra
            DB["Database"]:::infra
            LB["Load Balancers"]:::infra
            DNS["DNS Management"]:::infra
        end

        subgraph "Container & Orchestration"
            OKE["OKE"]:::container
            SDDC["SDDC"]:::container
        end

        subgraph "Management"
            RM["Resource Manager"]:::mgmt
            MON["Monitoring"]:::mgmt
            LOG["Logging"]:::mgmt
            CG["Cloud Guard"]:::mgmt
            BUD["Budgets"]:::mgmt
        end
    end

    subgraph "Output Layer"
        TF["Terraform Modules"]:::output
        RMC["Resource Manager Config"]:::output
        JEN["Jenkins Pipeline"]:::output
    end

    subgraph "Security & Compliance"
        OPA["OPA Policies"]:::security
        CGP["Cloud Guard Policies"]:::security
        NFP["Network Firewall Policies"]:::security
    end

    %% Relationships
    ET --> CD3
    OCI --> CD3
    CD3 --> VAL
    CD3 --> PAR
    VAL --> TF
    PAR --> TF
    TF --> RMC
    TF --> JEN
    CD3 --> OPA

    %% Click Events
    click ET "https://github.com/oracle-devrel/cd3-automation-toolkit/blob/main/cd3_automation_toolkit/example/*.xlsx"
    click CD3 "https://github.com/oracle-devrel/cd3-automation-toolkit/blob/main/cd3_automation_toolkit/setUpOCI.py"
    click VAL "https://github.com/oracle-devrel/cd3-automation-toolkit/blob/main/cd3_automation_toolkit/cd3Validator.py"
    click PAR "https://github.com/oracle-devrel/cd3-automation-toolkit/blob/main/cd3_automation_toolkit/Network/BaseNetwork/cd3parser.py"
    click IAM "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Identity/"
    click NET "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Network/"
    click COM "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Compute/"
    click STR "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Storage/"
    click DB "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Database/"
    click OKE "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/DeveloperServices/OKE/"
    click SDDC "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/SDDC/"
    click RM "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/DeveloperServices/ResourceManager/"
    click TF "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/user-scripts/terraform/modules/"
    click JEN "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/jenkins_install/"
    click OPA "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/user-scripts/OPA/"
    click CG "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Security/CloudGuard/"
    click NFW "https://github.com/oracle-devrel/cd3-automation-toolkit/tree/main/cd3_automation_toolkit/Security/Firewall/"

    %% Styles
    classDef input fill:#90EE90
    classDef core fill:#87CEEB
    classDef output fill:#FFA500
    classDef security fill:#FF6B6B
    classDef mgmt fill:#DDA0DD
    classDef infra fill:#B8860B
    classDef container fill:#20B2AA

    %% Legend
    subgraph Legend
        L1["Input Components"]:::input
        L2["Core Processing"]:::core
        L3["Output Components"]:::output
        L4["Security Components"]:::security
        L5["Management"]:::mgmt
        L6["Infrastructure"]:::infra
        L7["Containers"]:::container
    end
```
