Mahara PR #2

mahara-autoscale-cache/README.md

@@ -1,6 +1,6 @@
 # *Deploy and manage a Scalable Mahara Cluster on Azure*
 
-After deploying, these templates will provide you with a new Mahara site with caching for speed and scaling frontends to handle PHP load. The filesystem behind it is mirrored for high availability. Filesystem permissions and options have been tuned to make Mahara more secure than the default install
+After deploying, these templates will provide you with a new Mahara site with caching for speed and scaling frontends to handle PHP load. The filesystem behind it is mirrored for high availability. Filesystem permissions and options have been tuned to make Mahara more secure than the default install.
 
 [![Deploy to Azure Minimally](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com/Azure/azure-quickstart-templates/master/mahara-autoscale-cache/azuredeploy.json) [![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.png)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com/Azure/azure-quickstart-templates/master/mahara-autoscale-cache/azuredeploy.json)
 
@@ -18,41 +18,19 @@ This template set deploys the following infrastructure:
 - Three Elasticsearch VMs for search indexing in Mahara (optional)*
 - Dual Gluster nodes for high availability access to Mahara files
 
-* Note: You will need to login into Mahara as 'admin' and configure the artefacts you want indexed after the installation has completed.
+* Note: You will need to login into Mahara as 'admin' and configure the artifacts you want indexed after the installation has completed.
 
 ![network_diagram](images/stack_diagram.png "Diagram of deployed stack")
 
 ## *Deployment steps*
 
-You can click the "deploy to Azure" button at the beginning of this document or alternatively perform a deploy from the command line:
-
-
-### *Command line deploys*
-
-Once you've checked out the templates from git, you'll want to use the [Azure CLI tool](https://docs.microsoft.com/en-us/cli/azure/overview?view=azure-cli-latest) to deploy them. First off you'll want to create a group with these:
-
-`az group create --name <stackname> --location <location>`
-
-Note that some location in Azure might not support features or certain VM tiers.
-
-Next you'll want to either deploy and enter in all the parameters manually:
-
-`az group deployment create --name mahara-autoscale --resource-group <stackname> --template-file azuredeploy.json`
-
-Alternatively, you can configure all of your variables in the "azuredeploy.parameters.json" file and run:
-
-`az group deployment create --name mahara-autoscale --resource-group <stackname> --template-file azuredeploy.json --parameters azuredeploy.parameters.json`
-
-
-Note that `siteURL` is a special case in the `azuredeploy.parameters.json` files. If you do not define a value for `siteURL` or if you leave it as the default "www.example.org" this value will be overwritten by the template to be a calculated value for the public load balancers of your deployment. This allows you to experiment with this Mahara template without configuring a new domain name whilst still enabling Mahara to be configured with a production URL when appropriate. See the next section for instructions on retrieving the generated DNS name if necesary
-
-Depending on what tiers you selected for VMs and the database you will be looking at roughly 1 to 2 hours for a full deploy. See below for selectable parameters.
+You can click the "deploy to Azure" button at the beginning of this document.
 
 ## *Using the created stack*
 
 In testing, stacks typically took between 1 and 1 and a half hours to finish, depending on spec. Once this is done, you will receive JSON data with outputs needed to continue setup. You can also retrieve these from the portal or the CLI, more information below. The available parameters are:
 
-- siteURL: If you provided a `siteURL' parameter when deploying this will be set to the supplied value. Otherwise it will be the same as the loadBalancerDNS, see below.
+- siteURL: If you provided a `siteURL` parameter when deploying this will be set to the supplied value. Otherwise it will be the same as the loadBalancerDNS, see below.
 - loadBalancerDNS: This is the address of your load balancer. If you provided a `siteURL` parameter when deploying you'll need to add a DNS entry CNAMEs to this.
 - maharaAdminPassword: The password for the "admin" user in your Mahara install.
 - controllerinstanceIP: This is the address of the controller. You will need to SSH into this to make changes to your Mahara code or view logs.
@@ -139,13 +117,13 @@ As of the time of writing, Azure supports "Basic" and "Standard" tiers for datab
 
 This value also limits the maximum number of connections, as defined here: https://docs.microsoft.com/en-us/azure/mysql/concepts-limits
 
-As the Mahara database will handle cron processes as well as the website, any public facing websites with than 10 users will likely require upgrading to 100. Once the site reaches 30+ user it will require upgrading to Standard for more compute units. This depends entirely on the individual site. As MySQL databases cannot change (or be restored to a different tier) once deployed it is a good idea to slightly overspec your database.
+As the Mahara database will handle cron processes as well as the website, any public facing websites with than 10 users will likely require upgrading to 100. Once the site reaches 30+ users it will require upgrading to Standard for more compute units. This depends entirely on the individual site. As MySQL databases cannot change (or be restored to a different tier) once deployed it is a good idea to slightly overspec your database.
 
-Standard instances have a minimum storage requirement of 128000MB. All database storage, regardless of tier, has a hard upper limit of 1 terrabyte. After 128GB you gain additional iops for each GB, so if you're expecting a heavy amount of traffic you will want to oversize your storage. The current maximum iops with a 1TB disk is 3000.
+Standard instances have a minimum storage requirement of 128GB. All database storage, regardless of tier, has a hard upper limit of 1 terrabyte. After 128GB you gain additional iops for each GB, so if you're expecting a heavy amount of traffic you will want to oversize your storage. The current maximum iops with a 1TB disk is 3000.
 
 ### *Controller instance sizing*
 
-The controller handles both syslog and cron duties. Depending on how big you Mahara cron runs are this may not be sufficent. If cron jobs are very delayed and cron processess are building up on the controller then an upgrade in tier is needed.
+The controller handles both syslog and cron duties. Depending on how big you Mahara cron runs are this may not be sufficent. If cron jobs are delayed and cron processess are building up on the controller then an upgrade in tier is needed.
 
 ### *Frontend instances*
 

mahara-autoscale-cache/azuredeploy.json

@@ -23,6 +23,13 @@
             },
             "type": "bool"
         },
+	"location": {
+		"type": "string",
+		"defaultValue": "[resourceGroup().location]",
+		"metadata": {
+		   "description": "Location for all resources"
+	 	}
+	},
         "azureBackupSwitch": {
             "defaultValue": false,
             "metadata": {
@@ -80,7 +87,6 @@
             "type": "string"
         },
         "sshUsername": {
-            "defaultValue": "azureadmin",
             "metadata": {
                 "description": "ssh user name"
             },
@@ -130,7 +136,6 @@
             "type": "string"
         },
         "dbLogin": {
-            "defaultValue": "dbadmin",
             "metadata": {
                 "description": "Database admin username"
             },
@@ -223,7 +228,7 @@
                 "nfs"
             ],
             "metadata": {
-                "description": "File server type: GlusterFS, NFS--not yet highly available"
+                "description": "File server type: GlusterFS, NFS--not yet highly available. Gluster uses premium managed disks therefore premium skus are required."
             },
             "type": "string"
         },
@@ -360,7 +365,7 @@
     "resources": [
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "name": "pid-738e3eec-68d4-4667-8377-c05c77c21f1b",
             "properties": {
                 "mode": "Incremental",
@@ -373,7 +378,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "Microsoft.Resources/deployments/networkTemplate"
             ],
@@ -399,7 +404,7 @@
         {
             "condition": "[parameters('azureBackupSwitch')]",
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "name": "recoveryTemplate",
             "properties": {
                 "mode": "Incremental",
@@ -415,7 +420,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "name": "networkTemplate",
             "properties": {
                 "mode": "Incremental",
@@ -431,7 +436,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "Microsoft.Resources/deployments/networkTemplate",
                 "Microsoft.Resources/deployments/recoveryTemplate"
@@ -452,7 +457,7 @@
         {
             "condition": "[equals(parameters('fileServerType'),'gluster')]",
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "Microsoft.Resources/deployments/networkTemplate",
                 "Microsoft.Resources/deployments/recoveryTemplate"
@@ -472,7 +477,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "Microsoft.Resources/deployments/glusterTemplate",
                 "Microsoft.Resources/deployments/recoveryTemplate",
@@ -490,6 +495,9 @@
                     },
                     "ctlrPubIpId": {
                         "value": "[reference('networkTemplate').outputs.ctlrPubIpId.value]"
+                    },
+                    "siteFQDN": {
+                        "value": "[reference('networkTemplate').outputs.siteFQDN.value]"
                     }
                 },
                 "templateLink": {
@@ -499,7 +507,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "Microsoft.Resources/deployments/controllerTemplate",
                 "Microsoft.Resources/deployments/networkTemplate",
@@ -511,6 +519,9 @@
                 "parameters": {
                     "maharaCommon": {
                         "value": "[variables('maharaCommon')]"
+                    },
+                    "siteFQDN": {
+                        "value": "[reference('networkTemplate').outputs.siteFQDN.value]"
                     }
                 },
                 "templateLink": {
@@ -520,7 +531,7 @@
         },
         {
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "name": "storageAccountTemplate",
             "properties": {
                 "mode": "Incremental",
@@ -538,7 +549,7 @@
     "outputs": {
       "siteURL": {
         "type": "string",
-        "value": "[variables('maharaCommon').siteURL]"
+        "value": "[if(equals(variables('maharaCommon').siteURL,'www.example.org'),reference('networkTemplate').outputs.siteFQDN.value,'www.example.org')]"
       },
       "controllerInstanceIP": {
         "type": "string",
@@ -572,9 +583,13 @@
         "type": "string",
         "value": "[variables('maharaCommon').maharaDbPass]"
       },
+      "sshUsername": {
+        "type": "string",
+        "value": "[variables('maharaCommon').sshUsername]"
+      },
       "loadBalancerDNS": {
         "type": "string",
-        "value": "[variables('maharaCommon').lbDns]"
+        "value": "[reference('networkTemplate').outputs.siteFQDN.value]"
       }
     },
     "variables": {
@@ -589,6 +604,7 @@
         "documentation09": "    controller          - creates a controller VM and deploys code",
         "documentation10": "GlusterFS Sizing guidance",
         "maharaCommon": {
+	    "location": "[parameters('location')]",
             "baseTemplateUrl": "[concat(parameters('_artifactsLocation'), 'nested/')]",
             "scriptLocation": "[concat(parameters('_artifactsLocation'), 'scripts/')]",
             "artifactsSasToken": "[parameters('_artifactsLocationSasToken')]",
@@ -643,7 +659,6 @@
             "ctlrPipName": "[concat('controller-pubip-',variables('resourceprefix'))]",
             "ctlrVmName": "[concat('controller-vm-',variables('resourceprefix'))]",
             "ctlrVmSecrets": "[take(variables('ctlrVmSecretsArray'), if(empty(parameters('keyVaultResourceId')), 0, 1))]",
-            "lbDns": "[concat('lb-',variables('resourceprefix'),'.',resourceGroup().location,'.cloudapp.azure.com')]",
             "lbName": "[concat('lb-',variables('resourceprefix'))]",
             "lbPipName": "[concat('lb-pubip-',variables('resourceprefix'))]",
             "maharaAdminPass": "[concat(toUpper('xl'), substring(uniqueString(resourceGroup().id, deployment().name), 6, 7),',1*8')]",
@@ -670,7 +685,7 @@
             "resourcesPrefix": "[variables('resourceprefix')]",
             "searchType": "[parameters('searchType')]",
             "serverName": "[concat(parameters('dbServerType'), '-',variables('resourceprefix'))]",
-            "siteURL": "[if(or(empty(parameters('siteURL')), equals(parameters('siteURL'), 'www.example.org')), concat('lb-',variables('resourceprefix'),'.',resourceGroup().location,'.cloudapp.azure.com'), parameters('siteURL'))]",
+            "siteURL": "[parameters('siteURL')]",
             "sshPublicKey": "[parameters('sshPublicKey')]",
             "sshUsername": "[parameters('sshUsername')]",
             "sslEnforcement": "[parameters('sslEnforcement')]",

mahara-autoscale-cache/azuredeploy.parameters.json

@@ -3,9 +3,7 @@
     "contentVersion": "1.0.0.0",
         "parameters": {
                 "sshPublicKey":                { "value": "GEN-SSH-PUB-KEY" },
-                "dbServerType":                { "value": "mysql" },
-                "fileServerDiskCount":         { "value": 2 },
-                "fileServerDiskSize":          { "value": 32 }
-	}        
-
+                "sshUsername":		       { "value": "GEN-UNIQUE-8"},
+		"dbLogin":		       { "value": "GEN-UNIQUE-8"}
+        }
 }

mahara-autoscale-cache/nested/controller.json

@@ -13,13 +13,20 @@
                 "description": "Resource ID of the controller VM public IP address"
             },
             "type": "string"
-        }
+        },
+        "siteFQDN": {
+            "metadata": {
+                "description": "FQDN of public IP address"
+            },
+            "type": "string"
+       }
     },
+
     "resources": [
         {
             "type": "Microsoft.Network/networkSecurityGroups",
             "apiVersion": "2017-10-01",
-            "location": "[resourceGroup().location]",
+            "location": "[parameters('maharaCommon').location]",
             "name": "[parameters('maharaCommon').ctlrNsgName]",
             "properties": {
                 "securityRules": [
@@ -61,7 +68,7 @@
             "dependsOn": [
                 "[concat('Microsoft.Network/networkSecurityGroups/', parameters('maharaCommon').ctlrNsgName)]"
             ],
-            "location": "[resourceGroup().location]",
+            "location": "[parameters('maharaCommon').location]",
             "name": "[parameters('maharaCommon').ctlrNicName]",
             "properties": {
                 "networkSecurityGroup": {
@@ -92,7 +99,7 @@
             "dependsOn": [
                 "[concat('Microsoft.Network/networkInterfaces/', parameters('maharaCommon').ctlrNicName)]"
             ],
-            "location": "[resourceGroup().location]",
+            "location": "[parameters('maharaCommon').location]",
             "name": "[parameters('maharaCommon').ctlrVmName]",
             "properties": {
                 "hardwareProfile": {
@@ -140,7 +147,7 @@
         {
             "condition": "[parameters('maharaCommon').applyScriptsSwitch]",
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "[concat('Microsoft.Compute/virtualMachines/', parameters('maharaCommon').ctlrVmName)]"
             ],
@@ -150,8 +157,12 @@
                 "parameters": {
                     "maharaCommon": {
                         "value": "[parameters('maharaCommon')]"
-                    }
+                    },
+                   "siteFQDN": {
+                        "value": "[parameters('siteFQDN')]"
+                   } 
                 },
+
                 "templateLink": {
                     "uri": "[concat(parameters('maharaCommon').baseTemplateUrl, 'controllerconfig.json', parameters('maharaCommon').artifactsSasToken)]"
                 }
@@ -160,7 +171,7 @@
         {
             "condition": "[parameters('maharaCommon').azureBackupSwitch]",
             "type": "Microsoft.Resources/deployments",
-            "apiVersion": "2017-05-10",
+            "apiVersion": "2016-09-01",
             "dependsOn": [
                 "[concat('Microsoft.Compute/virtualMachines/',parameters('maharaCommon').ctlrVmName)]"
             ],