Home

Common Azure Resource Modules Library

The objective of this repository is to provide a template library that can be reused in Infrastructure as Code scenarios, such as landing zone, workloads or individual service deployments.

This wiki describes the content of this repository, the modules, pipelines, possible options on how to use them and how to contribute to this project.

If you're unfamiliar with Infrastructure as Code, or wonder how you can use the contents of this repository in your deployments please check out the context section of this wiki.

Navigation

• Context
  • Infrastructure as Code
  • Where does this platform fit in?
• Getting Started
  • General prerequisites
  • Where to start
• Modules
  • Design
  • Usage
• Testing
  • Design
  • Usage
• Utilities
  • Bicep to ARM conversion script
  • Register Azure DevOps pipelines script
  • Set Module ReadMe script
  • Get formatted RBAC roles script
  • GitHub readMe module table update script
• Pipelines
  • Design
    • Parameter File Tokens
    • Removal action
  • Usage
• Contribution Guide
• Upgrade guidelines
  • Migration from 0.3.1 to 0.4.0
• Known Issues

---

Note: the following table of contents is still a work in progress and intended to replace the above going forward.

Updated Navigation

• The context
  • CARML overview
    • The library
    • The CI environment
• Getting started
  • Setup environment
  • Consume library
• The library
  • Module design
  • Module usage
• The CI environment
  • Pipeline design
    • Static validation
    • Deployment validation
    • Publishing
    • Token replacement
  • Pipeline usage
• Interoperability
  • Bicep to ARM/JSON conversion
  • Register Azure DevOps pipelines
• Contribution guide
  • Contribution flow
  • Generate module Readme
  • Get formatted RBAC roles
  • Validate module locally
• Solution creation
• Upgrade guidelines
  • Upgrade from 0.3.1 to 0.4.0
• Known issues

---

Scope

Following you can find an abstract overview of everything in- and out-of-scope of this repository.

In Scope

• Modules: Rich library of resource modules - the foundation for workload or entire environments deployments
• Platform: Pipelines to validate modules & publish to those that pass to a location of your choice. Available with GitHub Workflows.
• Documentation: A rich documentation of best practices on module design, the platforms and its context, testing and pipelines

Out of Scope

• Orchestration: Orchestrated solutions such as workloads or entire environments intended for production environments
• Real-time Updates: Modules are updated on a best effort basis by a group of dedicated contributors
• Languages: Other design languages like Terraform

Reporting Issues and Feedback

Issues and Bugs

If you find any bugs, please file an issue in the GitHub Issues page. Please fill out the provided template with the appropriate information.

Please search the existing issues before filing new issues to avoid duplicates.

If you are taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Feedback

If there is a feature you would like to see in here, please file an issue or feature request in the GitHub Issues page to provide direct feedback.

---

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

---

Learn More

• PowerShell Documentation
• Microsoft Azure Documentation
• Azure Resource Manager
• Bicep
• GitHubDocs