# opentidehq/inittide architecture

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

- Interactive diagram: https://gitdiagram.com/opentidehq/inittide
- Repository: https://github.com/opentidehq/inittide

## Overview

##### Project type and purpose
- This repository, “InitTide,” is not a traditional full-stack application but rather a **content-and-configuration management tool** for security detection assets.
- It houses **YAML-based detection objects**, **JSON schemas**, **lookup tables**, and **system-specific configuration** files, all coordinated via **CI/CD pipelines** to validate, transform, and deploy detection rules to various security platforms (Splunk, Sentinel, CrowdStrike, etc.).

##### File structure
- Top-level CI definitions:
- .azure-pipeline.yml
- .gitlab-ci.yml
- These drive the **validation**, **packaging**, and **deployment** pipelines on Azure DevOps and GitLab.
- Configurations/
- deployment.toml, documentation.toml, lookups.toml
- systems/*.toml — settings for each target security platform.
- Lookups/
- Global, Sentinel, Splunk — metadata mappings used during rule conversion.
- Objects/
- Business Detections, Detection Models, Detection Rules, Threat Vectors — YAML definitions of each detection artifact.
- Schemas/

##### Key insights from the README
- The README is a generic GitLab starter template; it does not contain domain-specific architecture details.
- We must infer from the folder layout that the core workflow is: **Author detection artifacts → Validate against schemas → Transform via lookups and configurations → Deploy to systems**.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Source Control
    SC["Source Control (GitLab/Azure Repos)"]:::codeAssets

    subgraph "CI/CD Orchestrator"
        GCI["GitLab CI"]:::stage
        AP["Azure Pipelines"]:::stage
        AZSecrets["set_secrets.yml"]:::codeAssets
    end

    SC --> GCI
    SC --> AP
    AP --> AZSecrets

    %% Validation Stage
    ValidationStage["Validation Stage"]:::stage
    GCI --> ValidationStage
    AP --> ValidationStage

    subgraph "Schemas"
        BDRSchema["BDR Schema.json"]:::codeAssets
        CDMSchema["CDM Schema.json"]:::codeAssets
        MDRSchema["MDR Schema.json"]:::codeAssets
        TVMSchema["TVM Schema.json"]:::codeAssets
    end

    subgraph "Objects"
        BDs["Business Detections/"]:::codeAssets
        DMs["Detection Models/"]:::codeAssets
        DRs["Detection Rules/"]:::codeAssets
        TVs["Threat Vectors/"]:::codeAssets
    end

    BDRSchema --> ValidationStage
    CDMSchema --> ValidationStage
    MDRSchema --> ValidationStage
    TVMSchema --> ValidationStage
    BDs --> ValidationStage
    DMs --> ValidationStage
    DRs --> ValidationStage
    TVs --> ValidationStage

    %% Transformation Stage
    TransformationStage["Transformation Stage"]:::stage
    ValidationStage --> TransformationStage

    subgraph "Lookups"
        GlobalLU["Global/"]:::codeAssets
        SentinelLU["Sentinel/"]:::codeAssets
        SplunkLU["Splunk/"]:::codeAssets
    end

    subgraph "Configurations"
        DeployToml["deployment.toml"]:::codeAssets
        LookupsToml["lookups.toml"]:::codeAssets
        subgraph "systems/"
            CBCToml["carbon_black_cloud.toml"]:::codeAssets
            CSToml["crowdstrike.toml"]:::codeAssets
            DFEToml["defender_for_endpoint.toml"]:::codeAssets
            SentinelToml["sentinel.toml"]:::codeAssets
            SO1Toml["sentinel_one.toml"]:::codeAssets
            SplunkToml["splunk.toml"]:::codeAssets
        end
    end

    GlobalLU --> TransformationStage
    SentinelLU --> TransformationStage
    SplunkLU --> TransformationStage
    DeployToml --> TransformationStage
    LookupsToml --> TransformationStage
    CBCToml --> TransformationStage
    CSToml --> TransformationStage
    DFEToml --> TransformationStage
    SentinelToml --> TransformationStage
    SO1Toml --> TransformationStage
    SplunkToml --> TransformationStage

    %% Deployment Stage
    DeploymentStage["Deployment Stage"]:::stage
    TransformationStage --> DeploymentStage

    Crowdstrike["CrowdStrike"]:::external
    Splunk["Splunk"]:::external
    SentinelExt["Azure Sentinel"]:::external
    Defender["Defender for Endpoint"]:::external
    CBC["Carbon Black Cloud"]:::external
    SentinelOne["SentinelOne"]:::external

    DeploymentStage --> Crowdstrike
    DeploymentStage --> Splunk
    DeploymentStage --> SentinelExt
    DeploymentStage --> Defender
    DeploymentStage --> CBC
    DeploymentStage --> SentinelOne

    %% Documentation Stage
    DocumentationStage["Documentation Stage"]:::stage
    DocsToml["documentation.toml"]:::codeAssets
    GCI --> DocumentationStage
    AP --> DocumentationStage
    DocsToml --> DocumentationStage

    %% Click Events
    click GCI "https://github.com/opentidehq/inittide/blob/development/.gitlab-ci.yml"
    click AP "https://github.com/opentidehq/inittide/blob/development/.azure-pipeline.yml"
    click AZSecrets "https://github.com/opentidehq/inittide/blob/development/.azure/set_secrets.yml"
    click BDs "https://github.com/opentidehq/inittide/tree/development/Objects/Business Detections/"
    click DMs "https://github.com/opentidehq/inittide/tree/development/Objects/Detection Models/"
    click DRs "https://github.com/opentidehq/inittide/tree/development/Objects/Detection Rules/"
    click TVs "https://github.com/opentidehq/inittide/tree/development/Objects/Threat Vectors/"
    click BDRSchema "https://github.com/opentidehq/inittide/blob/development/Schemas/BDR Schema.json"
    click CDMSchema "https://github.com/opentidehq/inittide/blob/development/Schemas/CDM Schema.json"
    click MDRSchema "https://github.com/opentidehq/inittide/blob/development/Schemas/MDR Schema.json"
    click TVMSchema "https://github.com/opentidehq/inittide/blob/development/Schemas/TVM Schema.json"
    click GlobalLU "https://github.com/opentidehq/inittide/tree/development/Lookups/Global/"
    click SentinelLU "https://github.com/opentidehq/inittide/tree/development/Lookups/Sentinel/"
    click SplunkLU "https://github.com/opentidehq/inittide/tree/development/Lookups/Splunk/"
    click DeployToml "https://github.com/opentidehq/inittide/blob/development/Configurations/deployment.toml"
    click LookupsToml "https://github.com/opentidehq/inittide/blob/development/Configurations/lookups.toml"
    click CBCToml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/carbon_black_cloud.toml"
    click CSToml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/crowdstrike.toml"
    click DFEToml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/defender_for_endpoint.toml"
    click SentinelToml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/sentinel.toml"
    click SO1Toml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/sentinel_one.toml"
    click SplunkToml "https://github.com/opentidehq/inittide/blob/development/Configurations/systems/splunk.toml"
    click DocsToml "https://github.com/opentidehq/inittide/blob/development/Configurations/documentation.toml"

    %% Styles
    classDef codeAssets fill:#D6EAF8,stroke:#1B4F72
    classDef stage fill:#FADBD8,stroke:#943126
    classDef external fill:#D5F5E3,stroke:#1E8449
```
