Merge pull request #16 from nhsuk/feature/remove-review-app

Feature/remove review app

Author: st3v3nhunt

README.md

@@ -18,8 +18,9 @@ in the editor will not be saved back to the repository._
 
 ## Installation
 
-* Install the appropriate version for your development platform of
+* Install the appropriate version of
   [Azure Functions Core Tools version 2.x](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local#install-the-azure-functions-core-tools)
+  for your development platform of choice
 * Clone the repository - `git clone https://github.com/nhsuk/cache-flush.git`
 * Install npm dependencies - `npm install`
 * Rename [example.local.settings.json](example.local.settings.json) to
@@ -28,11 +29,45 @@ in the editor will not be saved back to the repository._
   [Akamai's documentation](https://developer.akamai.com/legacy/introduction/Prov_Creds.html)
   provides details on how to setup API credentials.
 
-
 ## Run Azure Function App locally
 
 * Start the Function app - `func start`
 
+## Deployments and environments
+
+Deployments to all environments are fully automated and are tested to confirm
+the deployment has been successful as part of the deployment process.
+Therefore, if the deployment job succeeds you can be confident the application
+is working.
+
+Deployments are configured via [azure-pipelines.yml](./azure-pipelines.yml) and
+run within the
+[nhsuk.utilities](https://dev.azure.com/nhsuk/nhsuk.utilities/_build?definitionId=323)
+project. The pipeline is not public. In order to view it a login is required.
+The deployed applications are protected using the standard function app
+authorisation mechanism i.e.
+[authorization keys](https://docs.microsoft.com/en-us/azure/azure-functions/functions-bindings-http-webhook#authorization-keys).
+The keys are maintained as secrets to prevent abuse and unwanted use.
+
+### Review environments
+Review environments are deployed for every PR and are available at
+[https://nhsuk-cache-flush-func-dev-uks-pr-<PR_NUMBER>.azurewebsites.net/](https://nhsuk-cache-flush-func-dev-uks-pr-XXX.azurewebsites.net/).
+When a PR is merged into `master` the review environment will be deleted.
+
+### [Integration](https://nhsuk-cache-flush-func-int-uks.azurewebsites.net/)
+Merges to `master` generate a deployment to the integration environment.
+
+### [Staging](https://nhsuk-cache-flush-func-stag-uks.azurewebsites.net/)
+The creation of a [release](https://github.com/nhsuk/cache-flush/releases)
+generates a deployment to the staging environment.
+
+### [Production](https://nhsuk-cache-flush-func-prod-uks.azurewebsites.net/)
+Deployments to production are only possible if the change has been deployed to
+the staging environment. The deployment to production must be
+[approved](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/approvals?view=azure-devops#approvals).
+Using approvals enables a pause between the deployment to staging and the
+deployment to production. It is often necessary to seek a sign-off prior to
+deploying to production and this setup allows that to happen.
 
 ## Environment variables
 

azure-pipelines.yml

@@ -17,6 +17,7 @@ pr:
 
 variables:
   ARTIFACT_NAME: drop
+  REVIEW_APP_NAME_ROOT: 'nhsuk-cache-flush-func-dev-uks-PR-'
 
 stages:
 - stage: build
@@ -68,7 +69,7 @@ stages:
   jobs:
   - template: ./templates/deployment-job.yml
     parameters:
-      appName: 'nhsuk-cache-flush-func-dev-uks-PR-$(system.pullRequest.pullRequestNumber)'
+      appName: '$(REVIEW_APP_NAME_ROOT)$(system.pullRequest.pullRequestNumber)'
       appTest: deployed
       azureSubscription: Development
       environment: cacheflush-review
@@ -86,6 +87,31 @@ stages:
       azureSubscription: 'www.nhs.uk'
       environment: cacheflush-int
       releaseEnvironment: int
+  - job: getNumberForMergedPR
+    displayName: Get the number of the merged PR
+    steps:
+    - bash: $(System.DefaultWorkingDirectory)/scripts/get-pr-number.sh "$BUILD_SOURCEVERSIONMESSAGE"
+      displayName: 'Set PR number, if available'
+      name: PR_NUMBER
+  - job: deleteReviewEnvironment
+    condition: gt(dependencies.getNumberForMergedPR.outputs['PR_NUMBER.PR_NUMBER'], 0)
+    dependsOn: getNumberForMergedPR
+    displayName: Delete review environment for merged PR
+    variables:
+      PR_NUMBER: $[dependencies.getNumberForMergedPR.outputs['PR_NUMBER.PR_NUMBER']]
+      RESOURCE_GROUP: nhsuk-utils-rg-dev-uks
+      REVIEW_APP_NAME: $(REVIEW_APP_NAME_ROOT)$(PR_NUMBER)
+    steps:
+    - task: AzureCLI@2
+      displayName: 'Delete review environment func app and app insights for merged PR'
+      inputs:
+        azureSubscription: Development
+        inlineScript: |
+          az extension add --name application-insights
+          az monitor app-insights component delete --resource-group $(RESOURCE_GROUP) --app $(REVIEW_APP_NAME) --debug
+          az functionapp delete --resource-group $(RESOURCE_GROUP) --name $(REVIEW_APP_NAME) --debug
+        scriptLocation: inlineScript
+        scriptType: bash
 
 - stage: deployStagingEnvironment
   displayName: 'Deploy to Staging Environment'

scripts/get-pr-number.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+regex="#([0-9]+)"
+echo "Testing commit msg: '$1' against regex: '$regex'."
+
+if [[ "$1" =~ $regex ]]; then
+  echo "PR number found. Value is: ${BASH_REMATCH[1]}"
+  echo "##vso[task.setvariable variable=PR_NUMBER;isOutput=true]${BASH_REMATCH[1]}"
+else
+  echo "No PR number found. Setting to 0."
+  echo "##vso[task.setvariable variable=PR_NUMBER;isOutput=true]0"
+fi;