# cisco-en-programmability/terraform-provider-catalystcenter architecture

> Architecture diagram of the GitHub repository cisco-en-programmability/terraform-provider-catalystcenter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cisco-en-programmability/terraform-provider-catalystcenter
- Repository: https://github.com/cisco-en-programmability/terraform-provider-catalystcenter

## Overview

##### Project type and purpose
- This is a Terraform **provider plugin** written in Go, named `terraform-provider-catalystcenter`.
- Purpose: allow Terraform users to manage Cisco Catalyst Center resources (networks, devices, policies, etc.) via Terraform HCL by wrapping Cisco Catalyst Center’s REST API.

##### File structure
- Top-level Go modules:
- `main.go` – CLI entrypoint for the provider binary
- `catalystcenter/` – package containing all provider code
– `provider.go` – registers provider with Terraform SDK
– `config.go`, `utils.go`, `validators.go` – configuration and helpers
– `data_source_*.go` – definitions for every data-source
– `resource_*.go` – definitions for every resource
– `convert.go` – mapping between Terraform types and API types
– `logger.go` – logging helper
- `docs/`, `examples/`, `examples/samples/` – user documentation and sample Terraform configurations
- `Makefile`, `scripts/` – build, test, formatting and lint scripts
- `go.mod` / `go.sum` – Go dependency management
- No database components; interactions are purely via HTTP to Cisco Catalyst Center.

##### Insights from the README
- Provider requires Terraform 0.13+ and Go 1.20 to build.
- It exposes dozens of `resources` and `data-sources` corresponding to Catalyst Center API endpoints.
- It relies on environment variables or HCL config for credentials (`username`, `password`, `base_url`, `debug`, `ssl_verify`).
- Build and test via `make build`, `make test`, `make testacc`.

##### Be detailed
- Which Go packages handle which responsibilities
- HTTP vs. RPC boundaries
- Do not forget build/test scripts and documentation as supportive artifacts

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Actors
    TerraformCLI["Terraform CLI"]:::user
    CatalystAPI["Cisco Catalyst Center REST API"]:::external

    %% Provider Plugin Subgraph
    subgraph "Provider Plugin (terraform-provider-catalystcenter)" 
        direction TB
        Main["main.go"]:::code
        ProviderSetup["Provider Registration & Schema\n(provider.go, config.go)"]:::code
        Config["Configuration Layer\n(config.go)"]:::code
        Conversion["Conversion Layer\n(convert.go)"]:::code
        Utils["Utility Helpers\n(utils.go, validators.go, logger.go)"]:::code
        DiffCalc["Difference Calculator\n(diffs.go)"]:::code
        Resources["Resource Handlers\n(resource_*.go)"]:::code
        DataSources["Data-Source Handlers\n(data_source_*.go)"]:::code
    end

    %% Ancillary Components
    subgraph "Ancillary" 
        direction TB
        Build["Build & Test Automation\n(Makefile, scripts/)"]:::ancillary
        Docs["Documentation & Examples\n(docs/, examples/)"]:::ancillary
    end

    %% Relationships
    TerraformCLI -->|"loads plugin\nvia RPC"| Main
    Main --> ProviderSetup
    ProviderSetup --> Config
    ProviderSetup --> Resources
    ProviderSetup --> DataSources
    Config --> Conversion
    Conversion --> Resources
    Conversion --> DataSources
    Utils --> Resources
    Utils --> DataSources
    Resources -->|HTTP Requests| CatalystAPI
    DataSources -->|HTTP Requests| CatalystAPI
    CatalystAPI -->|HTTP Responses| Resources
    CatalystAPI -->|HTTP Responses| DataSources
    Build -.-> Main
    Build -.-> Resources
    Build -.-> DataSources
    Docs -.-> TerraformCLI
    Docs -.-> ProviderSetup

    %% Click Events
    click Main "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/main.go"
    click ProviderSetup "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/provider.go"
    click Config "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/config.go"
    click Conversion "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/convert.go"
    click Utils "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/utils.go"
    click Utils "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/validators.go"
    click Utils "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/logger.go"
    click Resources "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/resource_*.go"
    click DataSources "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/data_source_*.go"
    click DiffCalc "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/blob/main/catalystcenter/diffs.go"
    click Build "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/tree/main/Makefile"
    click Build "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/tree/main/scripts/"
    click Docs "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/tree/main/docs/"
    click Docs "https://github.com/cisco-en-programmability/terraform-provider-catalystcenter/tree/main/examples/"

    %% Styles
    classDef user fill:#f9f,stroke:#333,stroke-width:1px
    classDef external fill:#afa,stroke:#333,stroke-width:1px
    classDef code fill:#bbf,stroke:#333,stroke-width:1px
    classDef ancillary fill:#eee,stroke:#666,stroke-width:1px,stroke-dasharray: 5 5
```
