Skip to content

Commit

Permalink
vnet doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
ritika-msft committed Aug 9, 2021
1 parent c05c0e8 commit 88d38dd
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions 01-Setup and getting started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Setup will create infra resources and schedule daily security control scan on ta
> **Note:**
> 1. _Setup may take up to 5 minutes to complete._
> 2. _For better performance, we recommend using one location for hosting central scanning user-assigned MI and resources which will be created in the following installation steps using the `Install-AzSKTenantSecuritySolution` cmdlet._
> 3. _To install AzTS setup with **VNet integration**, uncomment switch `-EnableVnetIntegration` and then run the installation command `Install-AzSKTenantSecuritySolution`._ To know more about VNet Integration refer to this [FAQ](README.md#why-should-i-integrate-my-azts-solution-setup-with-vnet).
> 3. _To install AzTS setup with **VNet integration**, use switch `-EnableVnetIntegration` and then run the installation command `Install-AzSKTenantSecuritySolution`._ To know more about VNet Integration refer to this [FAQ](README.md#why-should-i-integrate-my-azts-solution-setup-with-vnet).
>
>  
Expand All @@ -293,15 +293,14 @@ $DeploymentResult = Install-AzSKTenantSecuritySolution `
-ScanHostRGName <HostResourceGroupName> `
-Location <ResourceLocation> `
-ScanIdentityId <ManagedIdentityResourceId> `
-WebAPIAzureADAppId <WebAPIAzureADApplicationId> `
-UIAzureADAppId <UIAzureADApplicationId> `
-AzureEnvironmentName AzureCloud `
-SendUsageTelemetry:$true `
-ScanIdentityHasGraphPermission:$true `
[-WebAPIAzureADAppId <WebAPIAzureADApplicationId>] `
[-UIAzureADAppId <UIAzureADApplicationId>] `
[-AzureEnvironmentName AzureCloud] `
[-ScanIdentityHasGraphPermission:$true] `
-SendAlertNotificationToEmailIds @('<EmailId1>', '<EmailId2>', '<EmailId3>') `
-EnableAutoUpdater `
-EnableAzTSUI `
#-EnableVnetIntegration `
[-EnableAutoUpdater] `
[-EnableAzTSUI] `
[-EnableVnetIntegration] `
-Verbose
Expand Down Expand Up @@ -374,7 +373,7 @@ For '-WebAPIAzureADAppId' and '-UIAzureADAppId' parameter,
|SendUsageTelemetry| Permit application to send usage telemetry to Microsoft server. Usage telemetry captures anonymous usage data and sends it to Microsoft servers. This will help in improving the product quality and prioritize meaningfully on the highly used features. The default value is false.|FALSE|
|EnableAutoUpdater | Switch to enable AzTS auto updater. Autoupdater helps to get latest feature released for AzTS components covering updates for security controls. If this is disabled, you can manually update AzTS components by re-running setup command.|FALSE|
|EnableAzTSUI | Switch to enable AzTS UI. AzTS UI is created to see compliance status for subscription owners and perform adhoc scan. |FALSE|
|EnableVnetIntegration | Switch to enable vnet integration for AzTS setup. Enabling VNet integration for AzTS setup, ensures that all critical resources like storage, function apps, log analytics workspace etc that are part of AzTS setup, are not accessible over public internet. |FALSE|
|EnableVnetIntegration | Switch to enable VNet integration for AzTS setup. Enabling VNet integration for AzTS setup, ensures that all critical resources like storage, function apps, log analytics workspace etc that are part of AzTS setup, are not accessible over public internet. |FALSE|
|Verbose| Switch used to output detailed log |FALSE|

</br>
Expand Down Expand Up @@ -451,7 +450,7 @@ The following section will walk you through the steps to trigger AzTS scan manua
Run the `Start-AzSKTenantSecuritySolutionOnDemandScan` command to start scan after the installation of AzTS Soln. Please note that after running this command, AzTS UI will available in the next 2 hours depending on the number of subscriptions to be scanned.

> **Note:**
> _If your AzTS solution is integrated to VNet, in that case uncomment switch `-EnableVnetIntegration` and then run `Start-AzSKTenantSecuritySolutionOnDemandScan` command to trigger AzTS scan._
> _If your AzTS solution is integrated to VNet, in that case use switch `-EnableVnetIntegration` and then run `Start-AzSKTenantSecuritySolutionOnDemandScan` command to trigger AzTS scan._

```PowerShell
Expand All @@ -463,7 +462,7 @@ $HostResourceGroupName = "<HostResourceGroupName>"
Start-AzSKTenantSecuritySolutionOnDemandScan -SubscriptionId $HostSubscriptionId `
-ScanHostRGName $HostResourceGroupName `
#-EnableVnetIntegration
[-EnableVnetIntegration]
```

Expand Down Expand Up @@ -540,7 +539,7 @@ The below steps will help you to verify and understand different resources and f
|ATS_3_SubscriptionRBACProcessor| Collects RBAC details of subscription to be scanned. RBAC collected is used to scan the control like "Azure_Subscription_AuthZ_Dont_Use_NonAD_Identities"
|ATS_4_WorkItemScheduler| Responsible to queue up subscriptions as workitems for scanning. It also reconciles the errored subscriptions through retries in the end. By default, it would retry to scan 5 times for each error subscription. If there is nothing to process for the day, it would simply ignore the run.
|ATS_5_MGTreeProcessor| Responsible to fetch details about all the management group that has been granted access as Reader using central MI. All these management groups will be fetched by the job and persisted into LA. This function is disabled by default. To enable this function, you need to add/update ` FeatureManagement__ManagementGroups : true ` and `ManagementGroupConfigurations__ManagementGroupId : <Root_Management_Group_id> ` application setting on Azure Portal. To update settings, go to your App Service --> Configuration --> New application settings --> Save after adding/updating the setting.
|ATS_7_InitiateOnDemandProcessing| Reads message from the AzTS storage queue and trigger functions (ATS_1_SubscriptionInvProcessor, ATS_2_BaselineControlsInvProcessor, ATS_3_SubscriptionRBACProcessor, ATS_4_WorkItemScheduler) of MetadataAggregator, if the AzTS solution is integrated to `VNet`.
|ATS_7_InitiateOnDemandProcessing| Responsible to queue MetadataAggregator's functions (ATS_1_SubscriptionInvProcessor, ATS_2_BaselineControlsInvProcessor, ATS_3_SubscriptionRBACProcessor, ATS_4_WorkItemScheduler) for processing. **Note**: This feature is only available if the AzTS solution is integrated to VNet.

**2.b. WorkItemProcessor Functions:**

Expand All @@ -565,7 +564,7 @@ Similarly, you can trigger below functions with 10 mins interval.

After ATS_4_WorkItemScheduler completes pushing the messages in the queue, WorkItemProcessor will get auto trigged, start processing scan and push scan results in Storage Account and LA workspace.

> **Note:** If AzTS solution is integrated to VNet, you cannot run the functions manually. To trigger all the required functions run [On-Demand scan](README.md#2-manually-trigger-azts-on-demand-scan-for-entire-tenant) command after uncommenting switch `-EnableVnetIntegration`.
> **Note:** If AzTS solution is integrated to VNet, you cannot run the functions manually. To trigger all the required functions run [On-Demand scan](README.md#2-manually-trigger-azts-on-demand-scan-for-entire-tenant) command with switch `-EnableVnetIntegration`.
**2.c. AutoUpdater Functions:**

Expand Down Expand Up @@ -801,7 +800,7 @@ In this case, we recommend you to upgrade the Function app hosting plan (pricing
#### **Why should I integrate my AzTS solution setup with VNet?**
1. Integrating AzTS solution with Vnet, ensures that all critical backend resources like - storage account, log analytics workspace, function apps etc. are not accessible over public network.
1. Integrating AzTS solution with VNet, ensures that all critical backend resources like - storage account, log analytics workspace, function apps etc. are not accessible over public network.
2. It ensures that all inbound communication to backend resources are routed through private network (Vnet).
Expand Down
Binary file modified Images/12_TSS_Processor_WebJobs_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/12_TSS_Resource_Group_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/12_TSS_Resource_Group_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/12_TSS_Resource_Group_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 88d38dd

Please sign in to comment.