Skip to content

Commit

Permalink
🚨 Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
jemrobinson committed Jul 26, 2023
1 parent c2a494a commit b6d6261
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions data_safe_haven/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ Install the following requirements before starting
- [Poetry](https://python-poetry.org/docs/#installation)
- [Pulumi](https://www.pulumi.com/docs/get-started/install/)

# Deploying a Data Safe Haven

Create a directory where you want to store local configuration files for this deployment.
This is the `project directory`
## Deploying a Data Safe Haven

- Run the following to initialise the deployment [approx 5 minutes]:

Expand All @@ -25,42 +22,41 @@ If you prefer to enter these at the command line, run `dsh init -h` to see the n
> dsh deploy shm
```

You will be prompted for various project settings.
If you prefer to enter these at the command line, run `dsh deploy shm -h` to see the necessary command line flags.
You will be prompted for various settings.
Run `dsh deploy shm -h` to see the necessary command line flags and provide them as arguments.

- Add one or more users from a CSV file with columns named (`GivenName`, `Surname`, `Phone`, `Email`). Note that the phone number must be in full international format.

```bash
> dsh users add <my CSV users file>
> dsh admin add-users <my CSV users file>
```

- Next deploy the infrastructure for one or more Secure Research Environments (SREs) [approx 30 minutes]:

```bash
> dsh deploy sre <SRE name> -r <VM1 SKU> -r <VM2 SKU>
> dsh deploy sre <SRE name>
```

where you must specify a VM SKU for each user-accessible secure research desktop that you want to deploy
On first run, you will be prompted for various project settings.
If you prefer to enter these at the command line, run `dsh deploy sre -h` to see the necessary command line flags.
You will be prompted for various settings.
Run `dsh deploy sre -h` to see the necessary command line flags and provide them as arguments.

- Next add one or more existing users to your SRE

```bash
> dsh users register -s <SRE name> <username1> <username2>
> dsh admin register-users -s <SRE name> <username1> <username2>
```

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

# Administering a Data Safe Haven
## Administering a Data Safe Haven

- Run the following to list the currently available users

```bash
> dsh users list
> dsh admin list-users
```

# Removing a deployed Data Safe Haven
## Removing a deployed Data Safe Haven

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

Expand Down

0 comments on commit b6d6261

Please sign in to comment.