This repository documents the code EdgeCenter publishes on GitHub. Product documentation lives in the knowledge base and the API reference; nothing here duplicates them.

Contents

Document	What it answers
Getting started	From an empty directory to a first managed resource, with Terraform or Go
Repository map	Every public repository, what it does, who consumes it, how alive it is
Compatibility	Which provider release pins which SDK version, and which Go versions are supported
Development	Toolchain, make targets, layout and coding standards shared by the Go repositories
Releasing	Versioning, tagging, and how a change travels from an SDK to Terraform users
Decisions	Architecture decision records for choices that outlive a single pull request

Contribution rules and the security policy are organization-wide and live in Edge-Center/.github.

The shape of the space

Three layers, and each one is usable on its own.

flowchart TD
  USER["Your infrastructure code"]

  TF["terraform-provider-edgecenter<br/>62 resources, 44 data sources"]

  subgraph SDKS["Go SDKs, one module per service"]
    direction LR
    CLOUD["edgecentercloud-go"]
    CDN["edgecentercdn-go"]
    DNS["edgecenter-dns-sdk-go"]
    STORAGE["edgecenter-storage-sdk-go"]
    PROT["edgecenterprotection-go"]
    MON["edgecenteredgemon-go"]
  end

  subgraph K8S["Kubernetes components"]
    direction LR
    CCM["edgecenter-ccm"]
    CSI["edgecenter-csi"]
    EDNS["external-dns-ec-webhook"]
    CERT["cert-manager-webhook-edgecenter"]
  end

  API(["EdgeCenter public API"])

  USER --> TF
  USER --> K8S
  TF --> SDKS
  CCM --> CLOUD
  CSI --> CLOUD
  EDNS --> DNS
  CERT --> DNS
  SDKS --> API

Loading

The provider is the only top-level consumer of every SDK. That has one consequence worth internalising before you touch anything: the provider pins tagged SDK releases in its go.mod, not local paths. An SDK fix reaches Terraform users only after the SDK is tagged, the provider bumps the pin, and the provider itself is released. Three steps, not one. Releasing walks through it.

Which repository do I need

I want to ...	Repository
Manage cloud, CDN, DNS, storage or protection as code	terraform-provider-edgecenter
Write a Go program against the cloud API	edgecentercloud-go
Automate CDN resources, rules or certificates	edgecentercdn-go
Manage DNS zones and records	edgecenter-dns-sdk-go
Give a Kubernetes cluster nodes and load balancers	edgecenter-ccm
Give a Kubernetes cluster persistent volumes	edgecenter-csi
Issue certificates through DNS01	cert-manager-webhook-edgecenter or ec-dns-certbot-plugin
Chart CDN traffic in Grafana	grafana-cdn-datasource

The full inventory, including the parts that are quiet or unmaintained, is in the repository map.

Authentication, once

Everything in this space authenticates the same way: a permanent API token from the EdgeCenter control panel, sent as Authorization: APIKey <token>.

export EC_PERMANENT_TOKEN="your-token"

The Terraform provider reads that variable, and every SDK takes the token through its client options. Do not put a token in a committed .tf file, and remember that Terraform state holds whatever the API returns - treat the state file as a secret.

Fixing these docs

Open a pull request. Every page is plain markdown and renders on GitHub, so there is no build step to run and nothing to preview locally beyond a markdown viewer.