From 8a2630f6013da01bc1443103b41d39966a1b027f Mon Sep 17 00:00:00 2001 From: James Robinson Date: Thu, 6 Oct 2022 09:09:10 +0100 Subject: [PATCH] :memo: Restore [Optional] tag to description of 'databases' in SRE config --- docs/deployment/snippets/02_configuration.partial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/snippets/02_configuration.partial.md b/docs/deployment/snippets/02_configuration.partial.md index b7ef554138..d1d35cb63d 100644 --- a/docs/deployment/snippets/02_configuration.partial.md +++ b/docs/deployment/snippets/02_configuration.partial.md @@ -31,7 +31,7 @@ The following core SRE properties are required - look in the `environment_config "remoteDesktopProvider": "Which remote desktop provider to use. Either 'ApacheGuacamole' (recommended, tiers 0-3) or 'MicrosoftRDS' (tiers 2-3 only)", "azureAdminGroupName": "[Optional] Azure Security Group that admins of this SRE will belong to. If not specified then the same one as the SHM will be used.", "dataAdminIpAddresses": "A list of one or more IP addresses which admins will be using to transfer sensitive data to/from the secure Azure storage area (if not specified then Turing IP addresses will be used).", - "databases": "A list of one or more database flavours from the following list ('MSSQL', 'PostgreSQL'). For example ['MSSQL', 'PostgreSQL'] would deploy both an MS-SQL and a PostgreSQL database.", + "databases": [Optional] "A list of zero or more database flavours from the following list ('MSSQL', 'PostgreSQL'). For example ['MSSQL', 'PostgreSQL'] would deploy both an MS-SQL and a PostgreSQL database.", "deploymentIpAddresses": "[Optional] A list of one or more IP addresses which admins will be using when deploying the SRE (if not specified then deployment commands from any IP address will be permitted).", "domain": "[Optional] The fully qualified domain name for the SRE. If not specified then . will be used.", "overrides": "[Optional, Advanced] Do not use this unless you know what you're doing! If you want to override any of the default settings, you can do so by creating the same JSON structure that would be found in the final config file and nesting it under this entry. For example, to change the name of the Key Vault secret containing the MSSQL admin password, you could use something like: 'sre: { databases: { dbmssql: { adminPasswordSecretName: my-password-name } } }'"