https://github.com/excoriate/terragrunt-ref-arch-v2

Modular Infrastructure as Code Reference Architecture with Terragrunt
https://github.com/excoriate/terragrunt-ref-arch-v2

cloud devops infrastructure-as-code terraform terragrunt

Last synced: 3 months ago
JSON representation

Modular Infrastructure as Code Reference Architecture with Terragrunt

• Host: GitHub
• URL: https://github.com/excoriate/terragrunt-ref-arch-v2
• Owner: Excoriate
• License: mit
• Created: 2024-12-05T07:25:31.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-02-03T11:20:56.000Z (5 months ago)
• Last Synced: 2025-02-05T12:18:35.013Z (5 months ago)
• Topics: cloud, devops, infrastructure-as-code, terraform, terragrunt
• Language: Go
• Size: 112 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
⚠️ **PRE-ALPHA NOTICE** ⚠️

🚧 This project is in a pre-alpha stage of development.

- Expect frequent changes

- API and configuration formats may undergo significant modifications

- Not recommended for production use

- Contributions and feedback are highly welcome!

---

# Terragrunt Reference Architecture V2

## 🚀 Quick Overview

A modular, scalable, and maintainable infrastructure management framework using Terragrunt, designed to simplify and standardize cloud infrastructure deployment across multiple environments.

## 🌟 Key Features

- **Centralized Configuration Management**

- **Multi-Provider Support**

- **Multi-Stack(s) Support**

- **Environment-Specific Configurations, and Automatic Secrets Injection**

## 📐 Architecture Principles

### Hierarchical Infrastructure Organization

```mermaid

graph TD

    A[Root Configuration] --> B[Stack]

    B --> C[Layer]

    C --> D[Component]

```

## 🛠 Features & Capabilities

### 🔒 Centralized Configuration Management

- **Single Source of Truth**: Manage entire infrastructure through centralized YAML configurations

- **Environment-Specific Overrides**: Seamlessly customize configurations for different environments

- **DRY (Don't Repeat Yourself) Approach**: Reduce configuration redundancy and complexity

### 🌐 Multi-Provider Flexibility

- **Vendor-Agnostic Design**: Support for AWS, Azure, GCP, and more

- **Dynamic Provider Configuration**: Easily switch or integrate multiple cloud providers

- **Version Constraint Management**: Precise control over provider versions and compatibility

### 🚀 Infrastructure as Code (IaC) Optimization

- **Modular Stack Architecture**: Break down infrastructure into logical, manageable components

- **Hierarchical Configuration**: Root → Stack → Layer → Component organization

- **Reusable Infrastructure Components**: Create and share standardized infrastructure building blocks

### 🛡️ Advanced Configuration Management

- **Automatic Configuration Validation**

  - Comprehensive schema checking

  - Environment variable resolution

  - Secrets management

- **Intelligent Configuration Compilation**

  - Merge base and environment-specific configurations. Support multiple overrides.

  - Generate validated JSON configurations, through a compilation process that ensures that Terragrunt always receives a valid configuration.

  - Seamless Terragrunt integration. No side effects.

## 📦 Getting Started

### Prerequisites

- Terragrunt

- Terraform

- Go (for InfraCTL CLI)

- AWS CLI (or relevant cloud provider CLI)

### Quick Installation

```bash

# Clone the repository

git clone https://github.com/Excoraite/terragrunt-ref-arch-v2.git

# After you've configured your stack(s), layer(s) and component(s), you can run the following command to validate your configuration. E.g.:

just run-cli plan --target-env local --stack stack-datastore --layer db --component quota-generator

```

## 📚 Documentation

Explore our comprehensive documentation to understand the architecture and usage:

1. [Introduction](docs/01-introduction.md)

   - Project overview

   - Core concepts

   - Architecture principles

2. [Project Structure](docs/02-project-structure.md)

   - Repository organization

   - Directory layout

   - Configuration hierarchy

3. [Design Principles](docs/03-design-principles.md)

   - Architectural philosophy

   - Key design considerations

   - Guiding development principles

4. [Configuration System](docs/04-configuration-system.md)

   - Configuration management

   - Environment-specific settings

   - YAML configuration details

5. [InfraCTL CLI](docs/04-infractl-cli.md)

   - Command-line tool usage

   - Configuration validation

   - Infrastructure deployment commands

6. [Stack Management](docs/05-stack-management.md)

   - Infrastructure stack organization

   - Layer and component management

   - Provider integration

7. [Configuration Compilation](docs/06-configuration-compilation.md)

   - Detailed compilation process

   - Configuration validation

   - Environment variable and secret resolution

## 🤝 Contributing

1. Fork the repository

2. Create your feature branch

3. Commit your changes

4. Push to the branch

5. Create a Pull Request

## 📄 License

[Apache License 2.0](LICENSE)