-
Notifications
You must be signed in to change notification settings - Fork 526
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Mini-Orchestration Module - hubPeeredSpoke (#223)
* hubPeeredSpoke * SecondCommit * ThirdCommit Co-authored-by: Jack Tracey <[email protected]>
- v0.21.0
- v0.20.2
- v0.20.1
- v0.20.0
- v0.20.0-pre
- v0.19.4
- v0.19.3
- v0.19.2
- v0.19.1
- v0.19.0
- v0.19.0-pre
- v0.18.0
- v0.17.5
- v0.17.4
- v0.17.3
- v0.17.2
- v0.17.1
- v0.17.0
- v0.16.6
- v0.16.5
- v0.16.4
- v0.16.3
- v0.16.2
- v0.16.1
- v0.16.0
- v0.16.0-pre
- v0.15.0
- v0.15.0-pre
- v0.14.1-pre
- v0.14.0
- v0.14.0-pre
- v0.13.0
- v0.12.0
- v0.11.0
- v0.10.6
- v0.10.5
- v0.10.4
- v0.10.3
- v0.10.2
- v0.10.1
- v0.10.0
- v0.9.3
- v0.9.2
- v0.9.1
- v0.9.0
- v0.8.1
- v0.8.0
- v0.7.1
Showing
7 changed files
with
513 additions
and
20 deletions.
There are no files selected for viewing
This file contains 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
127 changes: 127 additions & 0 deletions
127
infra-as-code/bicep/orchestration/hubPeeredSpoke/README.md
This file contains 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,127 @@ | ||
| # Module: Orchestration - hubPeeredSpoke - Spoke network, including peering to Hub (Hub & Spoke or Virtual WAN) | ||
|
|
||
| This module acts as an orchestration module that create and configures a spoke network to deliver the Azure Landing Zone Hub & Spoke architecture, for both traditional Hub & Spoke and Virtual WAN, which is also described in the wiki on the [Deployment Flow article](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow). | ||
|
|
||
| Module deploys the following resources: | ||
|
|
||
| - Subscription placement in Management Group hierarchy - if parPeeredVnetSubscriptionMGPlacement is specified | ||
| - Virtual Network (Spoke VNet) | ||
| - UDR - if parNextHopIPAddress and resource id of hub virtual network object is specified | ||
| - Hub to Spoke peering - if resource id of hub virtual network object is specified in parHubVirtualNetworkID | ||
| - Spoke to hub peering - if resource id of hub virtual network object is specified in parHubVirtualNetworkID | ||
| - Spoke to virtual WAN peering - if resource id of virtual WAN hub object is specified in parHubVirtualNetworkID | ||
|
|
||
| Note that only one peering type can be created with this module, so either traditional Hub & Spoke OR Azure virtual WAN. | ||
|
|
||
| ## Parameters | ||
|
|
||
| The module requires the following inputs: | ||
|
|
||
| | Parameter | Type | Default | Description | Requirement | Example | | ||
| | -------------------------------------- | ------ | --------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | parLocation | string | `deployment().location` | The region to deploy all resoruces into | Valid Azure Region | `northeurope` | | ||
| | parTopLevelManagementGroupPrefix | string | `'alz'` | Prefix for the management group hierarchy | None | `alz` | | ||
| | parPeeredVnetSubscriptionId | string | Empty string `''` | Subscription Id to the Virtual Network Hub object | None | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | | ||
| | parTags | object | Empty object `{}` | Array of Tags to be applied to all resources in module | None | `{"key": "value"}` | | ||
| | parTelemetryOptOut | bool | false | Set Parameter to true to Opt-out of deployment telemetry | None | false | | ||
| | parPeeredVnetSubscriptionMGPlacement | string | Empty string `''` | The location (MG hierarchy) to place the subscription in | None | `'alz-platform-landingZonesCorp'` | | ||
| | parResourceGroupNameForSpokeNetworking | string | `$parTopLevelManagementGroupPrefix-$parRegion-spoke-networking` | Name of Resource Group to be created to contain resources | None | `Hub_Networking_POC` | | ||
| | parDdosProtectionPlanId | string | Empty string `''` | Existing DDoS Protection plan to utilize | None | `/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/Hub_Networking_POC/providers/Microsoft.Network/ddosProtectionPlans/alz-Ddos-Plan` | | ||
| | parSpokeNetworkName | string | `vnet-spoke` | The Name of the Spoke Virtual Network. | None | `vnet-spoke` | | ||
| | parSpokeNetworkAddressPrefix | string | `10.11.0.0/16` | CIDR for Spoke Network | None | `10.11.0.0/16` | | ||
| | parDNSServerIPArray | array | Empty array `[]` | Array IP DNS Servers to use for VNet DNS Resolution | None | `['10.10.1.4', '10.20.1.5']` | | ||
| | parNextHopIPAddress | string | Empty string `''` | IP Address where network traffic should route to | None | `192.168.50.4` | | ||
| | parBGPRoutePrapogation | bool | false | Switch to enable BGP Route Propagation on VNet Route Table | None | false | | ||
| | parSpokeToHubRouteTableName | string | 'rtb-spoke-to-hub' | Name of Route table to create for the default route of Hub | None | `rtb-spoke-to-hub` | | ||
| | parHubVirtualNetworkID | string | Empty string `''` | Virtual Network ID of Hub Virtual Network, or Azure Virtuel WAN hub ID | None | `/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/Hub_Networking_POC/providers/Microsoft.Network/virtualNetworks/alz-vnet-hub-northeurope` | ||
| | parAllowSpokeForwardedTraffic | bool | false | Switch to enable/disable forwarded Traffic from outside spoke network | None | false | | ||
| | parAllowHubVPNGatewayTransit | bool | false | Switch to enable/disable VPN Gateway for the hub network peering | None | false | | ||
|
|
||
| ## Outputs | ||
|
|
||
| The module will generate the following outputs: | ||
|
|
||
| | Output | Type | Example | | ||
| | --------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | outSpokeVirtualNetworkName | string | `vnet-spoke` | | ||
| | outSpokeVirtualNetworkid | string | `/subscriptions/xxxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxx/resourceGroups/Hub_Networking_POC/providers/Microsoft.Network/virtualNetworks/vnet-spoke` | | ||
|
|
||
| ## Deployment | ||
|
|
||
| This module is intended to be called from other modules as a reusable resource, but an example on how to deploy has been added below for completeness. | ||
|
|
||
| In this example, the spoke resources will be deployed to the resource group specified. According to the Azure Landing Zone Conceptual Architecture, the spoke resources should be deployed into the Landing Zones subscriptions. During the deployment step, we will take the parameters provided in the example parameter files. | ||
|
|
||
| > For the examples below we assume you have downloaded or cloned the Git repo as-is and are in the root of the repository as your selected directory in your terminal of choice. | ||
| ### Azure CLI | ||
| ```bash | ||
| # For Azure global regions | ||
| # Set Azure Corp Landing zone subscription ID as the the current subscription | ||
| $LandingZoneSubscriptionId="[your landing zone subscription ID]" | ||
| $Location="[your landing zone subscription ID]" | ||
| $TopLevelManagemetGroupID="alz" | ||
| az account set --subscription $LandingZoneSubscriptionId | ||
|
|
||
| az deployment mg create \ | ||
| --location $Location --management-group-id $TopLevelManagemetGroupID \ | ||
| --template-file .\infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.bicep \ | ||
| --parameters @infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.parameters.example.json | ||
| ``` | ||
| OR | ||
| ```bash | ||
| # For Azure China regions | ||
| # Set Azure Corp Landing zone subscription ID as the the current subscription | ||
| $LandingZoneSubscriptionId="[your landing zone subscription ID]" | ||
| $Location="[your landing zone subscription ID]" | ||
| $TopLevelManagemetGroupID="alz" | ||
| az account set --subscription $LandingZoneSubscriptionId | ||
|
|
||
| az deployment mg create \ | ||
| --location $Location --management-group-id $TopLevelManagemetGroupID \ | ||
| --template-file .\infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.bicep \ | ||
| --parameters @infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.parameters.example.json | ||
| ``` | ||
|
|
||
| ### PowerShell | ||
|
|
||
| ```powershell | ||
| # For Azure global regions | ||
| # Set Azure Corp Landing zone subscription ID as the the current subscription | ||
| $LandingZoneSubscriptionId="[your landing zone subscription ID]" | ||
| $Location="[your landing zone subscription ID]" | ||
| $TopLevelManagemetGroupID="alz" | ||
| Select-AzSubscription -SubscriptionId $LandingZoneSubscriptionId | ||
| New-AzManagementGroupDeployment ` | ||
| -Location $Location -ManagementGroupId $TopLevelManagemetGroupID ` | ||
| -TemplateFile infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.bicep ` | ||
| -TemplateParameterFile infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.parameters.example.json ` | ||
| ``` | ||
| OR | ||
| ```powershell | ||
| # For Azure China regions | ||
| # Set Platform connectivity subscription ID as the the current subscription | ||
| $LandingZoneSubscriptionId="[your landing zone subscription ID]" | ||
| $Location="[your landing zone subscription ID]" | ||
| $TopLevelManagemetGroupID="alz" | ||
| Select-AzSubscription -SubscriptionId $LandingZoneSubscriptionId | ||
| New-AzManagementGroupDeployment ` | ||
| -Location $Location -ManagementGroupId $TopLevelManagemetGroupID ` | ||
| -TemplateFile infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.bicep ` | ||
| -TemplateParameterFile infra-as-code\bicep\orchestration\hubPeeredSpoke\hubPeeredSpoke.parameters.example.json ` | ||
| ``` | ||
|
|
||
| ## Bicep Visualizer | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
64 changes: 64 additions & 0 deletions
64
infra-as-code/bicep/orchestration/hubPeeredSpoke/bicepconfig.json
This file contains 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,64 @@ | ||
| { | ||
| "analyzers": { | ||
| "core": { | ||
| "enabled": true, | ||
| "verbose": true, | ||
| "rules": { | ||
| "adminusername-should-not-be-literal": { | ||
| "level": "error" | ||
| }, | ||
| "no-hardcoded-env-urls": { | ||
| "level": "error" | ||
| }, | ||
| "no-unnecessary-dependson": { | ||
| "level": "error" | ||
| }, | ||
| "no-unused-params": { | ||
| "level": "error" | ||
| }, | ||
| "no-unused-vars": { | ||
| "level": "error" | ||
| }, | ||
| "outputs-should-not-contain-secrets": { | ||
| "level": "error" | ||
| }, | ||
| "prefer-interpolation": { | ||
| "level": "error" | ||
| }, | ||
| "secure-parameter-default": { | ||
| "level": "error" | ||
| }, | ||
| "simplify-interpolation": { | ||
| "level": "error" | ||
| }, | ||
| "protect-commandtoexecute-secrets": { | ||
| "level": "error" | ||
| }, | ||
| "use-stable-vm-image": { | ||
| "level": "error" | ||
| }, | ||
| "explicit-values-for-loc-params": { | ||
| "level": "error" | ||
| }, | ||
| "no-hardcoded-location": { | ||
| "level": "error" | ||
| }, | ||
| "no-loc-expr-outside-params": { | ||
| "level": "error" | ||
| }, | ||
| "max-outputs": { | ||
| "level": "error" | ||
| }, | ||
| "max-params": { | ||
| "level": "error" | ||
| }, | ||
| "max-resources": { | ||
| "level": "error" | ||
| }, | ||
| "max-variables": { | ||
| "level": "error" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.