зеркало из https://github.com/Azure/ALZ-Bicep.git
* add aes shows * update FAQ * Updates * update the code snippet * add images locally * change readme for linting * add aac * test remove space * changes * update indent * update linter * unneeded
This commit is contained in:
Jack Tracey
GitHub
Родитель
8b58833783
Коммит
ef5b9a99fc
|
|
@ -28,6 +28,7 @@ MD026:
|
|||
MD029: false # Ordered list item prefix
|
||||
MD033: false # Allow inline HTML
|
||||
MD036: false # Emphasis used instead of a heading
|
||||
MD053: false # Super Linter broke this in v4.9.5
|
||||
|
||||
#################
|
||||
# Rules by tags #
|
||||
|
|
|
|||
35
README.md
35
README.md
|
|
@ -27,20 +27,41 @@ Detailed information about how to use, deploy and extend artifacts found in this
|
|||
- [Azure DevOps][wiki_pipelines_ado]
|
||||
- [Code Tours][code_tours]
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
The Azure Landing Zones Bicep repo provides an approach for deploying and managing the core platform capabilities of Cloud Adoption Framework Azure Landing Zones conceptual architecture using Bicep.
|
||||
|
||||
In its current incarnation each module can be deployed separately via command line but in future releases a more automated approach, via orchestration modules, will be published; but due to current Bicep & ARM limitations this is not possible today.
|
||||
|
||||
> Have you seen our page in the Azure Architecture Center here: [Azure landing zones - Bicep modules design considerations][aac_article]
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with ALZ Bicep, please refer to the [Deployment Flow wiki page][wiki_deployment_flow] for:
|
||||
|
||||
1. Prerequisites and dependencies for the overall implementation.
|
||||
2. High-level deployment flow.
|
||||
3. Links to more detailed instructions on individual modules.
|
||||
|
||||
### Azure Enablement Show Videos
|
||||
|
||||
We have created a short 3-part series of video on the Azure Enablement Show that can be found below:
|
||||
|
||||
<!-- markdownlint-disable -->
|
||||
#### Part 1 - Introduction to Azure Landing Zones Bicep
|
||||
|
||||
[](https://aka.ms/azenable/94)
|
||||
|
||||
#### Part 2 - Azure Landing Zones Bicep - Enabling platform services
|
||||
|
||||
[](https://aka.ms/azenable/95)
|
||||
|
||||
#### Part 3 - Azure Landing Zones Bicep - Enabling landing zones
|
||||
|
||||
[](https://aka.ms/azenable/96)
|
||||
<!-- markdownlint-restore -->
|
||||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Please review our [Contributing guide][wiki_contributing] in the Wiki. Once your PR is created and submitted a member of the team will triage, review and discuss with you 👍
|
||||
Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
|
|
@ -53,6 +74,7 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
|
|||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
## Telemetry
|
||||
|
||||
When you deploy one or more modules in Azure Landing Zones Bicep repo, Microsoft can identify the installation of said module/s with the deployed Azure resources. Microsoft can correlate these resources used to support the software. Microsoft collects this information to provide the best experiences with their products and to operate their business. The telemetry is collected through customer usage attribution. The data is collected and governed by [Microsoft's privacy policies](https://www.microsoft.com/trustcenter).
|
||||
|
||||
If you don't wish to send usage data to Microsoft, details on how to turn it off can be found [here][wiki_cuaid].
|
||||
|
|
@ -61,7 +83,7 @@ If you don't wish to send usage data to Microsoft, details on how to turn it off
|
|||
|
||||
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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
||||
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
|
||||
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.
|
||||
|
||||
|
|
@ -73,18 +95,10 @@ If you believe you have found a security vulnerability in this repository, pleas
|
|||
|
||||
For support on the artifacts contained in this repository, please refer to [this guide][support_statement] for more details.
|
||||
|
||||
|
||||
|
||||
|
||||
[//]: # (************************)
|
||||
[//]: # (INSERT LINK LABELS BELOW)
|
||||
[//]: # (************************)
|
||||
|
||||
<!--
|
||||
The following link references should be copied from `_sidebar.md` in the `./docs/wiki/` folder.
|
||||
Replace `./` with `https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/` when copying to here.
|
||||
-->
|
||||
|
||||
[wiki_home]: https://github.com/Azure/ALZ-Bicep/wiki/home "Wiki - Home"
|
||||
[wiki_deployment_flow]: https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow "Wiki - Deployment Flow"
|
||||
[wiki_deployment_flow_hs]: https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlowHS "Wiki - Deployment Flow - Hub and Spoke"
|
||||
|
|
@ -103,3 +117,4 @@ Replace `./` with `https://github.com/Azure/terraform-azurerm-caf-enterprise-sca
|
|||
[wiki_pipelines_gh]: https://github.com/Azure/ALZ-Bicep/wiki/PipelinesGitHub "Wiki - Sample Pipelines - GitHub Actions"
|
||||
[wiki_pipelines_ado]: https://github.com/Azure/ALZ-Bicep/wiki/PipelinesADO "Wiki - Sample Pipelines - Azure DevOps"
|
||||
[code_tours]: https://github.com/Azure/ALZ-Bicep/wiki/CodeTour "Wiki - Code tours"
|
||||
[aac_article]: https://docs.microsoft.com/azure/architecture/landing-zones/bicep/landing-zone-bicep "Azure Architecture Center - Azure landing zones - Bicep modules design considerations"
|
||||
|
|
|
|||
|
|
@ -4,6 +4,25 @@
|
|||
|
||||
This document outlines the prerequisites, dependencies and flow to help orchestrate an end-to-end Azure Landing Zone deployment. The orchestration templates provided with this reference implementation have been pre-configured to follow the dependencies described in this document.
|
||||
|
||||
> Have you seen our page in the Azure Architecture Center here: [Azure landing zones - Bicep modules design considerations](https://docs.microsoft.com/azure/architecture/landing-zones/bicep/landing-zone-bicep)
|
||||
|
||||
## Azure Enablement Show Videos
|
||||
|
||||
We have created a short 3-part series of video on the Azure Enablement Show that can be found below:
|
||||
<!-- markdownlint-disable -->
|
||||
### Part 1 - Introduction to Azure Landing Zones Bicep
|
||||
|
||||
[](https://aka.ms/azenable/94)
|
||||
|
||||
### Part 2 - Azure Landing Zones Bicep - Enabling platform services
|
||||
|
||||
[](https://aka.ms/azenable/95)
|
||||
|
||||
### Part 3 - Azure Landing Zones Bicep - Enabling landing zones
|
||||
|
||||
[](https://aka.ms/azenable/96)
|
||||
<!-- markdownlint-restore -->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Azure Active Directory Tenant.
|
||||
|
|
|
|||
|
|
@ -46,3 +46,31 @@ In some of the ALZ-Bicep modules some of linter rules are disabled using the `#d
|
|||
You may also see it in some location for resources that do not require a region for deployment, like Azure Policies, so instead of making users input an additional parameter for the region, we just use the one that was targeted by the deployment to ARM when the module was deployed.
|
||||
|
||||
It is not recommended to disable linter rules when it can be resolved by making changes to the Bicep code. However, in some scenarios, like above, this is necessary.
|
||||
|
||||
## Why do I see an error similar to `Cannot retrieve the dynamic parameters for the cmdlet` when running `bicep build` or trying to deploy a module?
|
||||
|
||||
This is normally due to the release version you are using of `ALZ-Bicep` was built using the latest available Bicep features from the latest [Bicep release](https://github.com/Azure/bicep/releases).
|
||||
|
||||
An example of the error or something similar you may see is shown below:
|
||||
|
||||
```powershell
|
||||
VERBOSE: Using Bicep v0.5.6
|
||||
New-AzManagementGroupDeployment: Cannot retrieve the dynamic parameters for the cmdlet. C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(448,31) : Error BCP062: The referenced declaration with name "varPolicySetDefinitionEsDenyPublicpaasendpointsParameters" is not valid.
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(453,31) : Error BCP062: The referenced declaration with name "varPolicySetDefinitionEsDenyPublicpaasendpointsParameters" is not valid.
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(458,31) : Error BCP062: The referenced declaration with name "varPolicySetDefinitionEsDenyPublicpaasendpointsParameters" is not valid.
|
||||
...
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(504,31) : Error BCP062: The referenced declaration with name "varPolicySetDefinitionEsDeployDiagnosticsLoganalyticsParameters" is not valid.
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(509,31) : Error BCP062: The referenced declaration with name "varPolicySetDefinitionEsDeployDiagnosticsLoganalyticsParameters" is not valid.
|
||||
...
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(1222,65) : Error BCP082: The name "loadJsonContent" does not exist in the current context. Did you mean "loadTextContent"?
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(1224,71) : Error BCP082: The name "loadJsonContent" does not exist in the current context. Did you mean "loadTextContent"?
|
||||
...
|
||||
C:\Source\ALZ-Bicep\infra-as-code\bicep\modules\policy\definitions\customPolicyDefinitions.bicep(1252,112) : Error BCP062: The referenced declaration with name "varCustomPolicySetDefinitionsArray" is not valid.
|
||||
C:\Source\ALZ-Bicep\policyDefinitions.bicep(3,15) : Error BCP104: The referenced module has errors.
|
||||
```
|
||||
|
||||
You'll note that the error message above is stating it is using Bicep `v0.5.6` however, the `loadJsonContent` is available in `v0.7.4` and later.
|
||||
|
||||
So to fix this issue all you need to do is update the version of Bicep to the [latest release](https://github.com/Azure/bicep/releases) or follow the installation instructions here: [Install Bicep tools](https://docs.microsoft.com/azure/azure-resource-manager/bicep/install)
|
||||
|
||||
Then just re-run the deployment or `bicep build` and you should see success 👍🥳
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@ Welcome to the wiki of the Azure Landing Zones Bicep repo. This repo contains th
|
|||
|
||||
Artefacts like policies etc. are pulled down from the [`Azure/Enterprise-Scale` repo](https://github.com/Azure/Enterprise-Scale) to ensure the choice of tooling to implement the architecture, produce the same outputs.
|
||||
|
||||
> Have you seen our page in the Azure Architecture Center here: [Azure landing zones - Bicep modules design considerations][aac_article]
|
||||
|
||||
## Navigation
|
||||
|
||||
* [Wiki Home][wiki_home]
|
||||
|
|
@ -27,6 +29,26 @@ Artefacts like policies etc. are pulled down from the [`Azure/Enterprise-Scale`
|
|||
* [Azure DevOps][wiki_pipelines_ado]
|
||||
* [Code Tours][code_tours]
|
||||
|
||||
## Azure Enablement Show Videos
|
||||
|
||||
We have created a short 3-part series of video on the Azure Enablement Show that can be found below:
|
||||
<!-- markdownlint-disable -->
|
||||
### Part 1 - Introduction to Azure Landing Zones Bicep
|
||||
|
||||
[](https://aka.ms/azenable/94)
|
||||
|
||||
### Part 2 - Azure Landing Zones Bicep - Enabling platform services
|
||||
|
||||
[](https://aka.ms/azenable/95)
|
||||
|
||||
### Part 3 - Azure Landing Zones Bicep - Enabling landing zones
|
||||
|
||||
[](https://aka.ms/azenable/96)
|
||||
<!-- markdownlint-restore -->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[//]: # (************************)
|
||||
[//]: # (INSERT LINK LABELS BELOW)
|
||||
|
|
@ -53,3 +75,8 @@ Replace `./` with `https://github.com/Azure/ALZ-Bicep/wiki/` when copying to her
|
|||
[wiki_pipelines_gh]: https://github.com/Azure/ALZ-Bicep/wiki/PipelinesGitHub "Wiki - Sample Pipelines - GitHub Actions"
|
||||
[wiki_pipelines_ado]: https://github.com/Azure/ALZ-Bicep/wiki/PipelinesADO "Wiki - Sample Pipelines - Azure DevOps"
|
||||
[code_tours]: https://github.com/Azure/ALZ-Bicep/wiki/CodeTour "Wiki - Code tours"
|
||||
[aes_part_1]: https://aka.ms/azenable/94 "Part 1 - Introduction to Azure Landing Zones Bicep"
|
||||
[aes_part_2]: https://aka.ms/azenable/95 "Part 2 - Enabling platform services"
|
||||
[aes_part_3]: https://aka.ms/azenable/96 "Part 3 - Enabling landing zones"
|
||||
[aac_article]: https://docs.microsoft.com/azure/architecture/landing-zones/bicep/landing-zone-bicep "Azure Architecture Center - Azure landing zones - Bicep modules design considerations"
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче