Skip to content

Commit 3149a9b

Browse files
Merge pull request #21 from Software-Hardware-Integration-Lab/SHIELD-Reorganization
Overhaul Docs Structure
2 parents 96857ac + 2e73cb6 commit 3149a9b

122 files changed

Lines changed: 2183 additions & 1297 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.vscode/tasks.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@
3333
"problemMatcher": []
3434
}
3535
]
36-
}
36+
}

docs/Data-Gateway/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Data Gateway
2+
3+
🚧 **This page is still under development.**
4+
5+

docs/Discover/Deployment/0-Prerequisites.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/Discover/Deployment/Silent-Installation.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/Discover/Deployment/Standard-Install.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/Discover/Getting-Started.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

docs/Discover/Plugins/Overview.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/Discover/index.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/SHIELD/Defend/Deployment.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Deployment
2+
3+
The Defend module is deployed automatically as part of the SHIELD platform’s **Core Infrastructure deployment** process. It does not require any separate deployment scripts or packages.
4+
5+
This page clarifies when and how Defend becomes active, and what its dependencies are.
6+
7+
---
8+
9+
## When Is Defend Activated?
10+
11+
Defend becomes available immediately after the **Deploy Core Infrastructure** action is completed in the SHIELD UI.
12+
13+
This process provisions all objects that Defend needs in order to operate:
14+
15+
- Security groups by security class (Enterprise, Specialized, Privileged)
16+
- Entra ID Administrative Units for lifecycle scope isolation
17+
- Intune Scope Tags and associated device policies
18+
- Lifecycle engine triggers and UI cards
19+
20+
Once this is complete, the **Lifecycle Device Management** and **Lifecycle User Management** cards appear in the SHIELD UI.
21+
22+
---
23+
24+
## No Separate Installer Required
25+
26+
There is no separate installer, script, or action to "deploy Defend."
27+
28+
Instead, this module is:
29+
30+
- **Provisioned as part of the Deploy module's infrastructure**
31+
- **Enabled via the SHIELD web app** once infrastructure provisioning is complete
32+
33+
You can verify readiness by visiting `{your-subdomain}.azurewebsites.net` and checking that:
34+
35+
- The home screen includes Lifecycle action cards
36+
- Clicking them loads the correct views with no warnings
37+
38+
---
39+
40+
## Prerequisites
41+
42+
To use Defend, the following must already be deployed:
43+
44+
- Core infrastructure via Deploy
45+
- Required Entra ID roles (Global Reader, Security Admin)
46+
- Devices or users exist in Entra ID and are synced with Intune (where applicable)
47+
- Defender for Endpoint workspace is initialized (for device enforcement)
48+
49+
📖 [View Full Prerequisites](Prerequisites.md)
50+
51+
---
52+
53+
## Related Pages
54+
55+
- [Defend Overview](index.md)
56+
- [Defend Usage Guide](Usage-Guide/index.md)
57+
- [Defend Reference](Reference/index.md)
58+
- [Troubleshooting](Troubleshooting.md)
59+
- [SHIELD Platform Deployment](../Getting-Started.md)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Prerequisites
2+
3+
The Defend module manages user and device lifecycle operations. Before using this module, the following prerequisites must be in place within your Microsoft 365 environment.
4+
5+
These requirements ensure that SHIELD can enforce security controls, commission resources, and assign users or devices to their correct roles.
6+
7+
---
8+
9+
## Infrastructure Requirements
10+
11+
The Defend module relies on infrastructure that must be deployed via the Deploy module. Specifically, the following must already exist:
12+
13+
- Core infrastructure has been deployed via the **Deploy Core Infrastructure** action
14+
- Conditional Access policies are applied based on security class
15+
- Entra ID Administrative Units and security groups are provisioned
16+
- Intune is configured with scope tags
17+
18+
📖 See [SHIELD Platform Prerequisites](../Prerequisites/index.md)
19+
20+
---
21+
22+
## Role-Based Permissions
23+
24+
To use Defend’s lifecycle functionality, the signed-in admin must have the following roles in Entra ID:
25+
26+
| Role | Reason |
27+
|------|--------|
28+
| Global Reader | Required to enumerate users and devices |
29+
| Security Administrator | Required for actions that interact with Defender and Intune APIs |
30+
| User Administrator | Required for privileged user provisioning and removal |
31+
32+
---
33+
34+
## Device and User Sync
35+
36+
For SHIELD to manage identities and endpoints, the following must be true:
37+
38+
- Users are present in Entra ID
39+
- Devices are registered or hybrid-joined with Entra ID
40+
- Devices must be visible in Intune (for privileged device management)
41+
- Users and devices must be assigned to the correct security class
42+
43+
---
44+
45+
## Defender for Endpoint Readiness
46+
47+
SHIELD uses Microsoft Defender for Endpoint to enforce privileged device controls. The Defender portal must have a provisioned workspace before certain lifecycle actions can succeed.
48+
49+
To verify:
50+
51+
1. Go to [Microsoft 365 Defender](https://security.microsoft.com){:target="_blank"}
52+
2. Click on **Devices**
53+
3. If a table of devices appears, your workspace is ready
54+
4. If prompted to initialize setup, follow instructions and wait until the UI is fully active
55+
56+
📖 For more detail, see the [Defend Usage Guide](Usage-Guide/index.md), under **Defender for Endpoint Workspace Creation**
57+
58+
---
59+
60+
## Related Pages
61+
62+
- [Defend Deployment](Deployment.md)
63+
- [Defend Usage Guide](Usage-Guide/index.md)
64+
- [Hardware Requirements](Reference/index.md)
65+
- [SHIELD Prerequisites](../Prerequisites/index.md)
66+

0 commit comments

Comments
 (0)