Readme for Platform Cloud Resources

Overview

This repository is dedicated to managing cloud resources, specifically for Azure, using Terraform. It facilitates cloud-related self-service actions within the Internal Developer Platform (IDP) of Port.

Capabilities

• Management of Kubernetes clusters.
• Management of domains and DNS zones.
• Management of dedicated endpoints for clusters.

Integration

• Port
• Azure

Tools and Modules

• Platform Orchestrator (GitHub Actions)
• Kubernetes Cluster (Terraform Module)
• Fronthub (Terraform Module)

Architecture

Sequence of Cluster Management

sequenceDiagram
    actor PLE as Platform Engineer
    participant PRT as Port IDP
    participant RCR as Repository:<br>platform-cloud-resources
    participant RPO as Repository:<br>platform-orchestrator
    participant TFC as Terraform Cloud
    participant MKC as Terraform Module:<br>azure-kubernetes-cluster
    participant AZR as Azure

    PLE ->> PRT: Add or delete clusters
    PRT ->> RCR: Initiate workflow:<br>clusters-modify.yaml

    activate RCR
    RCR ->>RPO: Call modifier action
    activate RPO
    RPO -->>RCR: Modify `clusters.json`
    deactivate RPO
    RCR ->> RCR: Commit and push changes
    deactivate RCR

    RCR ->>RCR: Initiate workflow:<br>clusters-sync.yaml

    activate RCR
    RCR ->> TFC: Plan and apply
    TFC ->>MKC: Use module
    MKC ->> AZR: Change to desired state
    activate AZR
    AZR -->> MKC: Return outputs
    deactivate AZR
    MKC -->>TFC: Return outputs
    TFC ->> PRT: Upsert/delete cluster entities
    deactivate RCR

Loading

Sequence of DNS Zone Management

sequenceDiagram
    actor PLE as Platform Engineer
    participant PRT as Port IDP
    participant RCR as Repository:<br>platform-cloud-resources
    participant RPO as Repository:<br>platform-orchestrator
    participant TFC as Terraform Cloud
    participant MFH as Terraform Module:<br>azure-front-hub
    participant AZR as Azure

    PLE ->> PRT: Add or delete domains
    PRT ->> RCR: Initiate workflow:<br>fronthub-modify-dns-zone.yaml

    activate RCR
    RCR ->>RPO: Call modifier action
    activate RPO
    RPO -->>RCR: Modify `fronthub.json`
    deactivate RPO
    RCR ->>RPO: Call transformer action
    activate RPO
    RPO -->>RCR: Transform `fronthub.json`<br>to `fronthub.lock.json`
    deactivate RPO
    RCR ->> RCR: Commit and push changes
    deactivate RCR

    RCR ->>RCR: Initiate workflow:<br>fronthub-sync.yaml

    activate RCR
    RCR ->> TFC: Plan and apply
    TFC ->> MFH: Use module
    MFH ->> AZR: Change to desired state
    activate AZR
    AZR -->>MFH: Return outputs
    deactivate AZR
    MFH -->>TFC: Return outputs
    TFC ->>PRT: Upsert/delete domain (with relevant nameservers) and endpoint entities
    deactivate RCR

Loading

Sequence of Endpoint Management

sequenceDiagram
    actor PLE as Platform Engineer
    participant PRT as Port IDP
    participant RCR as Repository:<br>platform-cloud-resources
    participant RPO as Repository:<br>platform-orchestrator
    participant TFC as Terraform Cloud
    participant MFH as Terraform Module:<br>azure-front-hub
    participant AZR as Azure

    PLE ->> PRT: Add or delete endpoints
    PRT ->> RCR: Initiate workflow:<br>fronthub-modify-dns-zone.yaml

    activate RCR
    RCR ->>RPO: Call modifier action
    activate RPO
    RPO ->> PRT: Fetch endpoint's target cluster info
    PRT -->>RPO: Return data
    RPO -->>RCR: Modify `fronthub.json`
    deactivate RPO
    RCR ->>RPO: Call transformer action
    activate RPO
    RPO -->>RCR: Transform `fronthub.json`<br>to `fronthub.lock.json`
    deactivate RPO
    RCR ->> RCR: Commit and push changes
    deactivate RCR

    RCR ->>RCR: Initiate workflow:<br>fronthub-sync.yaml

    activate RCR
    RCR ->> TFC: Plan and apply
    TFC ->> MFH: Use module
    MFH ->> AZR: Change to desired state
    activate AZR
    AZR -->>MFH: Return outputs
    deactivate AZR
    MFH -->>TFC: Return outputs
    TFC ->>PRT: Upsert/delete domain (with relevant nameservers) and endpoint entities
    deactivate RCR

Loading

Components

• Clusters: The clusters directory focuses on managing Kubernetes Clusters on Azure (AKS) using the terraform-azure-kubernetes-cluster module.
• Fronthub: The fronthub directory deals with Azure DNS Zones and endpoint management for Azure Front Door, assigning subdomains or paths to specific clusters.

Workflows

Name	Description
clusters-modify.yaml	Modifies clusters.json as per Port's instructions, followed by committing and pushing changes.
clusters-sync.yaml	Executes terraform to provision or synchronize clusters.
fronthub-modify-dns-zone.yaml	Alters fronthub.json for domain management based on Port's guidance, updates fronthub.lock.json, and commits and pushes changes.
fronthub-modify-endpoint.yaml	Adjusts fronthub.json for endpoint management as per Port's instructions, followed by committing and pushing the final configuration.
fronthub-manual-transform.yaml	Manually triggered to transform fronthub.json to its final configuration, with subsequent commit and push operations.
fronthub-sync.yaml	Runs terraform to provision or update Azure DNS Zones and Front Door endpoints.