Merge pull request #262 from microsoft/psl-networkmodulerestructure

fix: Updated the reusuable network design documentation

Author: Prajwal-Microsoft

infra/samples/network-subnet-design.bicep

@@ -1,17 +1,17 @@
 // /******************************************************************************************************************/
 //  This is an example test program to create private networking resources independently with sample network design.
-//    It is an illustration of how to use the main.bicep in the infra/modules/network folder, with your own parameters.
+//    It is an illustration of how to use the network-resources.bicep in the infra/samples/network folder, with your own parameters.
 //    You can independently deploy this module to create a network with subnets, NSGs, Azure Bastion Host, and Jumpbox VM.
 //    Test them with this test program. Then integrate your design into the modules/network.bicep which is intended for 
 //    a specific network design. 
 //  
-//  All things in infra/modules/network are designed to be reusable and composable without the need to modify 
+//  All things in infra/samples/network are designed to be reusable and composable without the need to modify 
 //     any code in the network folder. 
 //
 //  Please review below modules to understand how things are wired together:
 //    infra/main.bicep
 //    infra/modules/network.bicep
-//    infra/moddules/network/main.bicep 
+//    infra/samples/network/network-resources.bicep 
 //  
 // /******************************************************************************************************************/
 
@@ -39,7 +39,7 @@ param vmAdminUsername string = 'JumpboxAdminUser'
 param vmAdminPassword string = 'JumpboxAdminP@ssw0rd1234!'
 
 
-import { bastionHostConfigurationType } from '../modules/network/bastionHost.bicep'
+import { bastionHostConfigurationType } from 'network/bastionHost.bicep'
 @description('Optional. Configuration for the Azure Bastion Host. Leave null to omit Bastion creation.')
 param bastionConfiguration bastionHostConfigurationType = {
   name: 'bastion-${resourcesName}'
@@ -106,7 +106,7 @@ param bastionConfiguration bastionHostConfigurationType = {
       }
 }
 
-import { jumpBoxConfigurationType } from '../modules/network/jumpbox.bicep'
+import { jumpBoxConfigurationType } from 'network/jumpbox.bicep'
 @description('Optional. Configuration for the Jumpbox VM. Leave null to omit Jumpbox creation.')
 param jumpboxConfiguration jumpBoxConfigurationType = {
   name: 'vm-jumpbox-${resourcesName}'
@@ -174,7 +174,7 @@ param addressPrefixes array = ['10.0.0.0/20'] // 4096 addresses (enough for 8 /2
 // - Document subnet usage and purpose in code comments.
 // - For AVM modules, ensure only one delegation per subnet and leave delegations empty if not required.
 
-import { subnetType } from '../modules/network/virtualNetwork.bicep'
+import { subnetType } from 'network/virtualNetwork.bicep'
 @description('Array of subnets to be created within the VNET.')
 param subnets subnetType[] = [
   {
@@ -325,7 +325,7 @@ module logAnalyticsWorkspace 'br/public:avm/res/operational-insights/workspace:0
 // Networking - NSGs, VNET and Subnets. Each subnet has its own NSG
 // /******************************************************************************************************************/
 
-module network '../modules/network/network-resources.bicep' = {
+module network 'network/network-resources.bicep' = {
   name: take('network-${resourcesName}-create', 64)
   params: {
     resourcesName: resourcesName

infra/modules/network/bastionHost.bicep infra/samples/network/bastionHost.bicepinfra/modules/network/bastionHost.bicep renamed to infra/samples/network/bastionHost.bicep

@@ -5,14 +5,14 @@ This guide explains how to use the sample Bicep program `network-subnet-design.b
 ## Purpose and Approach
 
 - **Sample File:** `infra/samples/network-subnet-design.bicep`
-- **Reusable Modules:** All code in `infra/modules/network` is designed to be reusable. You should not need to modify code in the modules folder.
+- **Reusable Modules:** All code in `infra/samples/network` is designed to be reusable. You should not need to modify code in the modules folder.
 - **Custom Network File:** For your own solution, create a `network.bicep` in `infra/modules/` that represents your specific network design, using the modules as building blocks.
 
 ## How to Use the Sample
 
 - The sample demonstrates how to deploy a virtual network, subnets, NSGs, Azure Bastion Host, and Jumpbox VM using parameters and reusable modules.
 - The sample is parameterized, so you can easily adjust subnet names, address spaces, NSG rules, and delegations.
-- You can design and validate your network design with  `infra/samples/network-subnet-design.bicep`, then integrate the code by updating `infra/modules/network.bicep` with your tested design. 
+- You can design and validate your network design with `infra/samples/network-subnet-design.bicep`, then integrate the code by creating `infra/modules/network.bicep` with your tested design (network-subnet-design.bicep). 
 
 ## Key Features in the Sample
 
@@ -35,17 +35,23 @@ This guide explains how to use the sample Bicep program `network-subnet-design.b
    - Adjust the subnet array, address prefixes, NSG rules, and other parameters to match your requirements.
 3. **Deploy the Sample:**
    - Use Azure Developer CLI (`azd`) or Azure CLI to deploy the sample and validate your design.
-4. **Integrate into Solution:**
-   - Once validated, use the same approach to build your own `network.bicep` in `infra/modules/` for your solution. Test your solution with `infra/main.bicep`. 
+4. **Integrate into Your Solution:**
+   - Once validated, create your own `network.bicep` in `infra/modules/` using the tested design (network-subnet-design.bicep).
+   - **Key Integration Steps:**
+     - Remove any standalone calls to `virtualNetwork.bicep`, `bastionHost`, and `jumpboxVM` modules from main.bicep file
+     - Replace them with a single call to `infra/modules/network.bicep` (netwly created network design bicep)
+   - This approach uses the tested, reusable modules without code duplication.
+   - Test your integrated solution with `infra/main.bicep`. 
 
 ## Example Directory Structure
 
 ```
 infra/
-  modules/
+  samples/
     network/
       ... (reusable modules)
-    network.bicep   # <-- your custom network design
+  modules/
+    network.bicep   # <--Create your own custom network design
   samples/
     network-subnet-design.bicep  # <-- reference
 ```