Releases: Azure/review-checklists
Releases · Azure/review-checklists
v1.5.2
v1.5.1
Checklist changes:
- WAF checklist is now a 1st-class citizen
- SAP checklist GA
- Security checklist deprecated. Security checks will be integrated in all the other checklists.
Minor enhancements to the spreadsheet:
- WAF checklist in the menu.
- Security checklist removed (WAF to be used instead), as requested by security engineers.
- WAF checklist shows from which checklist each item is coming from.
- Removed AMMP column.
v1.5.0
New features:
- Macro-enabled spreadsheet:
- Telemetry
- Run Graph queries directly from spreadsheet
- Ability to load multiple checklists (WAF)
- Service column
- Auto show/hide columns depending on the checklist
- Check of spreadsheet version on startup
- Link to provide feedback over a new Github issue
- Web UI
- Telemetry
- Other
- Network App Delivery automated workbook
v1.4.1
v1.4.0
New features:
- CSU items merged into the ALZ checklist
- Check ID (format "A00.00"), which is automatically added by the spreadsheet to exported JSON if the column is empty
- AMMP field to shorten ALZ reviews carried out in the Azure Migration and Modernization Program
- WAF pillar field (Well-Architected Framework), so that reviews centered on a specific pillar are easier to execute
- New checklists: ARO, cost optimization, hybrid
- Automatic generation of master checklists (both JSON and Excel)
v1.3.0
New features:
- FTA Branding removed
- LZ name changed to ALZ
topicsfield introduced in the schema (not yet in the checklists)- Checklist state (GA/Preview) in checklist metadata
- Linting checklist correctness:
- GUIDs are unique
- Azure Monitor workbooks
- Automatic generation of workbook code and ARM templates for checklists containing graph queries
- Possibility of generating category-specific workbooks (such as for networking)
- Specific PAT for creation of PRs with automatically created files (translated checklists, macro-free spreadsheets and Azure Monitor workbooks)
- WAF pillar is now included in the JSON and the spreadsheets, so that a review can be done focusing on one or more of the pillars
Checklists supported:
| Checklist | Status | Description |
|---|---|---|
| LZ | GA | Landing Zone design review |
| AKS | GA | Azure Kubernetes Service design review |
| AVD | GA | Azure Virtual Desktop design review |
| Multitenancy | GA | Multitenancy design review |
| Security | Preview | Security review |
| AVS | Preview | Azure VMware Solution design review |
| SAP | Preview | SAP design review |
| APIM | Preview | API Management design review |
| Azure Arc | Preview | Azure Arc design review 🆕 |
| Security | Preview | Security checklists for different products: Azure SQL, ACR, Blob storage |
v1.2.0
This is not the latest release, please access the latest release here.
New features:
- English checklists sorted by github action (still some cosmetic issues to polish, such as the fact that the sorting generates another PR with automatic translations)
- Macro-free Excel spreadsheets generated automatically
Checklists supported:
| Checklist | Status | Description |
|---|---|---|
| LZ | GA | Landing Zone design review |
| AKS | GA | Azure Kubernetes Service design review |
| AVD | GA | Azure Virtual Desktop design review |
| Multitenancy | GA | Multitenancy design review |
| Security | Preview | Security review |
| AVS | Preview | Azure VMware Solution design review |
| SAP | Preview | SAP design review |
| APIM | Preview | API Management design review |
| Security | Preview | Security checklists for different products: Azure SQL, ACR, Blob storage |
Fixed issues:
- Not using an external Github action for translation, but a custom Python script, which gives us better control and will enable using custom translators in the future
New Work In Progress:
- Considering merging multiple checklists to generate area-focused lists (for example for security or resiliency). See script
/scripts/compile_checklist.py
v1.1.0
This is not the latest release, please access the latest release here.
New features:
- Multitenancy checklist.
- Added legend for status values to the checklist.
- Added 'Not required' to the list of status, to document recommendations might be applicable, but not desired/needed.
- Graph query format simplified: only a single query is required instead of two.
- JSON schema added
Checklists supported:
| Checklist | Status | Description |
|---|---|---|
| LZ | GA | Landing Zone design review |
| AKS | GA | Azure Kubernetes Service design review |
| AVD | GA | Azure Virtual Desktop design review |
| Multitenancy | GA | Multitenancy design review |
| Security | Preview | Security review |
| AVS | Preview | Azure VMware Solution design review |
Fixed issues:
- Checklist load time optimized, now it takes under 10 seconds
- Simplified mechanism to onboard checklists to the spreadsheet (adding them to the Values worksheet is enough, no coding required)
- Translation action does not break the JSON structure any more
New Work In Progress:
- Web UI for self-consumption: https://aka.ms/ftaaas. See our sister repo https://github.com/Azure/fta-aas for more information and the source code.
- Python scripts (in
scriptsfolder) using xlwings/openpyxl to create/update Excel spreadsheets with either Graph query results or the latest checklist. This would enable the following:- Macro-free Excel spreadsheets
- Support for Mac OS X (through macro-free spreadsheets)
v1.0.0
The Azure Review checklist framework goes GA!
Additional functionality in this release:
- AVS checklist (preview)
- Landing Zone review areas aligned to ESLZ critical design areas
- Excel spreadsheet technology/language selector modified to dropdown lists
- Initial bicep modules for the deployment of the MVP UI
- ARM template to deploy Azure Container Instances modified to deploy each container in its own container group, so that each function can be re-run independently from each other
v0.9.0
Added new features:
- Support to store graph queries for each checklist item, added initial queries to LZ and AKS checklists
- Added prototype for a customer deployment using a MySQL backend and Azure Container Instances
checklist_graph.shscript that can be used to run the graph queries and generate JSON files that can be imported by the spreadsheet- New fields in the checklist items:
- Learning material
- Description
- Changed spreadsheet format:
- Migrated spreadsheet selection from option buttons to dropdowns
- Added separation lines
- Radar chart added to dashboard of sample spreadsheet
Known issues: