Merge pull request #5363 from dfe-analytical-services/dev

Merge Dev into Master

.github/workflows/validate-snapshots.yml

@@ -5,9 +5,12 @@ on:
     # Actions are scheduled in UTC
     # Until Actions supports timezones, we need to update this cron
     # twice a year (at the start and end of daylight saving time) 
-    # to account for daylight saving time in the UK
+    # to account for daylight saving time in the UK.
+    # Set a new reminder in the slack channel for next time to 
+    # change this
     # This action is intended to run at 9:35AM, 12:35PM & 4:35PM
-    - cron: '35 8,11,15 * * 1-5'
+    # March to October - cron: '35 8,11,15 * * 1-5'
+    - cron: '35 9,12,16 * * 1-5'
 env:
   GH_TOKEN: ${{ secrets.GH_TOKEN }}
   SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

.ruby-version

@@ -0,0 +1 @@
+3.3.5

infrastructure/templates/public-api/abbreviations.bicep

@@ -3,13 +3,14 @@
 var abbreviations = {
   appContainerApps: 'ca'
   appManagedEnvironments: 'cae'
-  // TODO - remove the "-flexibleserver" suffix and change the suffix of our PSQL instance to "-01" 
+  // TODO - remove the "-flexibleserver" suffix and change the suffix of our PSQL instance to "-01"
   dBforPostgreSQLServers: 'psql-flexibleserver'
   // 'ai' is non-standard - it should be 'appi'
   insightsComponents: 'ai'
   managedIdentityUserAssignedIdentities: 'id'
   networkApplicationGateways: 'agw'
   operationalInsightsWorkspaces: 'log'
+  staticWebApps: 'stapp'
   // 'sa' is non-standard - it should be 'st'
   storageStorageAccounts: 'sa'
   // 'fa' is non-standard - it shoule be 'func'

infrastructure/templates/public-api/application/public-api/publicApiDocs.bicep

@@ -0,0 +1,19 @@
+import { resourceNamesType, staticWebAppSkuType } from '../../types.bicep'
+
+@description('Common resource naming variables.')
+param resourceNames resourceNamesType
+
+@description('Static Web App SKU to use.')
+param appSku staticWebAppSkuType = 'Free'
+
+@description('A set of tags for the resource.')
+param tagValues object
+
+module publicApiDocsApp  '../../components/staticWebApp.bicep' = {
+  name: 'publicApiDocsAppDeploy'
+  params: {
+    name: resourceNames.publicApi.docsApp
+    tagValues: tagValues
+    sku: appSku
+  }
+}

infrastructure/templates/public-api/components/staticWebApp.bicep

@@ -0,0 +1,25 @@
+import { staticWebAppSkuType } from '../types.bicep'
+
+@description('Name of the resource.')
+param name string
+
+@description('Location for an optional Azure Functions API backend (only certain regions allowed).')
+@allowed(['centralus', 'eastus2', 'eastasia', 'westeurope', 'westus2'])
+param location string = 'westeurope'
+
+@description('Static Web App SKU to use.')
+param sku staticWebAppSkuType = 'Free'
+
+@description('A set of tags for the resource.')
+param tagValues object
+
+resource staticWebApp 'Microsoft.Web/staticSites@2023-12-01' = {
+  name: name
+  location: location
+  tags: tagValues
+  sku: {
+    name: sku
+    size: sku
+  }
+  properties: {}
+}

infrastructure/templates/public-api/main.bicep

@@ -1,5 +1,5 @@
 import { abbreviations } from 'abbreviations.bicep'
-import { firewallRuleType, principalNameAndIdType } from 'types.bicep'
+import { firewallRuleType, principalNameAndIdType, staticWebAppSkuType } from 'types.bicep'
 
 @description('Environment : Subscription name e.g. s101d01. Used as a prefix for created resources.')
 param subscription string = ''
@@ -45,6 +45,9 @@ param postgreSqlEntraIdAdminPrincipals principalNameAndIdType[] = []
 @description('ACR : Specifies the resource group in which the shared Container Registry lives.')
 param acrResourceGroupName string = ''
 
+@description('Public API docs app : SKU to use.')
+param docsAppSku staticWebAppSkuType = 'Free'
+
 @description('Tagging : Environment name e.g. Development. Used for tagging resources created by this infrastructure pipeline.')
 param environmentName string
 
@@ -142,6 +145,7 @@ var resourceNames = {
     dataProcessorIdentity: '${publicApiResourcePrefix}-${abbreviations.managedIdentityUserAssignedIdentities}-${abbreviations.webSitesFunctions}-processor'
     dataProcessorPlan: '${publicApiResourcePrefix}-${abbreviations.webServerFarms}-${abbreviations.webSitesFunctions}-processor'
     dataProcessorStorageAccountsPrefix: '${subscription}eessaprocessor'
+    docsApp: '${publicApiResourcePrefix}-${abbreviations.staticWebApps}-docs'
     publicApiFileshare: '${publicApiResourcePrefix}-fs-data'
     publicApiStorageAccount: '${replace(publicApiResourcePrefix, '-', '')}${abbreviations.storageStorageAccounts}'
   }
@@ -262,6 +266,16 @@ module apiAppModule 'application/public-api/publicApiApp.bicep' = if (deployCont
   ]
 }
 
+// Deploy Public API docs.
+module docsModule 'application/public-api/publicApiDocs.bicep' = {
+  name: 'publicApiDocsModuleDeploy'
+  params: {
+    appSku: docsAppSku
+    resourceNames: resourceNames
+    tagValues: tagValues
+  }
+}
+
 // Create an Application Gateway to serve public traffic for the Public API Container App.
 module appGatewayModule 'application/shared/appGateway.bicep' = if (deployContainerApp) {
   name: 'appGatewayApplicationModuleDeploy'

infrastructure/templates/public-api/parameters/main-prod.bicepparam

@@ -13,3 +13,5 @@ param publicUrls = {
 param postgreSqlSkuName = 'Standard_B1ms'
 param postgreSqlStorageSizeGB = 32
 param postgreSqlAutoGrowStatus = 'Disabled'
+
+param docsAppSku = 'Standard'

infrastructure/templates/public-api/types.bicep

@@ -34,6 +34,7 @@ type resourceNamesType = {
     dataProcessorIdentity: string
     dataProcessorPlan: string
     dataProcessorStorageAccountsPrefix: string
+    docsApp: string
     publicApiStorageAccount: string
     publicApiFileshare: string
   }
@@ -87,3 +88,6 @@ type containerRegistryRoleType = 'AcrPull'
 
 @export()
 type keyVaultRoleType = 'Secrets User' | 'Certificate User'
+
+@export()
+type staticWebAppSkuType = 'Free' | 'Standard'