Skip to content

Commit

Permalink
Context updates (#3501)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderSehr authored Aug 4, 2023
1 parent 1569594 commit a05a34e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/wiki/Solution creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are several open-source repositories that leverage the CARML library today
| - | - |
| [AVD Accelerator](https://github.com/Azure/avdaccelerator) | AVD Accelerator deployment automation to simplify the setup of AVD (Azure Virtual Desktop) |
| [AKS Baseline Automation](https://github.com/Azure/aks-baseline-automation) | Repository for the AKS Landing Zone Accelerator program's Automation reference implementation |
| [DevOps Self-Hosted](https://github.com/Azure/DevOps-Self-Hosted) | - Create & maintain images with a pipeline using the Azure Image Builder service <p> - Deploy & maintain Azure DevOps Self-Hosted agent pools with a pipeline using Virtual Machine Scale Set|
| [DevOps Self-Hosted](https://github.com/Azure/DevOps-Self-Hosted) | - Create & maintain images with a pipeline using the Azure Image Builder service <p> - Deploy & maintain Azure DevOps Self-Hosted agent pools with a pipeline using Virtual Machine Scale Set |

# Orchestration overview

Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/The context - CARML CI environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The top row represents your orchestration environment, for example, _GitHub_ or
From left to right, there are the three phases introduced before, _Develop modules_, _Publish modules_ & _Consume modules_. The diagram shows how each phase interacts with the Azure environment.

1. Starting with **Develop modules**, the top left box shows the test pipelines that exist for each module, performing the following steps:
- _Static validation_: Pester tests are run on each module to ensure a baseline code quality across the library.
- _Static validation_: Pester & PSRule tests are run on each module to ensure a baseline code quality across the library.
- _Deployment validation_: An actual Azure deployment is performed in a validation/sandbox subscription, shown in the bottom left corner. The subscription is intended to be without any link to production. Resources deployed here should be considered temporary and be removed after testing.
- _Publishing_: Runs only if the previous steps are successful and initiates the second phase as described below.

Expand Down
4 changes: 3 additions & 1 deletion docs/wiki/The context - Logical layers and personas.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ This persona isn't consuming CARML directly, but is consuming CARML via a soluti
- Existing CARML solutions (These links provide examples of real world solutions using CARML):
- [AKS Landing Zone Accelerator](https://github.com/Azure/AKS-Landing-Zone-Accelerator)
- [AVD Landing Zone Accelerator](https://github.com/Azure/avdaccelerator)
- [DevOps Self-Hosted](https://github.com/Azure/DevOps-Self-Hosted)

- An internally developed multi-module solution for internal application or workload pattern

> **Note**: Solution Consumers are not to be confused with end users. Solution Consumers are cloud administrators, deploying a complex solution and administering an application installed into such a cloud environment. An end user is someone who will use the application or workload hosted in the cloud for his/her work (ex., information worker or application developer).
Expand All @@ -70,7 +72,7 @@ This persona isn't consuming CARML directly, but is consuming CARML via a soluti

![SolutionDevelopers](./media/Personas/SolutionDevelopers.png)

A **Solution Developer** is not a user. Their focus is on using CARML to **build end-to-end solutions** that are opinionated. These solutions will be published (publicly and/or privately) for consumption by others and will be used many times by many organizations/teams, in many environments/subscriptions/landing zones).
A **Solution Developer** is not a user. Their focus is on using CARML to **build end-to-end solutions** that are opinionated. These solutions will be published (publicly and/or privately) for consumption by others and will be used many times by many organizations/teams, in many environments/subscriptions/landing zones.
A Solution Developer uses the CARML library (its public or organization/customer specific implementation), with a chosen preference for using its modules via Bicep registry (public, private), or template specs, or direct reference, or using Git submodules, etc. Solution Developers might benefit the most from overcoming the learning curve - because of the standardization and scale they can achieve with CARML.

- Modules: Use an existing code base to develop and test multi-module solutions (ex., a Landing Zone Accelerator, or an internal platform/workload team). This might also lead to creating/updating modules.
Expand Down

0 comments on commit a05a34e

Please sign in to comment.