Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Wiki] Home page updates to documentation #1640

Merged
merged 20 commits into from
Aug 8, 2022
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Common Azure Resource Modules Library
CARML resource library provides [bicep](https://github.com/Azure/bicep) modules which can be re-use in your infrastructure as code project to accelerate deployments. You can re-use code library as whole or in part. The primary aim is to provide you with re-usable infrastructure pattern so that you can focus what matter the most.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved
CARML should accelerate your deployment, it should also save time on testing, it should help you easily integrate and overall it should provide you with commonality across your infrastructure deployments. You could integrate CARML into your CI/CD pipelines and that will accelerate your DevOps adoption with ease.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved

The objective of this repository is to provide a template library that can accelerate deployments in Infrastructure as Code scenarios, such as Azure landing zones, landing zone accelerators and aspiring landing zone accelerators (workloads/applications/multi-module solutions) or individual service deployments.
CARML will make it easy to deploy complex deployment, such as Azure landing zone, landing zone accelerator or individual service deployments.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down Expand Up @@ -47,20 +49,23 @@ If you're unfamiliar with Infrastructure as Code or wonder how you can use the c

# Scope

Following, you can find an abstract overview of everything in- and out-of-scope of this repository.
In next section, you can find an overview of what is in scope and what is out of scope for CARML.

## In Scope

- **Module library:** A collection of comprehensive, reusable, Bicep-based building blocks to deploy Azure resources, that can be combined to create & orchestrate more complex, multi-module Azure solutions.
- **CI environment:** Pipelines to validate modules & publish the successfully validated ones to a target location, using semantic versioning. Available with both GitHub Workflows and Azure DevOps pipelines.
- **Documentation:** Including design principles and usage of [The library](./The%20library) and [The CI environment](./The%20CI%20environment) as well as step-by-step guidelines on how to start leveraging them - see in the [Getting started](./Getting%20started) section.
- **Module library** is a collection of comprehensive, reusable, Bicep-based building blocks to deploy Azure resources. It can also be combined to create & orchestrate more complex, multi-module Azure solutions.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved
- **CI environment** is DevOps pipelines. It can be used to validate modules and to publish modules which are successfully validated to a target location. It uses semantic versioning and it can be used with both GitHub workflows and Azure DevOps pipelines.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved
- **Documentation** including design principles, usage of [The library](./The%20library) and [The CI environment](./The%20CI%20environment). It also includes step-by-step guidelines on how to start utilizing CARML Library. For more details, please refer to [Getting started](./Getting%20started) section.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved

## Out of Scope

- **Orchestration:** Orchestrated, multi-module solutions such as workloads or applications intended for production environments.
- **Real-time Updates:** Modules are updated on a best effort basis by a group of committed contributors.
- **Orchestration:** Orchestrated, multi-module solutions such as workloads or applications intended. As mention earlier, you can use modules to assemble such application /workload deploy workload.
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved
- **Languages:** Other domain-specific languages (DSL), like _Terraform_.


## Module update frequency
Dost2010 marked this conversation as resolved.
Show resolved Hide resolved
Modules are updated by a group of committed contributors.

# Reporting Issues

## Bugs
Expand Down