Skip to content

Commit

Permalink
Fm fixesjan (#1552)
Browse files Browse the repository at this point in the history 
* Update sd_desktop.md

Spell check 1-3

* Update sd_desktop.md

creation

* Update sd_desktop.md

creation

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

workspace fixed

* Update sd_desktop.md

access to do

* Update sd_desktop.md

* Update sd_desktop.md

Data Gateway fix

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_connect.md

text improved till crypt4gh

* Update sd_connect.md

fixed text until large file for analysis

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

fixed transfer encryption

* Update sd_connect.md

fixed all UI text

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

fixed layout

* Delete SDConnect-segments.png

deprecated

* Add files via upload

crypt4gh

* Add files via upload

large upload

* Update sd_connect.md

added images

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update index.md

* Update index.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

fixed new table

* Update sd_connect.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Create accessing-sd-services

* Update accessing-sd-services

* Rename accessing-sd-services to accessing-sd-services.md

* Update accessing-sd-services.md

* Update accessing-sd-services.md

* Update index.md

* Update accessing-sd-services.md

* Update mkdocs.yml

* Update index.md

* Update mkdocs.yml

Fixing SD service layout

* Update index.md

* Update intro.md

* Update accessing-sd-services.md

* Update accessing-sd-services.md

* Update index.md

* Update accessing-sd-services.md

* Update accessing-sd-services.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update sd_desktop.md

* Update index.md

* Update sd_desktop.md

* Update index.md

* Update accessing-sd-services.md

spelling

* Update sd_connect.md

spelling

* Update index.md

* Rename accessing-sd-services.md to accessingsdservices.md

* Update accessingsdservices.md

* Update sd-desktop-audited.md

* Update sd-desktop-audited.md

* Update sequencing_center_tutorial.md

fixed broken link

* Update index.md

fixed link

* Rename accessingsdservices.md to access.md

* Rename access.md to sd-access.md

* Update mkdocs.yml

fixed link

* Update index.md

link fix

* Update index.md

fix

* Update sd-access.md

Improved text

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd-access.md

* Update sd_desktop.md

* Update mkdocs.yml

fixed titles

* Update sd_desktop.md

fixing note

* Update sd_connect.md

text fixes

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Delete connect_encryption_app.png

* Add files via upload

* Update sd_connect.md

* Delete connect_encryption.png

* Add files via upload

* Update sd_connect.md

* Update sd_connect.md

* Update sd_connect.md

* Update data-new.md

* Update data-new.md

* Update data-new.md

* Update data-new.md

* Update data-new.md

* Update sd-access.md

* Update sd-access.md

* Update sd_connect.md

* Update data-new.md

* Update index.md

* fix what's new header

* fix typo

---------

Co-authored-by: kkmattil <kimmo.mattila@csc.fi>
Co-authored-by: Henrik Nortamo <40563680+Nortamo@users.noreply.github.com>
Co-authored-by: Rasmus Kronberg <43936697+rkronberg@users.noreply.github.com>
  • Loading branch information
@fmorelloCSC @kkmattil
@Nortamo @rkronberg
4 people authored Feb 2, 2023
1 parent 9c09234 commit 807ddcd
Show file tree
Hide file tree
Showing 12 changed files with 531 additions and 303 deletions.
Binary file removed docs/data/sensitive-data/images/connect/SDConnect-segments.png
View file
Binary file not shown.
Binary file added docs/data/sensitive-data/images/connect/connect_encryption_large.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/data/sensitive-data/images/connect/connect_encryption_large_upload.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 48 additions & 43 deletions docs/data/sensitive-data/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sensitive Data Services for research: user guide
# Sensitive Data (SD) Services for research: user guide

This guide, in CSC Docs, introduces CSC's Sensitive Data (SD) services. To navigate the CSC user guide, click on the topics on the left-hand side of the navigation bar or use the search functionality. Below you can find an overview of the contents related to Sensitive Data Services.

Expand All @@ -7,43 +7,48 @@ This guide, in CSC Docs, introduces CSC's Sensitive Data (SD) services. To navig


## [Introduction](./intro.md)
* [**Introduction to the user guide**](./intro.md#introduction-to-the-user-guide)
* [**Introduction to the services**](./intro.md#introduction-to-the-services)
* [**Legal agreements**](./intro.md#legal-agreements)
* [**Useful terminology**](./intro.md#useful-terminology)
* [Introduction to the user guide](./intro.md#introduction-to-the-user-guide)
* [Introduction to the services](./intro.md#introduction-to-the-services)
* [Legal agreements](./intro.md#legal-agreements)
* [Useful terminology](./intro.md#useful-terminology)


## [Applying for SD services access](./intro.md#applying-for-sd-services-access)
## [Applying for SD services access](./sd-access.md)

* [For research data processing](./sd-access.md#processing-sensitive-research-data)
* [For register data processing under the Act on Secondary use](./sd-access.md#processing-register-data-under-the-act-on-secondary-use)
* [Default storage space and billing units consumption](./sd-access.md#default-storage-space-and-billing-units-consumption)


## [Store and share with SD Connect](./sd_connect.md)

* [**Overview**](./sd_connect.md#overview)
* [Overview](./sd_connect.md#overview)

* [**Key features**](./sd_connect.md)
* [Key features](./sd_connect.md)

* [**Authentication**](./sd_connect.md#authentication)
* [Authentication](./sd_connect.md#authentication)

* [**User Interface**](./sd_connect.md#user-interface)
* [User Interface](./sd_connect.md#user-interface)

* [**Introduction to data encryption compatible with sensitive data services**](./sd_connect.md#introduction-to-data-encryption-compatible-with-sensitive-data-services)
* [Introduction to data encryption compatible with sensitive data services](./sd_connect.md#introduction-to-data-encryption-compatible-with-sensitive-data-services)

* [**Data encryption and upload (less than 100 GB)**](./sd_connect.md#sensitive-data-encryption-and-upload-less-than-100-gb) (Default analysis)
* [Data encryption and upload for analysis (less than 1 GB)](./sd_connect.md#sensitive-data-encryption-and-upload-for-analysis-less-than-1-gb) (Default analysis)

* [Data encryption and upload for analysis (up to 100 GB)](./sd_connect.md#sensitive-data-encryption-and-upload-for-analysis-up-to-100-gb)

* [**Data encryption and upload with multiple encryption keys (less than 100 GB)**](./sd_connect.md#sensitive-data-encryption-and-upload-with-multiple-encryption-keys-less-than-100-gb) (Data storage and transfer)
* [Data encryption and upload for storage and sharing (less than 1 GB)](./sd_connect.md#sensitive-data-encryption-and-upload-for-storage-and-sharing-less-than-1-gb) (Data storage and transfer)


* [**Data sharing**](./sd_connect.md#data-sharing)
* [Data sharing](./sd_connect.md#data-sharing)

* [**Data download and decryption**](./sd_connect.md#data-download-and-decryption) (Data storage and transfer)
* [Data download and decryption](./sd_connect.md#data-download-and-decryption) (Data storage and transfer)

* [**Command Line Interface: data encryption and upload:**](./sd_connect.md#command-line-interface-data-encryption-and-upload) (Advanced)
* [Command Line Interface: data encryption and upload](./sd_connect.md#command-line-interface-data-encryption-and-upload) (Advanced)


* [**Command Line Interface: data encryption for data sharing**](./sd_connect.md#command-line-interface-encryption-for-data-sharing) (Advanced)
* [Command Line Interface: data encryption for data sharing](./sd_connect.md#command-line-interface-encryption-for-data-sharing) (Advanced)

* [**Troubleshooting**](./sd_connect.md#troubleshooting)
* [Troubleshooting](./sd_connect.md#troubleshooting)



Expand All @@ -53,57 +58,57 @@ This guide, in CSC Docs, introduces CSC's Sensitive Data (SD) services. To navig

## [Analyse and compute with SD Desktop](./sd_desktop.md)

* [**Overview**](./sd_desktop.md#overview)
* [Overview](./sd_desktop.md#overview)

* [**Key features**](./sd_desktop.md)
* [Key features](./sd_desktop.md)

* [**Authentication**](./sd_desktop.md#authentication)

* [**Setting up a virtual Desktop**](./sd_desktop.md#setting-up-a-virtual-desktop) (Default analysis)
* [Authentication](./sd_desktop.md#authentication)

* [**Working with Desktop**](./sd_desktop.md#working-with-your-virtual-desktop)(Default analysis)
* [Creating your virtual desktop](./sd_desktop.md#creating-your-virtual-desktop) (Default analysis)

* [**Accessing encrypted sensitive data within SD Desktop**](./sd_desktop.md#accessing-encrypted-sensitive-data-within-sd-desktop) (Default analysis)
* [Working with your desktop](./sd_desktop.md#working-with-your-virtual-desktop)(Default analysis)

* [Accessing encrypted sensitive data within SD Desktop](./sd_desktop.md#accessing-encrypted-sensitive-data-within-sd-desktop) (Default analysis)

* [**Default programs available on SD Desktop**](./sd_desktop.md#default-programs-available-on-sd-desktop) (Default analysis)
* [Default programs available on SD Desktop](./sd_desktop.md#default-programs-available-on-sd-desktop) (Default analysis)

* [**Software customization**](./sd_desktop.md#software-customisation) (Advanced)
* [Software customization](./sd_desktop.md#software-customisation) (Advanced)

* [**Data export**](./sd_desktop.md#data-export-from-sd-desktop)
* [Data export](./sd_desktop.md#data-export-from-sd-desktop)

* [**Deleting your virtual Desktop**](./sd_desktop.md#deleting-your-virtual-desktop)
* [Managing volumes and desktops](./sd_desktop.md#managing-volumes-and-virtual-desktops)

* [**Troubleshooting**](./sd_desktop.md#troubleshooting)
* [Troubleshooting](./sd_desktop.md#troubleshooting)


## [SD Desktop for secondary use of health and social data](./sd-desktop-audited.md)
Access to this service requires a Findata permit. There are also [instructions](./single-register-submission.md) for single registers to submit secondary use data for research use in SD services.

* [**Key features**](./sd-desktop-audited.md#key-features)
* [Key features](./sd-desktop-audited.md#key-features)

* [**Before you start**](./sd-desktop-audited.md#before-you-start)
* [Before you start](./sd-desktop-audited.md#before-you-start)

* [**Overview**](./sd-desktop-audited.md#overview)
* [Overview](./sd-desktop-audited.md#overview)

* [**Service access**](./sd-desktop-audited.md#service-access)
* [Service access](./sd-desktop-audited.md#service-access)

* [**Authentication**](./sd-desktop-audited.md#authentication)
* [Authentication](./sd-desktop-audited.md#authentication)

* [**Setting up a virtual Desktop**](./sd-desktop-audited.md#setting-up-a-virtual-desktop)
* [Setting up a virtual Desktop](./sd-desktop-audited.md#setting-up-a-virtual-desktop)

* [**Working with your virtual Desktop**](./sd-desktop-audited.md#working-with-your-virtual-desktop)
* [Working with your virtual Desktop](./sd-desktop-audited.md#working-with-your-virtual-desktop)

* [**Accessing sensitive register data within SD Desktop**](./sd-desktop-audited.md#accessing-sensitive-register-data-within-sd-desktop)
* [Accessing sensitive register data within SD Desktop](./sd-desktop-audited.md#accessing-sensitive-register-data-within-sd-desktop)

* [**Default programs available on the Desktop and software customisation**](./sd-desktop-audited.md#default-programs-available-on-the-desktop-and-software-customisation)
* [Default programs available on the Desktop and software customisation](./sd-desktop-audited.md#default-programs-available-on-the-desktop-and-software-customisation)

* [**Data export from the Desktop**](./sd-desktop-audited.md#data-export-from-the-desktop)
* [Data export from the Desktop](./sd-desktop-audited.md#data-export-from-the-desktop)

* [**Deleting your virtual Desktop**](./sd-desktop-audited.md#deleting-your-virtual-desktop)
* [Deleting your virtual Desktop](./sd-desktop-audited.md#deleting-your-virtual-desktop)

* [**End of data access and data deletion policies**](./sd-desktop-audited.md#end-of-data-access-and-data-deletion-policies)
* [End of data access and data deletion policies](./sd-desktop-audited.md#end-of-data-access-and-data-deletion-policies)

* [**Troubleshooting**](./sd-desktop-audited.md#troubleshooting)
* [Troubleshooting](./sd-desktop-audited.md#troubleshooting)


## **Services in the pilot phase:**
Expand Down
2 changes: 1 addition & 1 deletion docs/data/sensitive-data/intro.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Sensitive Data services for research
# Sensitive Data (SD) Services for research


## Introduction to the user guide
Expand Down
107 changes: 107 additions & 0 deletions docs/data/sensitive-data/sd-access.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Accessing Sensitive Data (SD) Services for research

CSC's Sensitive Data Services are available to researchers and students affiliated with Finnish higher education institutions (universities, universities of applied sciences) or a state research institute.

!!! Note
The legal basis for data processing determines which service component you can access and use. For example, you can directly manage research data access, uploads, or data export using SD Connect and SD Desktop. In contrast, access to register data via SD Desktop is managed by CSC's helpdesk, based on the data permit issued by the Fidata authority and in compliance with the Finnish regulations.

Below is more information on the steps required to access the services:

* for processing research data;
* for processing register data under the Act on Secondary Use;
* storage space (or quota) availability and resource (or billing units) consumption.

You can browse through the guide using the navigation bar on the right side of this page or the search function.



## Processing sensitive research data


To access SD Connect and SD Desktop for storing, sharing or analysing sensitive research data:

1. Create a user account using the [MyCSC](https://my.csc.fi) portal.

2. Create or join a CSC project and add project members.

3. Fill in the _Description of processing activities form_ and accept _CSC's Data Processing Agreement_.

4. All project members should add service access to Allas (to use SD Connect) and SD Desktop, accepting the terms of use.

5. All project members should activate their account's additional security verification (or Multi-factor Authentication) by scanning the QR code with an application (e.g. Google Authenticator).


6. Apply for billing units or disk quota.


For video tutorials and further guidance, check the [Accounts](../../accounts/index.md) paragraph at the beginning of this user guide.

Once you have completed these steps, you can log in with identity federation systems (Haka, Virtu, CSC Login, or LSLogin) at:

* [https://sd-connect.csc.fi](https://sd-connect.csc.fi)

* [https://sd-desktop.csc.fi](https://sd-desktop.csc.fi)


with any modern web-browser (Note: private browsing is not supported using Firefox).


## Processing register data under the Act on Secondary Use

Analysing register data under the Act on Secondary Use differs from the process mentioned above. In this case, CSC's helpdesk manages user's access to the SD Desktop computing environment in compliance with the Finnish Act on the Secondary Use of Health and Social data and the Findata authority's regulation.

Register data can only be provided by the Fidata authority and accessed via the SD Desktop service. For more information about data provided by single registers, contact us at: servicedesk@csc.fi.


!!! Note
Register data processing is subject to several limitations. Therefore, we recommend contacting us at servicedesk@csc.fi (subject: sensitive data) before applying for a data permit to verify if the service matches your needs.

To access and analyse register data via the SD Desktop service:

1. Create [a CSC account](../../accounts/how-to-create-new-user-account.md) by logging in at the [My CSC portal](https://my.csc.fi) with your Haka account. If organization is not a member of the Haka or Virtu federation, contact us at servicedesk@csc.fi. Additional steps will be necessary to verify your identity.

2. Next, apply for a CSC project writing to servicedesk@csc.fi (subject: sensitive data) providing: - a copy of the data permit issued by the Findata authority; - a short description of your research project (name and research field are sufficient); - a list of all the project members, added in cc to the email (please use only organizational email addresses).

3. Each project member should activate the account's additional security verification (or Multi-factor Authentication) by scanning the QR code with a specific application (e.g. Google Authenticator). For further instructions, see the [MFA paragraph](../../accounts/mfa.md) under the Account section on the CSC user guide;


4. Each project member should join the CSC project via the invitation link provided by the service desk and wait for approval;


5. Fill in the [description of data processing activities](../../accounts/when-your-project-handles-personal-data.md) form;


6. All project members should approve [the terms and conditions of SD Desktop service](../../accounts/how-to-add-service-access-for-project.md#member);


For specific guidance regarding these steps, check the [Accounts](../../accounts/index.md) paragraph at the beginning of this user guide.

Note that you need to use your CSC username and password when you access data from your virtual desktop. If you don't remember your CSC password, you can [reset it](../../accounts/how-to-change-password.md) using the MyCSC portal.


## Default storage space and billing units consumption

Using SD Connect and SD Desktop is free of charge for research purposes, according to [CSC's general terms of use](https://research.csc.fi/free-of-charge-use-cases). However, CSC service consumes resources: billing units for their use and quota for storage space allocation. A new CSC project includes about 10,000 billing units. You can find out how many billing units your CSC project will use with this [calculator](https://research.csc.fi/pricing). Here you can estimate the cost in billing units or euros. Once you have calculated how many billing units your project needs yearly, you can apply for more resources.


### SD Connect:

When you apply for a new CSC project and service access for SD Connect/Allas, the default quota (or storage space) for SD Connect is 10 TB, which can be increased to 200 TB if needed. If you work with larger datasets and your project requires additional storage space, contact us for support at servicedesk@csc.fi (subject: sensitive data). Storing data in SD Connect/Allas consumes billing units.

The rate is: 1 units/TiBh, i.e. 1 TB of data stored in Allas consumes 24 Billing units in a day and 8760 BU in a year.

##¤ SD Desktop:

The default disk space (or storage space) in SD Desktop is 80 GB and can be increased to 280 GB by adding an external volume during virtual desktop creation. If you need additional storage space for data analysis, contact us for support at servicedesk@csc.fi (subject: sensitive data).
Analysing data in SD Desktop consumes billing units based on the type of virtual desktop you are using. The rate is:

* Light computation, Billing units; 1.3 BU/h;

* Small computation, Billing Units: 5.2 units/h;

* Medium computation, Billing Units: 10.4 units/h;

* Heavy computation, Billing Units: 52 units/h.


For further guidance on applying for additional quota or billing units, check the [Accounts](../../accounts/index.md) paragraph at the beginning of the user guide.
8 changes: 4 additions & 4 deletions docs/data/sensitive-data/sd-desktop-audited.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

# Sensitive Data Desktop for secondary use of health and social data

Sensitive Data (SD) Desktop is a registered environment for secondary use of health and social data (register data). Access to the service requires a permit from the Findata authority. SD Desktop is a web-user interface that allows you to manage (start, use, delete) a virtual computer (here called Desktop, technically defined as a virtual machine) from your web browser. With the virtual Desktop, you can access the authorised datasets. No previous knowledge of cloud computing or programming expertise is required to use the service.
Sensitive Data (SD) Desktop is a registered environment for secondary use of health and social data (register data). Access to the service requires a permit from the Findata authority. SD Desktop is a web-user interface that allows you to manage (start, use, delete) a virtual computer (here called desktop, technically defined as a virtual machine) from your web browser. With the virtual desktop, you can access the authorised datasets. No previous knowledge of cloud computing or programming expertise is required to use the service.
In the following user guide, you can learn how to:

* apply for service access;
* set up your virtual Desktop;
* set up your virtual desktop;
* analyze data authorised by Findata;
* request export of non-sensitive results from the secure virtual Desktop.
* request export of non-sensitive results from the secure desktop.

!!! Note
We apologise for any confusion caused by the previous name of the service. You can apply to use SD Desktop by sending an application to Findata. This is a restricted version of the service compared to standard SD Desktop.
Expand Down Expand Up @@ -156,7 +156,7 @@ When you log in to SD Desktop **Homepage**, you will be able to access your virt

When you open the connection, a virtual computing environment (Linux Centos operating system) will open into your browser. When you access the virtual Desktop for the first time, you will see the getting started panel, from which you can, for example, adjust the screen resolution.

You can work with this virtual Desktop like in a standard computing environment. From the applications menu bar (top left corner) you can access several pre-installed programs. Examples include Open Office, image viewing applications, video and audio players, Jupiter Notebook etc. You can also open a terminal and use Linux from command line. To start using R-Studio please check [the paragraph](../../data/sensitive-data/sd_desktop.md#rstudio-in-sd-desktop) under SD Desktop.
You can work with this virtual Desktop like in a standard computing environment. From the applications menu bar (top left corner) you can access several pre-installed programs. Examples include Open Office, image viewing applications, video and audio players, Jupiter Notebook etc. You can also open a terminal and use Linux from command line. To start using R-Studio please check [the following paragraph](../../data/sensitive-data/sd-desktop-audited.md#rstudio-in-sd-desktop).


Security-related features of the audited SD Desktop include:
Expand Down
Loading

0 comments on commit 807ddcd

Please sign in to comment.