-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added known issues wiki * Update wording for known issues * Fix lint errors
- Loading branch information
Showing
3 changed files
with
116 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <!-- markdownlint-disable --> | ||
| ## Known Issues | ||
| <!-- markdownlint-restore --> | ||
|
|
||
| This page lists the known issues and limitations currently present in ALZ-Bicep. Please review these before using the repository to understand any potential challenges or constraints. | ||
|
|
||
| ## Issue 1: What-If Check Fails within Azure DevOps Pipeline/GitHub Actions Workflow with the error: `Additional content found in JSON reference object. A JSON reference object should only have a $ref property. Path 'parResourceLockConfig.defaultValue'` | ||
|
|
||
| - **Description:** There is a bug with the Azure PowerShell Module version 11.3.1 where the default JSON serializer used to read Bicep output treats `$ref` properties as a JSON reference, whereas the desired behavior is to preserve it in the serialized JSON. We do specify within our workflows/pipelines to use the latest version of Az module within each relevant task/action. However, the "latest" version correlates to the latest version installed on the particular agent/runner, which is 11.3.1 at this time. | ||
| - **Impact:** All What-If checks/operations fail within Azure DevOps Pipeline/GitHub Actions Workflows | ||
| - **Workaround:** To mitigate this issue until the agents have the updated Az version installed, you can explicitly reference a particular Az version for each PowerShell task/action. For example: | ||
| Azure DevOps Workaround: | ||
|
|
||
| ```yaml | ||
| - task: AzurePowerShell@5 | ||
| displayName: "Logging and Sentinel Deployment" | ||
| inputs: | ||
| azureSubscription: ${{ variables.SERVICE_CONNECTION_NAME }} | ||
| azurePowerShellVersion: "11.3.0" | ||
| pwsh: true | ||
| ScriptType: "InlineScript" | ||
| Inline: | | ||
| .\pipeline-scripts\Deploy-ALZLoggingAndSentinel.ps1 | ||
| ``` | ||
| GitHub Actions Workaround: | ||
| ```yaml | ||
| - name: "Logging and Sentinel Deployment" | ||
| uses: azure/powershell@v1 | ||
| with: | ||
| inlineScript: | | ||
| .\pipeline-scripts\Deploy-ALZLoggingAndSentinel.ps1 | ||
| azPSVersion: "11.3.0" | ||
| ``` | ||
| - **Status:** As our team doesn't directly own the impacted module or have control over the agents/runners, we aim to enhance flexibility to assist with such issues in the future. To achieve this, we plan to introduce a variable in the .env file, enabling version control without the need for individual additions. | ||
| ## How to Report an Issue | ||
| If you encounter an issue not listed here that would be helpful to be included or have additional information to provide, please open a [new issue](https://github.com/Azure/ALZ-Bicep/issues/new?assignees=&labels=bug&projects=&template=bug-report-issue-form.yaml&title=%5BPLACEHOLDER%5D+-+Place+a+descriptive+title+here) in the GitHub repository's issue tracker. Be sure to include detailed steps to reproduce the issue and any relevant context or screenshots. | ||
| We appreciate your help in improving ALZ-Bicep by reporting issues and providing feedback. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,22 @@ | ||
| # Wiki Navigation | ||
|
|
||
| * [Wiki Home](https://github.com/Azure/ALZ-Bicep/wiki/Home) | ||
| * [Deployment Flow](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow) | ||
| * [Network Topology: Hub and Spoke](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlowHS) | ||
| * [Network Topology: Virtual WAN](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlowVWAN) | ||
| * [Zero Trust Networking Guide: Hub and Spoke](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentGuideHSZT) | ||
| * [Consumer Guide](https://github.com/Azure/ALZ-Bicep/wiki/ConsumerGuide) | ||
| * [Accelerator](https://github.com/Azure/ALZ-Bicep/wiki/Accelerator) | ||
| * [How Does ALZ-Bicep Implement Azure Policies?](https://github.com/Azure/ALZ-Bicep/wiki/PolicyDeepDive) | ||
| * [Adding Custom Azure Policy Definitions](https://github.com/Azure/ALZ-Bicep/wiki/AddingPolicyDefs) | ||
| * [Assigning Azure Policies](https://github.com/Azure/ALZ-Bicep/wiki/AssigningPolicies) | ||
| * [How Does ALZ-Bicep Implement resilient deployments across availability zones?](https://github.com/Azure/ALZ-Bicep/wiki/Resiliency) | ||
| * [Contributing](https://github.com/Azure/ALZ-Bicep/wiki/Contributing) | ||
| * [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/ALZ-Bicep/wiki/CustomerUsage) | ||
| * [Azure Container Registry Deployment - Private Bicep Registry](https://github.com/Azure/ALZ-Bicep/wiki/ACRDeployment) | ||
| * [Frequently Asked Questions](https://github.com/Azure/ALZ-Bicep/wiki/FAQ) | ||
| * [Sample Pipelines](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesOverview) | ||
| * [GitHub Actions](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesGitHub) | ||
| * [Azure DevOps](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesADO) | ||
| * [Code tours](https://github.com/Azure/ALZ-Bicep/wiki/CodeTour) | ||
| - [Wiki Home](https://github.com/Azure/ALZ-Bicep/wiki/Home) | ||
| - [Deployment Flow](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow) | ||
| - [Network Topology: Hub and Spoke](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlowHS) | ||
| - [Network Topology: Virtual WAN](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlowVWAN) | ||
| - [Zero Trust Networking Guide: Hub and Spoke](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentGuideHSZT) | ||
| - [Consumer Guide](https://github.com/Azure/ALZ-Bicep/wiki/ConsumerGuide) | ||
| - [Accelerator](https://github.com/Azure/ALZ-Bicep/wiki/Accelerator) | ||
| - [Known Issues](https://github.com/Azure/ALZ-Bicep/wiki/KnownIssues) | ||
| - [Frequently Asked Questions](https://github.com/Azure/ALZ-Bicep/wiki/FAQ) | ||
| - [How Does ALZ-Bicep Implement Azure Policies?](https://github.com/Azure/ALZ-Bicep/wiki/PolicyDeepDive) | ||
| - [Adding Custom Azure Policy Definitions](https://github.com/Azure/ALZ-Bicep/wiki/AddingPolicyDefs) | ||
| - [Assigning Azure Policies](https://github.com/Azure/ALZ-Bicep/wiki/AssigningPolicies) | ||
| - [How Does ALZ-Bicep Implement resilient deployments across availability zones?](https://github.com/Azure/ALZ-Bicep/wiki/Resiliency) | ||
| - [Contributing](https://github.com/Azure/ALZ-Bicep/wiki/Contributing) | ||
| - [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/ALZ-Bicep/wiki/CustomerUsage) | ||
| - [Azure Container Registry Deployment - Private Bicep Registry](https://github.com/Azure/ALZ-Bicep/wiki/ACRDeployment) | ||
| - [Sample Pipelines](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesOverview) | ||
| - [GitHub Actions](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesGitHub) | ||
| - [Azure DevOps](https://github.com/Azure/ALZ-Bicep/wiki/PipelinesADO) | ||
| - [Code tours](https://github.com/Azure/ALZ-Bicep/wiki/CodeTour) |