Skip to content

Commit

Permalink
📝 Replace backticks with colons
Browse files Browse the repository at this point in the history
  • Loading branch information
jemrobinson committed Aug 1, 2024
1 parent 00bc34f commit db22ba7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 20 deletions.
4 changes: 2 additions & 2 deletions docs/source/deployment/deploy_shm.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ Before deploying the Safe Haven Management (SHM) infrastructure you need to deci

Once you've decided on these, run the following command: [approx 5 minutes]:

```{code} shell
:::{code} shell
$ dsh shm deploy --entra-tenant-id YOUR_ENTRA_TENANT_ID \
--fqdn YOUR_DOMAIN_NAME \
--location YOUR_LOCATION
```
:::

:::{note}
You will be prompted to log in to the Azure CLI and to the Graph API.
Expand Down
25 changes: 15 additions & 10 deletions docs/source/deployment/deploy_sre.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,16 @@ Each project will have its own dedicated SRE.

- Create a configuration file

```console
:::{code} shell
$ dsh config template --file PATH_YOU_WANT_TO_SAVE_YOUR_YAML_FILE_TO
```
:::

- Edit this file in your favourite text editor, replacing the placeholder text with appropriate values for your setup.

```yaml
::::{admonition} Example YAML configuration file
:class: dropdown tip

:::{code} yaml
azure:
subscription_id: # ID of the Azure subscription that the TRE will be deployed to
tenant_id: # Home tenant for the Azure account used to deploy infrastructure: `az account show`
Expand All @@ -50,15 +53,17 @@ sre:
software_packages: # any/pre-approved/none: which packages from external repositories to allow
timezone: # Timezone in pytz format (eg. Europe/London)
workspace_skus: # List of Azure VM SKUs - see cloudprice.net for list of valid SKUs
```
:::

::::

## Upload the configuration file

- Upload the config to Azure. This will validate your file and report any problems.

```{code} shell
:::{code} shell
$ dsh config upload PATH_TO_YOUR_EDITED_YAML_FILE
```
:::

:::{hint}
If you want to make changes to the config, edit this file and then run `dsh config upload` again
Expand All @@ -69,18 +74,18 @@ If you want to make changes to the config, edit this file and then run `dsh conf
:::{important}
As private endpoints for flexible PostgreSQL are still in preview, the following command is currently needed:

```{code} shell
:::{code} shell
$ az feature register --name "enablePrivateEndpoint" \
--namespace "Microsoft.DBforPostgreSQL" \
--subscription NAME_OR_ID_OF_YOUR_SUBSCRIPTION
```
:::

:::

## Deployment

- Deploy each SRE individually [approx 30 minutes]:

```{code} shell
:::{code} shell
$ dsh sre deploy YOUR_SRE_NAME
```
:::
8 changes: 4 additions & 4 deletions docs/source/deployment/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Deployment

```{toctree}
:::{toctree}
:hidden:

setup_context.md
deploy_shm.md
configure_entra_id.md
deploy_sre.md
```
:::

Deploying an instance of the Data Safe Haven involves the following steps:

Expand Down Expand Up @@ -46,6 +46,6 @@ Please contact the development team in case of any problems.

Enter the base directory and install Python dependencies with `hatch` by doing the following:

```{code} shell
:::{code} shell
$ hatch run true
```
:::
8 changes: 4 additions & 4 deletions docs/source/deployment/setup_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ You can specify the directory where your context configuration (`context.yaml`)

- You will need to provide some options to set up your DSH context. You can see what these are by running the following:

```{code} shell
:::{code} shell
$ dsh context add --help
```
:::

- Run a command like the following to create your local context file.

```{code} shell
:::{code} shell
$ dsh context add --admin-group-name AZURE_SECURITY_GROUP_CONTAINING_ALL_ADMINISTRATORS \
--name NAME_WITH_ONLY_LETTERS_NUMBERS_AND_UNDERSCORES \
--description HUMAN_FRIENDLY_DESCRIPTION_OF_YOUR_TRE \
--subscription-name AZURE_SUBSCRIPTION_NAME
```
:::

:::{note}
If you have multiple contexts defined, you can select which context you want to use with `dsh context switch CONTEXT_NAME`.
Expand Down

0 comments on commit db22ba7

Please sign in to comment.