Skip to content

Commit

Permalink
Merge pull request #1880 from alan-turing-institute/deployment_docs
Browse files Browse the repository at this point in the history
Update docs for commands restructure
  • Loading branch information
JimMadge authored May 10, 2024
2 parents 1dbd9aa + 6a63291 commit 0748d71
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
4 changes: 1 addition & 3 deletions docs/source/deployment/deploy_shm.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,9 @@ $ dsh config upload config.yaml
- Next deploy the Safe Haven Management (SHM) infrastructure [approx 30 minutes]:

```{code} shell
$ dsh deploy shm
$ dsh shm deploy
```

Run `dsh deploy shm -h` to see the necessary command line flags and provide them as arguments.

:::{important}
You may be asked to delegate your domain name to Azure. To do this, you'll need to know details about the parent domain. For example, if you are deploying to `dsh.example.com` then the parent name is `example.com`.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/deployment/deploy_sre.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ $ az feature register --name "enablePrivateEndpoint" --namespace "Microsoft.DBfo
- Deploy each SRE individually [approx 30 minutes]:

```{code} shell
$ dsh deploy sre <name of your SRE>
$ dsh sre deploy <name of your SRE>
```
14 changes: 7 additions & 7 deletions docs/source/management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ You will need a full name, phone number, email address and country for each user
2. Alternatively, you can add multiple users from a CSV file with columns named (`GivenName`, `Surname`, `Phone`, `Email`, `CountryCode`).

```{code} shell
$ dsh admin add-users <my CSV users file>
$ dsh users add <my CSV users file>
```

:::{warning}

- the phone number must be in full international format.
- the country code is the two letter `ISO 3166-1 Alpha-2` code.
- the country code is the two letter ISO 3166-1 Alpha-2 code.

:::

Expand All @@ -28,10 +28,10 @@ $ dsh admin add-users <my CSV users file>
2. Alternatively, you can add multiple users from the command line:

```{code} shell
$ dsh admin register-users -s <SRE name> <username1> <username2>
$ dsh users register -s <SRE name> <username1> <username2>
```

where you must specify the usernames for each user you want to add to this SRE
where you must specify the usernames for each user you want to add to this SRE.

## Listing available users

Expand All @@ -40,21 +40,21 @@ where you must specify the usernames for each user you want to add to this SRE
2. You can do this at the command line by running the following command:

```{code} shell
$ dsh admin list-users
$ dsh users list
```

## Removing a deployed Data Safe Haven

- Run the following if you want to teardown a deployed SRE:

```{code} shell
$ dsh teardown sre <SRE name>
$ dsh sre teardown <SRE name>
```

- Run the following if you want to teardown the deployed SHM:

```{code} shell
$ dsh teardown shm
$ dsh shm teardown
```

- Run the following if you want to teardown the deployed Data Safe Haven context:
Expand Down

0 comments on commit 0748d71

Please sign in to comment.