Installation & uninstall updates - #89
Conversation
…v, & moved breakglass files into a break glass folder
…tallation-and-uninstall installation updates, added uninstall guide, and other improvements
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Warning Review the following alerts detected in dependencies. According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates SHIELD installation, uninstall, Break Glass, navigation, and Microsoft Insights documentation.
Changes:
- Adds general and Deploy-specific uninstall guidance.
- Reorganizes Break Glass documentation and navigation.
- Updates installation content, links, formatting, and the Zensical dependency.
Reviewed changes
Copilot reviewed 6 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Summary |
|---|---|
zensical.toml |
Updates documentation navigation. |
requirements.txt |
Updates the Zensical dependency. |
docs/SHIELD/Reference/Uninstall.md |
Adds general SHIELD cleanup steps. |
docs/SHIELD/Reference/Break-Glass/Register-Break-Glass.md |
Updates Break Glass guidance and wording. |
docs/SHIELD/Reference/Break-Glass/Break-Glass-Overview.md |
Reorganizes and expands Break Glass guidance. |
docs/SHIELD/Prerequisites/Installation.md |
Refreshes installation instructions. |
docs/SHIELD/Deploy/Troubleshooting.md |
Updates the uninstall guide link. |
docs/SHIELD/Deploy/Reference/Uninstall.md |
Adds the Deploy uninstall procedure. |
docs/Microsoft-Insights/Usage-Guide.md |
Adjusts list formatting. |
Suppressed comments (5)
docs/SHIELD/Deploy/Reference/Uninstall.md:17
- This reminder says redeployment will not lose Microsoft cloud data, but the procedure below explicitly removes Entra groups and Intune scope tags. Clarify that redeployment preserves the stateless app only; the SHIELD-managed tenant objects are deleted by this cleanup.
SHIELD's application server is stateless. You can safely redeploy the app after cleanup without losing data stored in the Microsoft cloud (e.g., Intune tags, Entra groups).
docs/SHIELD/Deploy/Reference/Uninstall.md:45
- The script requires PowerShell Core (
#Requires -PSEdition Core) and is documented as tested with PowerShell 7, but this procedure never tells the operator which runtime to use. Running it from Windows PowerShell 5.1 will fail before cleanup starts; call out PowerShell 7 before this step.
1. **Run the uninstall script** to remove SHIELD-deployed infrastructure.
docs/SHIELD/Reference/Break-Glass/Register-Break-Glass.md:17
- “Before preceding with the below” is a typo and makes the warning awkward to follow; it should say “before proceeding with the steps below.”
docs/SHIELD/Reference/Uninstall.md:75 - The introduction promises validation that all applications and groups were removed, but the final checklist only verifies applications and Azure resources. It does not verify the tenant-level groups, Intune scope tags, or Conditional Access policies removed by the linked Deploy uninstall procedure; add those checks or narrow the promise.
- Confirm the SHIELD resource group is fully removed
- Confirm the SHIELD web app no longer exists in Azure App Services
- Confirm the Azure Subscription dedicated for SHIELD has been canceled
- Confirm there are no SHIELD‑related applications in Entra ID
docs/SHIELD/Reference/Uninstall.md:64
- This section says uninstalling SHIELD Desktop is an optional step, but it only lists where the app may be installed and provides no uninstall procedure or link for either a local machine or an Azure VM. Add the platform-specific steps or link to them so readers can complete and verify this part of the decommissioning flow.
If you installed SHIELD using the SHIELD Desktop application, you can uninstall it after SHIELD Discover is complete. SHIELD Desktop is no longer required after reporting is finalized. This applies whether the app was installed on:
- A local machine
- An Azure VM
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
changelog: