-
Notifications
You must be signed in to change notification settings - Fork 0
Installation & uninstall updates #89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
2d55c4b
Update Zensical
elliot-huffman b3f68a1
updated installation guide, added an uninstall guide, updated left na…
jtdauria-shi 47f80cb
updates-based-on-copilot-suggestions
jtdauria-shi 9a80390
Merge pull request #87 from Software-Hardware-Integration-Lab/jtd/ins…
pasha-zayko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,79 @@ | ||
| # Uninstall | ||
|
|
||
| This section covers how to uninstall or reset SHIELD's Deploy module infrastructure and outlines common considerations for support and recovery scenarios. | ||
|
|
||
| --- | ||
|
|
||
| ## Uninstalling SHIELD Deploy Infrastructure | ||
|
|
||
| The SHIELD platform uses multiple Microsoft 365 services to create configuration components. Removing these components manually is complex and can break your tenant setup. Use the provided uninstall script only if directed by SHI support. | ||
|
|
||
| !!! danger "Data Loss Warning" | ||
|
|
||
| If you uninstall the architecture, **you will clear out any managed objects and configurations** deployed by the Deploy module. This procedure should only be followed if SHI explicitly instructs you to do so. | ||
|
|
||
| !!! note "Stateless Server Reminder" | ||
|
|
||
| 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). | ||
|
|
||
| --- | ||
|
|
||
| ## Uninstall Procedure | ||
|
|
||
| 1. **Stop the SHIELD server** to prevent regeneration of infrastructure during cleanup. | ||
|
|
||
| 2. **Download the uninstall script**: | ||
|
|
||
| 📥 [Uninstall-ShieldArchitecture.ps1](../../Scripts/Uninstall-ShieldArchitecture.ps1) | ||
|
|
||
| 1. **Remove all Microsoft.Graph modules** to prevent version conflicts: | ||
|
|
||
| ```powershell | ||
| Get-Module -Name '*Microsoft.Graph*' -ListAvailable | Uninstall-Module | ||
| ``` | ||
|
|
||
| !!! note | ||
|
|
||
| You may have to run the above command twice because the order of operations tries to uninstall a dependency first rather than last. Running it the second time will remove the remaining dependency. | ||
|
|
||
| 1. **Install the correct version of Microsoft Graph Beta modules**: | ||
|
|
||
| ```powershell | ||
| Install-Module -Name 'Microsoft.Graph.Beta' -RequiredVersion '2.1.0' -Scope 'AllUsers' | ||
| ``` | ||
|
|
||
| 1. **Run the uninstall script** to remove SHIELD-deployed infrastructure. | ||
|
|
||
| The script is designed to remove: | ||
| - Entra ID groups and admin units | ||
| - Intune scope tags | ||
| - Conditional Access policies created by SHIELD | ||
|
|
||
| It does **not** delete data outside the SHIELD-deployed infrastructure. | ||
|
|
||
| --- | ||
|
|
||
| ## FAQs & Recovery Notes | ||
|
|
||
| ### What if the uninstall script fails? | ||
|
|
||
| Try re-running the script. It is designed to be idempotent and will retry safely. Make sure you have proper permissions and the correct PowerShell modules installed. | ||
|
|
||
| ### Can I re-deploy SHIELD after uninstalling? | ||
|
|
||
| Yes. SHIELD can be redeployed using the same app interface or script, as long as all infrastructure components have been successfully removed. | ||
|
|
||
| ### What is not removed? | ||
|
|
||
| - Audit logs in Entra ID | ||
| - Device enrollment history | ||
| - Local device configurations if not managed via Intune | ||
|
|
||
| --- | ||
|
|
||
| ## Related Pages | ||
|
|
||
| - [Deploy Overview](../../Deploy/) | ||
| - [Deploy Usage Guide](../../Deploy/Usage-Guide) | ||
| - [Deployment](../../Deploy/Deployment/) | ||
| - [Deploy Reference](../../Deploy/Reference/) | ||
This file contains hidden or 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 hidden or 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
File renamed without changes.
This file contains hidden or 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 hidden or 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,76 +1,76 @@ | ||
| # Uninstall | ||
| # How to Uninstall SHIELD | ||
|
|
||
| This section covers how to uninstall or reset SHIELD's Deploy module infrastructure and outlines common considerations for support and recovery scenarios. | ||
| This guide explains how to fully decommission SHIELD to stop accruing the associated costs. The process involves three steps and an optional step to uninstall SHIELD Desktop. Once you're finished, validate that all the applications and groups have been removed. | ||
|
|
||
| --- | ||
|
|
||
| ## Uninstalling SHIELD Deploy Infrastructure | ||
|
|
||
| The SHIELD platform uses multiple Microsoft 365 services to create configuration components. Removing these components manually is complex and can break your tenant setup. Use the provided uninstall script only if directed by SHI support. | ||
|
|
||
| !!! danger "Data Loss Warning" | ||
| If you uninstall the architecture, **you will clear out any managed objects and configurations** deployed by the Deploy module. This procedure should only be followed if SHI explicitly instructs you to do so. | ||
|
|
||
| !!! note "Stateless Server Reminder" | ||
| 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). | ||
| !!! note | ||
|
|
||
| To remove Entra groups, Intune scope tags, and Conditional Access policies created by SHIELD, see the SHIELD Deploy [Uninstall Procedure](../Deploy/Reference/Uninstall#uninstall-procedure). | ||
| --- | ||
|
|
||
| ## Uninstall Procedure | ||
|
|
||
| 1. **Stop the SHIELD server** to prevent regeneration of infrastructure during cleanup. | ||
| ## Step 1: Delete the Azure Resource Group Used for SHIELD | ||
|
|
||
| 2. **Download the uninstall script**: | ||
| The first decommissioning step is to remove the Azure Resource Group associated with SHIELD. | ||
|
|
||
| 📥 [Uninstall-ShieldArchitecture.ps1](../Scripts/Uninstall-ShieldArchitecture.ps1) | ||
| 1. Sign in to your Azure portal. | ||
| - **Enterprise**: [https://portal.azure.com/](https://portal.azure.com/){:target="_blank"} | ||
| - **Government**: [https://portal.azure.us/](https://portal.azure.us/){:target="_blank"} | ||
| 2. Navigate to Subscriptions and select the subscription dedicated to SHIELD. | ||
| 3. Click **Resource groups** in the left navigation bar. | ||
| 4. Click on the Azure Resource group created for SHIELD (e.g., **SHIELD**). | ||
| 5. Click **Delete resource group** at the top of the table and proceed with the deletion process. | ||
|
|
||
| 3. **Remove all Microsoft.Graph modules** to prevent version conflicts: | ||
| **This removes**: | ||
|
|
||
| ```powershell | ||
| Get-Module -Name '*Microsoft.Graph*' -ListAvailable | Uninstall-Module | ||
| ``` | ||
| - The **SHIELD Azure App Service** (web app) | ||
| - Associated storage, compute, and networking resources | ||
|
|
||
| !!! note | ||
| You may have to run the above command twice because the order of operations tries to uninstall a dependency first rather than last. Running it the second time will remove the remaining dependency. | ||
|
|
||
| 1. **Install the correct version of Microsoft Graph Beta modules**: | ||
|
|
||
| ```powershell | ||
| Install-Module -Name 'Microsoft.Graph.Beta' -RequiredVersion '2.1.0' -Scope 'AllUsers' | ||
| ``` | ||
| --- | ||
|
|
||
| 2. **Run the uninstall script** to remove SHIELD-deployed infrastructure. | ||
| ## Step 2: Cancel the Azure Subscription | ||
|
|
||
| The script is designed to remove: | ||
| - Entra ID groups and admin units | ||
| - Intune scope tags | ||
| - Conditional Access policies created by SHIELD | ||
| Once the resource group is removed, the next step is to remove the Azure subscription used for SHIELD. If SHIELD was deployed in its own dedicated Azure subscription, you can go ahead and remove it. If it is running in a shared subscription, this step can be skipped. | ||
|
|
||
| It does **not** delete data outside the SHIELD-deployed infrastructure. | ||
| 1. Sign in to your Azure portal. | ||
| - **Enterprise**: [https://portal.azure.com/](https://portal.azure.com/){:target="_blank"} | ||
| - **Government**: [https://portal.azure.us/](https://portal.azure.us/){:target="_blank"} | ||
| 2. Navigate to **Subscriptions** and select the subscription dedicated to SHIELD. | ||
| 3. Click **Cancel subscription** at the top of the table and proceed with the cancelation process. | ||
|
|
||
| --- | ||
|
|
||
| ## FAQs & Recovery Notes | ||
| ## Step 3: Delete SHIELD Identity Objects in Entra ID | ||
|
|
||
| ### What if the uninstall script fails? | ||
| After Azure resources are removed, you will need to remove a few identity objects. These objects are created as part of the SHIELD installation process and should be removed to fully decommission access. | ||
|
|
||
| Try re-running the script. It is designed to be idempotent and will retry safely. Make sure you have proper permissions and the correct PowerShell modules installed. | ||
| 1. Sign in to your Entra ID admin center. | ||
| - **Enterprise**: [https://entra.microsoft.com/](https://entra.microsoft.com/){:target="_blank"} | ||
| - **Government**: [https://entra.microsoft.us/](https://entra.microsoft.us/){:target="_blank"} | ||
| 2. Navigate to **Enterprise apps** in the navigation bar. | ||
| 3. Click on the name of the application you wish to delete. You can use the search bar if needed. You will need to delete the following applications: | ||
| - **SHIELD - End User Login** | ||
|
jtdauria-shi marked this conversation as resolved.
|
||
| - **SHIELD - Desktop** | ||
| - **SHI - Data Gateway** | ||
|
jtdauria-shi marked this conversation as resolved.
|
||
| 4. Click **Properties** in the left navigation bar. | ||
| 5. Click the **Delete** button at the bottom and proceed with the deletion process. | ||
| 6. Repeat steps 2-5 until you have deleted all the applications. | ||
|
|
||
| ### Can I re-deploy SHIELD after uninstalling? | ||
| --- | ||
|
|
||
| Yes. SHIELD can be redeployed using the same app interface or script, as long as all infrastructure components have been successfully removed. | ||
| ## Optional: Uninstall the SHIELD Desktop Application (If installed) | ||
|
|
||
| ### What is not removed? | ||
| 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: | ||
|
|
||
| - Audit logs in Entra ID | ||
| - Device enrollment history | ||
| - Local device configurations if not managed via Intune | ||
| - A local machine | ||
| - An Azure VM | ||
|
|
||
| --- | ||
|
|
||
| ## Related Pages | ||
| ## Final Step: Validate Cleanup | ||
|
|
||
| As a final check, you may want to: | ||
|
|
||
| - [Deploy Overview](../Deploy/) | ||
| - [Deploy Usage Guide](../Deploy/Usage-Guide) | ||
| - [Deployment](../Deploy/Deployment/) | ||
| - [Deploy Reference](../Deploy/Reference/) | ||
| - 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 | ||
| - Confirm the SHIELD Desktop application has been uninstalled | ||
This file contains hidden or 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 +1 @@ | ||
| zensical == 0.0.56 | ||
| zensical == 0.0.60 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.