From b6d6261ad3d67482fd76fff5c5e343550c341374 Mon Sep 17 00:00:00 2001 From: James Robinson Date: Wed, 26 Jul 2023 18:01:27 +0100 Subject: [PATCH] :rotating_light: Fix README --- data_safe_haven/README.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/data_safe_haven/README.md b/data_safe_haven/README.md index 950627e324..ca72429e0a 100644 --- a/data_safe_haven/README.md +++ b/data_safe_haven/README.md @@ -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]: @@ -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 +> dsh admin add-users ``` - Next deploy the infrastructure for one or more Secure Research Environments (SREs) [approx 30 minutes]: ```bash -> dsh deploy sre -r -r +> dsh deploy sre ``` -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 +> dsh admin register-users -s ``` 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: