Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updating README with relevant information about terragrunt.
  • Loading branch information
sylviamclaughlin authored Mar 4, 2025
1 parent 7af883c commit 5c3df32
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,19 @@
The CDS Azure Resources repository contains Terraform modules for managing cloud resources in Microsoft Azure. It is designed to help deploy and manage secure, scalable, and compliant cloud resources for CDS's (Canadian Digital Service) Azure environment.

## Features
- 🏗 **Infrastructure as Code (IaC)** using **Terraform**
- 🏗 **Infrastructure as Code (IaC)** using Terragrunt/Terraform
- 🏢 **Management of Azure resources** via reusable modules
- 🛠 **Automated CI/CD pipelines** for validation and deployment

## Getting Started

### Prerequisites
Ensure you have the following installed:
- [Terragrunt](https://terragrunt.gruntwork.io/docs/getting-started/install/)
- [Terraform](https://developer.hashicorp.com/terraform/downloads) (>= v1.4.0)
- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
- [Git](https://git-scm.com/downloads)
- Access to **Azure Subscription** with necessary permissions
- Access to Azure Subscription with necessary permissions

### Clone the Repository
```sh
Expand All @@ -32,9 +33,9 @@ az account set --subscription <your-subscription-id>
### Deploy Infrastructure
Run the following Terraform commands:
```
terraform init # Initialize the Terraform working directory
terraform plan # Preview changes before applying
terraform apply # Deploy resources to Azure
terragrunt init # Initialize the Terraform working directory
terragrunt plan # Preview changes before applying
terragrunt apply # Deploy resources to Azure
```
### Repository Structure
```
Expand Down Expand Up @@ -71,4 +72,4 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for detai
## Authors
Maintained by the Canadian Digital Service (CDS).

---
---

0 comments on commit 5c3df32

Please sign in to comment.