From 621707dc24070ac365d4ed326ab13c966812cada Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 13:32:30 +0000 Subject: [PATCH 01/14] update example config yaml --- docs/source/deployment/deploy_sre.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 2a1e5511a7..e6ada6fc42 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -46,6 +46,7 @@ $ dsh config template --file PATH_YOU_WANT_TO_SAVE_YOUR_YAML_FILE_TO \ :::{code} yaml azure: + location: # Azure location where SRE resources will be deployed 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` description: # A free-text description of your SRE deployment @@ -61,8 +62,13 @@ sre: remote_desktop: allow_copy: # True/False: whether to allow copying text out of the environment allow_paste: # True/False: whether to allow pasting text into the environment - research_user_ip_addresses: # List of IP addresses belonging to users + research_user_ip_addresses: + - # List of IP addresses belonging to users + - # You can also use the tag 'Internet' instead of a list software_packages: # Which Python/R packages to allow users to install: [any/pre-approved/none] + storage_quota_gb: + home: # Total size in GiB across all home directories . + shared: #Total size in GiB for the shared directories . timezone: # Timezone in pytz format (eg. Europe/London) workspace_skus: # List of Azure VM SKUs that will be used for data analysis. ::: From 519744f3dbc08b460e455707d4ef861d91a81d5a Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 13:44:13 +0000 Subject: [PATCH 02/14] Reorganize deployment page and add details about copy and paste --- docs/source/deployment/deploy_sre.md | 32 ++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index e6ada6fc42..c0fdb99540 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -75,14 +75,18 @@ sre: :::: -:::{admonition} Supported Azure regions -:class: dropdown important +### Configuration guidance + +#### Choosing an Azure region Some of the SRE resources are not available in all Azure regions. - Workspace virtual machines use zone redundant storage managed disks which have [limited regional availability](https://learn.microsoft.com/en-us/azure/virtual-machines/disks-redundancy). - Some shares mounted on workspace virtual machines require premium file shares which have [limited regional availability](https://learn.microsoft.com/en-us/azure/storage/files/redundancy-premium-file-shares). +:::{admonition} Supported Azure regions +:class: dropdown important + The regions which satisfy all requirements are, - Australia East @@ -117,6 +121,8 @@ The regions which satisfy all requirements are, ::: +#### Choosing a VM SKU + :::{hint} See [here](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/) for a full list of valid Azure VM SKUs. ::: @@ -170,6 +176,28 @@ As some general recommendations, ::: +### Copy and paste + +The [Guacamole clipboard](https://guacamole.apache.org/doc/gug/using-guacamole.html#using-the-clipboard) provides an interface between the local clipboard and the clipboard on the remote workspaces. +Only text is allowed to be passed through the Guacamole clipboard. + +Copy and pasting of text to or from SRE workspaces via the Guacamole clipboard can be configured with the `allow_copy` and `allow_paste` settings. + +`allow_copy` allows users to copy text from an SRE workspace to the Guacamole clipboard. + +`allow_paste` allows users to paste text into an SRE workspace from the Guacamole clipboard. + +These options have no impact on the ability to use copy and paste within a workspace. + +The impact of setting each of these options is detailed in the below table. + +| allow_copy | allow_paste | Copy/paste within workspace | Copy/paste between workspaces | Copy to local machine | Paste from local machine | +|--------|--------|--------|--|---|--| +| true | true | yes | yes | yes | yes | +| true | false | yes | no | yes | no | +| false | true | yes | no | no | yes| +| false | false | yes | no | no | no | + ## Upload the configuration file - Upload the config to Azure. This will validate your file and report any problems. From 2a3e076a1ef1e3e50c70d448e88e063d15ab126b Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 14:02:19 +0000 Subject: [PATCH 03/14] Add some description of copy and pasting to the user guide --- docs/source/roles/researcher/using_the_sre.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/roles/researcher/using_the_sre.md b/docs/source/roles/researcher/using_the_sre.md index 51a7b60abf..368bf1d820 100644 --- a/docs/source/roles/researcher/using_the_sre.md +++ b/docs/source/roles/researcher/using_the_sre.md @@ -703,3 +703,13 @@ The data can be read into a dataframe for local analysis. head(df, 3) ::: :::: + +## Copy and paste + +It is always possible to use copy and paste as normal within an SRE workspace. + +However, the ability to copy and paste text to or from an SRE workspace depends on the specific configuration of the SRE. + +The {ref}`system manager ` can configure the SRE workspaces to allow copying text from a workspace, pasting text into a workspace, both, or neither. + +Copy and paste of anything other than text to or from a workspace is always disabled. From 31f200c3d47c0e92eeba63dbc55bc579bc87a526 Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 14:10:47 +0000 Subject: [PATCH 04/14] Move copy and paste section in user guide --- docs/source/deployment/deploy_sre.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index c0fdb99540..8326130997 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -192,7 +192,7 @@ These options have no impact on the ability to use copy and paste within a works The impact of setting each of these options is detailed in the below table. | allow_copy | allow_paste | Copy/paste within workspace | Copy/paste between workspaces | Copy to local machine | Paste from local machine | -|--------|--------|--------|--|---|--| +|-----|-----|-----|-----|-----|-----| | true | true | yes | yes | yes | yes | | true | false | yes | no | yes | no | | false | true | yes | no | no | yes| From de075dcbef5960f9272caa27fda1c42e0d4d3535 Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 14:19:59 +0000 Subject: [PATCH 05/14] Move and clarify copy and paste user information --- docs/source/roles/researcher/using_the_sre.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/roles/researcher/using_the_sre.md b/docs/source/roles/researcher/using_the_sre.md index 368bf1d820..50b78f9126 100644 --- a/docs/source/roles/researcher/using_the_sre.md +++ b/docs/source/roles/researcher/using_the_sre.md @@ -48,6 +48,16 @@ You can make the process as easy as possible by providing as much information as For instance, describing in detail what a dataset contains and how it will be use will help speed up decision making. ::: +## {{scissors}} Copy and paste + +It is always possible to use copy and paste as normal within an SRE workspace. + +However, the ability to copy and paste text to or from an SRE workspace depends on the specific configuration of the SRE. + +The {ref}`system manager ` can configure the SRE workspaces to allow copying text from a workspace, pasting text into a workspace, both, or neither. + +Copy and paste of anything other than text to or from a workspace is always disabled. + ## {{books}} Maintaining an archive of the project SREs are designed to be ephemeral and only deployed for as long as necessary. @@ -703,13 +713,3 @@ The data can be read into a dataframe for local analysis. head(df, 3) ::: :::: - -## Copy and paste - -It is always possible to use copy and paste as normal within an SRE workspace. - -However, the ability to copy and paste text to or from an SRE workspace depends on the specific configuration of the SRE. - -The {ref}`system manager ` can configure the SRE workspaces to allow copying text from a workspace, pasting text into a workspace, both, or neither. - -Copy and paste of anything other than text to or from a workspace is always disabled. From a055dd56ea70c0a1abbdaa95f618f687b2307ef0 Mon Sep 17 00:00:00 2001 From: Matt Craddock Date: Mon, 28 Oct 2024 14:48:16 +0000 Subject: [PATCH 06/14] Update docs/source/deployment/deploy_sre.md Co-authored-by: Jim Madge --- docs/source/deployment/deploy_sre.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 8326130997..836eca111e 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -67,8 +67,8 @@ sre: - # You can also use the tag 'Internet' instead of a list software_packages: # Which Python/R packages to allow users to install: [any/pre-approved/none] storage_quota_gb: - home: # Total size in GiB across all home directories . - shared: #Total size in GiB for the shared directories . + home: # Total size in GiB across all home directories + shared: #Total size in GiB for the shared directories timezone: # Timezone in pytz format (eg. Europe/London) workspace_skus: # List of Azure VM SKUs that will be used for data analysis. ::: From 9d478010c3cf4bd2f2fbc1d48e8b2a7eeb77718e Mon Sep 17 00:00:00 2001 From: Matt Craddock Date: Mon, 28 Oct 2024 14:50:15 +0000 Subject: [PATCH 07/14] Update docs/source/deployment/deploy_sre.md Co-authored-by: Jim Madge --- docs/source/deployment/deploy_sre.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 836eca111e..9913e71c4c 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -176,7 +176,7 @@ As some general recommendations, ::: -### Copy and paste +#### Copy and paste The [Guacamole clipboard](https://guacamole.apache.org/doc/gug/using-guacamole.html#using-the-clipboard) provides an interface between the local clipboard and the clipboard on the remote workspaces. Only text is allowed to be passed through the Guacamole clipboard. From 81ead78d5f76ad6c42b5c7c3c289eceab951fb26 Mon Sep 17 00:00:00 2001 From: Matt Craddock Date: Mon, 28 Oct 2024 14:50:44 +0000 Subject: [PATCH 08/14] Update docs/source/deployment/deploy_sre.md Co-authored-by: Jim Madge --- docs/source/deployment/deploy_sre.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 9913e71c4c..a6da5aad6f 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -181,12 +181,9 @@ As some general recommendations, The [Guacamole clipboard](https://guacamole.apache.org/doc/gug/using-guacamole.html#using-the-clipboard) provides an interface between the local clipboard and the clipboard on the remote workspaces. Only text is allowed to be passed through the Guacamole clipboard. -Copy and pasting of text to or from SRE workspaces via the Guacamole clipboard can be configured with the `allow_copy` and `allow_paste` settings. - +The ability to copy and paste text to or from SRE workspaces via the Guacamole clipboard can be controlled with the DSH configuration parameters `allow_copy` and `allow_paste`. `allow_copy` allows users to copy text from an SRE workspace to the Guacamole clipboard. - `allow_paste` allows users to paste text into an SRE workspace from the Guacamole clipboard. - These options have no impact on the ability to use copy and paste within a workspace. The impact of setting each of these options is detailed in the below table. From 2a61c58338b482b5efbf3a024348ca63f3e15079 Mon Sep 17 00:00:00 2001 From: Matt Craddock Date: Mon, 28 Oct 2024 14:51:21 +0000 Subject: [PATCH 09/14] Update docs/source/roles/researcher/using_the_sre.md Co-authored-by: Jim Madge --- docs/source/roles/researcher/using_the_sre.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/source/roles/researcher/using_the_sre.md b/docs/source/roles/researcher/using_the_sre.md index 50b78f9126..1620a8f717 100644 --- a/docs/source/roles/researcher/using_the_sre.md +++ b/docs/source/roles/researcher/using_the_sre.md @@ -51,12 +51,9 @@ For instance, describing in detail what a dataset contains and how it will be us ## {{scissors}} Copy and paste It is always possible to use copy and paste as normal within an SRE workspace. - However, the ability to copy and paste text to or from an SRE workspace depends on the specific configuration of the SRE. - The {ref}`system manager ` can configure the SRE workspaces to allow copying text from a workspace, pasting text into a workspace, both, or neither. - -Copy and paste of anything other than text to or from a workspace is always disabled. +Copy and paste of anything other than text to or from a workspace is not possible. ## {{books}} Maintaining an archive of the project From b281eb99cd0d0ccdce020ea6fa51611d87a3cafc Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Mon, 28 Oct 2024 15:07:26 +0000 Subject: [PATCH 10/14] Use table directive --- docs/source/deployment/deploy_sre.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index a6da5aad6f..20a41c52e8 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -188,12 +188,14 @@ These options have no impact on the ability to use copy and paste within a works The impact of setting each of these options is detailed in the below table. +:::{table} **Configuration of copy and paste** | allow_copy | allow_paste | Copy/paste within workspace | Copy/paste between workspaces | Copy to local machine | Paste from local machine | |-----|-----|-----|-----|-----|-----| | true | true | yes | yes | yes | yes | | true | false | yes | no | yes | no | | false | true | yes | no | no | yes| | false | false | yes | no | no | no | +::: ## Upload the configuration file From 8687863fa0748ab562460e9c97baf52fb0ee1149 Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Wed, 30 Oct 2024 15:09:17 +0000 Subject: [PATCH 11/14] convert copy and paste table to html --- docs/source/deployment/deploy_sre.md | 67 +++++++++++++++++++++++++--- 1 file changed, 60 insertions(+), 7 deletions(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 20a41c52e8..94ad3f711e 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -187,14 +187,67 @@ The ability to copy and paste text to or from SRE workspaces via the Guacamole c These options have no impact on the ability to use copy and paste within a workspace. The impact of setting each of these options is detailed in the below table. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Configuration of copy and paste#
Configuration settingResulting behaviour
allow_copyallow_pasteCopy/paste within workspaceCopy/paste between workspacesCopy to local machinePaste from local machine
truetrueyesyesyesyes
truefalseyesnoyesno
falsetrueyesnonoyes
falsefalseyesnonono
+ -:::{table} **Configuration of copy and paste** -| allow_copy | allow_paste | Copy/paste within workspace | Copy/paste between workspaces | Copy to local machine | Paste from local machine | -|-----|-----|-----|-----|-----|-----| -| true | true | yes | yes | yes | yes | -| true | false | yes | no | yes | no | -| false | true | yes | no | no | yes| -| false | false | yes | no | no | no | ::: ## Upload the configuration file From 7db5ea776902fd7e144daf9da3b57fb76e0e78d4 Mon Sep 17 00:00:00 2001 From: Jim Madge Date: Thu, 31 Oct 2024 14:51:21 +0000 Subject: [PATCH 12/14] Tidy table style --- docs/source/deployment/deploy_sre.md | 52 +++++++++++----------------- 1 file changed, 21 insertions(+), 31 deletions(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 94ad3f711e..fff23112ea 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -187,50 +187,43 @@ The ability to copy and paste text to or from SRE workspaces via the Guacamole c These options have no impact on the ability to use copy and paste within a workspace. The impact of setting each of these options is detailed in the below table. - - - - + +
Configuration of copy and paste#
+ - - - + + + - - - - - - - - - + + + + + + + - + + - - + - + - + - + @@ -238,17 +231,14 @@ The impact of setting each of these options is detailed in the below table. - + -
Configuration of copy and paste#
Configuration settingResulting behaviour
Configuration settingResulting behaviour
allow_copyallow_pasteCopy/paste within workspaceCopy/paste between workspacesCopy to local machinePaste from local machine
allow_copyallow_pasteCopy/paste within workspaceCopy/paste between workspacesCopy to local machinePaste from local machine
true truetrue yes yes yes yes
truefalsefalse yes no yes no
falsetruetrue yes no no
falsefalsefalse yes no no no
- - -::: + ## Upload the configuration file From 0912f7a57d584c39e00a2117526c873ea8a9c3d9 Mon Sep 17 00:00:00 2001 From: Jim Madge Date: Thu, 31 Oct 2024 14:52:58 +0000 Subject: [PATCH 13/14] Change grammar --- docs/source/deployment/deploy_sre.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index fff23112ea..184eae255c 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -186,7 +186,7 @@ The ability to copy and paste text to or from SRE workspaces via the Guacamole c `allow_paste` allows users to paste text into an SRE workspace from the Guacamole clipboard. These options have no impact on the ability to use copy and paste within a workspace. -The impact of setting each of these options is detailed in the below table. +The impact of setting each of these options is detailed in the following table. From 0243ae588181fa669f68d64f89c0a082fa177516 Mon Sep 17 00:00:00 2001 From: Jim Madge Date: Thu, 31 Oct 2024 14:54:31 +0000 Subject: [PATCH 14/14] Add note for inter-workspace copy/paste --- docs/source/deployment/deploy_sre.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 184eae255c..5157de2267 100644 --- a/docs/source/deployment/deploy_sre.md +++ b/docs/source/deployment/deploy_sre.md @@ -209,7 +209,7 @@ The impact of setting each of these options is detailed in the following table. - +
Configuration of copy and paste#
true true yesyesyes (via local machine) yes yes