PSDocs
Generate documentation from Infrastructure as Code (IaC). (by microsoft)
ResourceModules
This repository includes a CI platform for and collection of mature and curated Bicep modules. The platform supports both ARM and Bicep and can be leveraged using GitHub actions as well as Azure DevOps pipelines. (by Azure)
PSDocs | ResourceModules | |
---|---|---|
1 | 12 | |
133 | 719 | |
-1.5% | 0.6% | |
4.6 | 9.5 | |
3 months ago | 28 days ago | |
C# | Bicep | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
PSDocs
Posts with mentions or reviews of PSDocs.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-02-24.
-
Anyone using ACR Repository for Bicep Modules with ADO?
For Pull Requests, it compiles bicep into ARM templates and runs PSDocs for them an accompaying json file that holds versioning information and, document title and some additional information. Then it looks for ./test/module.test.bicep -file (which is just a copy of a suitable test suite from ResourceModules) and runs psrule against that. For runs triggered from main-branch, it queues the module publishing pipeline for every changed module.bicep found.
ResourceModules
Posts with mentions or reviews of ResourceModules.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-03-17.
-
How do you design IaC modules and automations?
That is a great question, and not the least because it's the one I've been struggling with for the past few years. As for Azure and Bicep, we tried out a few things until we found out about the Common Azure Resource Modules Library (https://github.com/Azure/ResourceModules) and started experimenting on how to leverage that. Wheter you find such modules useful or not, I would suggest taking a look at the module design principles they have (https://github.com/Azure/ResourceModules/wiki/The%20context%20-%20CARML%20library), which I've found to be great.
- How does Microsoft update the README.md of a specific module in GitHub?
- In GitHub, how does Microsoft automatically update the README.md of a respective module?
- How does Microsoft update their README.md
-
How are you splitting out your IaC pipelines?
In general resource group is lifecycle and deployment boundary. So your Bicep or ARM templates should deploy resource groups with all resources included. To make it easier you can use resource modules from https://github.com/Azure/ResourceModules.
- Anyone using ACR Repository for Bicep Modules with ADO?
-
Devops Pipeline + Bicep - Advice on how to structure
For modularized Bicep, I'd suggest you to take a look at Common Azure Resource Modules Library - probably not much of an use right now if you have implemented everything, but could be of use if you feel like refactoring something. I wouldn't suggest it as an example on how to do custom bicep implementation, but one can certainly take some inspiration from there, if not directly using the modules.
-
ARM / Bicep template development just by hand?
What I found is that using the Resource Modules (https://github.com/Azure/ResourceModules) repo is the best approach. It simplifies the authoring quite a lot in my opinion. And every module on the repo is bicep. But since the modules are created by Microsoft/the community, not every resource or service has a ready module. I have been using it for the last 6-8 months, and find it covers 90% of my scenarios. And each module is quite well documented, but in some cases you have to study the module to figure out the required inputs.
-
How to structure code repositories
We don't have a team in place to update and maintain modules so that's where my thought about CARML comes into the picture. Unsure how this is maintained though and how to update the modules, and i think it makes it more complex and hard to understand for people unfamiliar with IaC.
- Bicep templates
What are some alternatives?
When comparing PSDocs and ResourceModules you can also consider the following projects:
PSBicep - This is the repo for the Bicep PowerShell Module.
opnazure - This template allows you to deploy an OPNsense Firewall Azure VM using the opnsense-bootsrtap installation method