More documentation

Author: Vivek Lakshmanan

azure-nextgen-ts-webapp-privateendpoint-vnet-injection/README.md

@@ -1,10 +1,41 @@
+[![Deploy](https://get.pulumi.com/new/button.svg)](https://app.pulumi.com/new)
+
 # Deploy two App Services - Front web app with VNet injection and Back web app with a Private Endpoint
 
 **Note** This is a port of https://github.com/Azure/azure-quickstart-templates/tree/master/101-webapp-privateendpoint-vnet-injection to Pulumi's Azure-Nextgen SDK.
 
+
 This deploys a secure front end - back end web app. The front end web app (`site2`) is plugged in a subnet with the feature regional VNet integration enabled. Settings are set to consume a DNS private zone. The backend web app (`site1`) is only exposed through a private endpoint.
 
 It will create a VNet, two subnets, one where your Private Endpoint will exist, the second where you will inject the front web app, an App Service Plan in PremiumV2 tier (mandatory for Private Endpoint), a Private Endpoint, settings for DNS queries to the DNS Private Zone, and a private DNS zone with record for the Private Endpoint.
 
-## Required config params
+### Prerequisites
+
+1. [Install Pulumi](https://www.pulumi.com/docs/get-started/install/)
+2. [Install node.js](https://nodejs.org/en/download/)
+3. [Configure Azure Credentials](https://www.pulumi.com/docs/intro/cloud-providers/azure/setup/)
+
+
+### Required config params
 `resourceGroupNameParam` - name for the resource group.
+
+### Steps
+
+After cloning this repo, from this working directory, run these commands:
+
+1. Create a new stack, which is an isolated deployment target for this example:
+
+    ```bash
+    $ pulumi stack init dev
+    ```
+
+1. Next, install the dependencies:
+
+    ```bash
+    $ npm install
+    ```
+
+1. Stand up the cluster by invoking pulumi
+    ```bash
+    $ pulumi up
+    ```

azure-nextgen-ts-webapp-privateendpoint-vnet-injection/index.ts

@@ -1,3 +1,5 @@
+// Copyright 2016-2021, Pulumi Corporation.  All rights reserved.
+
 import * as azure_nextgen from "@pulumi/azure-nextgen";
 import * as pulumi from "@pulumi/pulumi";
 import * as random from "@pulumi/random";
@@ -31,10 +33,13 @@ const serverfarm = new azure_nextgen.web.v20190801.AppServicePlan("serverfarm",
     },
 });
 
+// To get a random suffix
 const rand = new random.RandomString("random", {
     length: 5,
     special: false,
 });
+
+// Setup backend app
 const site1NameParam = config.get("site1NameParam") || pulumi.interpolate `webapp1${rand.result}`;
 const site1 = new azure_nextgen.web.v20190801.WebApp("backendApp", {
     kind: "app",
@@ -56,6 +61,7 @@ new azure_nextgen.web.v20190801.WebAppHostNameBinding("hostNameBindingSite1", {
     siteName: site1.name,
 });
 
+// Setup frontend app
 const site2NameParam = config.get("site2NameParam") || pulumi.interpolate `webapp2${rand.result}`;
 const site2 = new azure_nextgen.web.v20190801.WebApp("frontendApp", {
     kind: "app",
@@ -80,6 +86,8 @@ new azure_nextgen.web.v20190801.WebAppHostNameBinding("hostNameBindingSite2", {
 const virtualNetworkNameParam = config.get("virtualNetworkNameParam") || "vnet";
 const privateDNSZoneName = "privatelink.azurewebsites.net";
 const virtualNetworkCIDRParam = config.get("virtualNetworkCIDRParam") || "10.200.0.0/16";
+
+// Setup a vnet
 const virtualNetwork = new azure_nextgen.network.v20200401.VirtualNetwork("virtualNetwork", {
     addressSpace: {
         addressPrefixes: [virtualNetworkCIDRParam],
@@ -88,6 +96,7 @@ const virtualNetwork = new azure_nextgen.network.v20200401.VirtualNetwork("virtu
     resourceGroupName: resourceGroup.name,
     virtualNetworkName: virtualNetworkNameParam,
 });
+// Setup private DNS zone
 const privateDnsZone = new azure_nextgen.network.v20180901.PrivateZone("privateDnsZone", {
     location: "global",
     privateZoneName: privateDNSZoneName,
@@ -99,13 +108,16 @@ const privateEndpointNameParam = config.get("privateEndpointNameParam") || "Priv
 const privateLinkConnectionNameParam = config.get("privateLinkConnectionNameParam") || "PrivateEndpointLink1";
 const subnet1NameParam = config.get("subnet1NameParam") || "SubnetForSite1";
 const subnet1CIDRParam = config.get("subnet1CIDRParam") || "10.200.1.0/24";
+// Setup a private subnet
 const subnet1 = new azure_nextgen.network.v20200401.Subnet("subnet1", {
     addressPrefix: subnet1CIDRParam,
     privateEndpointNetworkPolicies: "Disabled",
     resourceGroupName: resourceGroup.name,
     subnetName: subnet1NameParam,
     virtualNetworkName: virtualNetwork.name,
 });
+
+// Private endpoint in the private subnet for site1 (backend)
 const privateEndpoint = new azure_nextgen.network.v20200501.PrivateEndpoint("privateEndpoint", {
     location: locationParam,
     privateEndpointName: privateEndpointNameParam,
@@ -119,6 +131,8 @@ const privateEndpoint = new azure_nextgen.network.v20200501.PrivateEndpoint("pri
         id: subnet1.id,
     },
 });
+
+// Setup a private DNS Zone for private endpoint
 new azure_nextgen.network.v20200301.PrivateDnsZoneGroup("privateDnsZoneGroup", {
     privateDnsZoneConfigs: [{
         name: "config1",
@@ -139,6 +153,7 @@ new azure_nextgen.network.v20180901.VirtualNetworkLink("virtualNetworkLink", {
     virtualNetworkLinkName: pulumi.interpolate `${privateDNSZoneName}-link`,
 });
 
+// Now setup subnet for site2 (frontend)
 const subnet2NameParam = config.get("subnet2NameParam") || "SubnetForSite2";
 const subnet2CIDRParam = config.get("subnet2CIDRParam") || "10.200.2.0/24";
 const subnet2 = new azure_nextgen.network.v20200401.Subnet("subnet2", {