diff --git a/docs/source/deployment/deploy_sre.md b/docs/source/deployment/deploy_sre.md index 2a1e5511a7..5157de2267 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,22 +62,31 @@ 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. ::: :::: -:::{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 @@ -111,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. ::: @@ -164,6 +176,70 @@ 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. + +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 following table. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Configuration of copy and paste#
Configuration settingResulting behaviour
allow_copyallow_pasteCopy/paste within workspaceCopy/paste between workspacesCopy to local machinePaste from local machine
truetrueyesyes (via local machine)yesyes
truefalseyesnoyesno
falsetrueyesnonoyes
falsefalseyesnonono
+ ## Upload the configuration file - Upload the config to Azure. This will validate your file and report any problems. diff --git a/docs/source/roles/researcher/using_the_sre.md b/docs/source/roles/researcher/using_the_sre.md index 51a7b60abf..1620a8f717 100644 --- a/docs/source/roles/researcher/using_the_sre.md +++ b/docs/source/roles/researcher/using_the_sre.md @@ -48,6 +48,13 @@ 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 not possible. + ## {{books}} Maintaining an archive of the project SREs are designed to be ephemeral and only deployed for as long as necessary.