Skip to content

Commit

Permalink
Merge pull request #690 from isb-cgc/Remove-SA-Registration
Browse files Browse the repository at this point in the history
Remove sa registration
  • Loading branch information
DeenaBleich committed Sep 9, 2022
2 parents f091370 + 5fff2a1 commit 79c179a
Show file tree
Hide file tree
Showing 14 changed files with 105 additions and 268 deletions.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The `ISB-CGC <https://isb-cgc.org>`_ aims to serve the needs of a broad range of
sections/SyntheticLethality_resource
sections/ProgrammaticAccess
sections/data/TCGA_Data_Security
sections/Gaining-Access-To-Controlled-Access-Data
sections/Gaining-Access-To-Controlled-Access-Data

.. toctree::
:hidden:
Expand Down
58 changes: 3 additions & 55 deletions docs/source/sections/Gaining-Access-To-Controlled-Access-Data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,11 @@
Accessing Controlled Data
************************************************

You can gain access to **controlled data** by two different methods via ISB-CGC. The methods can be used simultaneously if needed.

Select this method for `controlled access via personal user credentials <controlled-access/Controlled-data-Interactive.html>`_:
In ISB-CGC, you can gain access to `controlled data via personal user credentials <controlled-access/Controlled-data-Interactive.html>`_:

* Provides access to controlled data for 24 hours at a time;
* Uses your *personal* credentials;
* Example uses: the ISB-CGC Web App, R Studio or running short jobs on Google Compute Engine that complete in under 24 hours

Select this method for `controlled access via service account credentials <controlled-access/Controlled-data-GCP.html>`_:

* Provides access to controlled data for seven days at a time;
* Uses the credentials of a *service account*, acting on your behalf (To learn about service accounts, refer to the Google `documentation <https://cloud.google.com/iam/docs/service-accounts>`_.);
* Example uses: using a Google Cloud Project; running a program from a Google Compute Engine (GCE) Virtual Machine (VM) that takes longer than 24 hours to complete

.. note:: If you are looking to gain access to COSMIC data, please see the `COSMIC documentation <data/COSMIC_about.html>`_.

Expand Down Expand Up @@ -56,8 +48,7 @@ For more information on applying for dbGaP authorization to access controlled da
this dbGap How to Video: `Apply for Controlled Access Data <http://www.youtube.com/watch?v=-3tUBeKbP5c>`_.

For additional information, refer to `Tips for Preparing a Successful Data Access Request <https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/GetPdf.cgi?document_name=GeneralAAInstructions.pdf>`_,
and `Understanding Data Security <data/TCGA_Data_Security.html>`_. Please be sure to review the Data Use Certification Agreement for `TCGA controlled data <https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/study.cgi?study_id=phs000178.v9.p8>`_ and `TARGET controlled data <https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/study.cgi?study_id=phs000218.v17.p6>`_.

and `Understanding Data Security <data/TCGA_Data_Security.html>`_. Please be sure to review any pertinent Data Use Certification Agreements on dbGaP.

4) Link your NIH/eRA and Google identities.
+++++++++++++++++++++++++++++++++++++++++++
Expand Down Expand Up @@ -87,53 +78,10 @@ These prerequisite steps only need to be done once, unless your accounts become
Controlled Access Via Personal User Credentials
-----------------------------------------------

The first time that you perform the above steps, you are automatically granted controlled access via your personal uer credentials. This access lasts for 24 hours, though it can be extended. Subsequently, to obtain access, sign into the Web App, click on your persona (or **Account Details** on the drop down menu next to your name). Click the **Get Controlled Access** button below **Obtain controlled access for 24 hours**.
The first time that you perform the above steps, you are automatically granted controlled access via your personal user credentials. This access lasts for 24 hours, though it can be extended. Subsequently, to obtain access, sign into the Web App, click on your persona (or **Account Details** on the drop down menu next to your name). Click the **Get Controlled Access** button below **Obtain controlled access for 24 hours**.

.. image:: controlled-access/DataAccess-24hours.png
:align: center


Controlled Access Via Service Account Credentials
-------------------------------------------------

To access controlled data programmatically, such as through Google Cloud or when running a VM, you'll need to register a GCP and service account. Follow these steps:

* `Registering a Google Cloud Project & Service Account <controlled-access/Controlled-data-GCP.html>`_

.. toctree::
:maxdepth: 1
:hidden:

controlled-access/Controlled-data-GCP


Controlled Access in the Google BigQuery Console
------------------------------------------------------

The BigQuery project "isb-cgc-cbq" contains the ISB-CGC controlled access data which is stored in BigQuery tables. To obtain access to these ISB-CGC tables within the Google BigQuery Console, you must link to them within the BigQuery Console. Before doing so, you must have followed all the prerequisites above, including `linking your Google identity to your NIH/eRA account <controlled-access/Controlled-data-Interactive.html>`_ via the ISB-CGC Web App.

When you access BigQuery from your Google Cloud Platform Console (see `here <progapi/bigqueryGUI/HowToAccessBigQueryFromTheGoogleCloudPlatform.html>`_ for more information on this), you will be presented with the following page:

.. image:: progapi/bigqueryGUI/BlueArrowDropdown.PNG
:scale: 25
:align: center

The blue arrow will produce a drop down list; select 'Switch to Project'; then click 'display project...'

You will then be presented with the following page:

.. image:: progapi/bigqueryGUI/SearchProjectSection.PNG
:scale: 25
:align: center

As shown in the image below you will need to type in "isb-cgc-cbq" in the project id and then click okay.

.. image:: progapi/bigqueryGUI/CABQisb-cgc-pinning.PNG
:scale: 25
:align: center

Once this has been completed you will be able to see the appropriate controlled access ISB-CGC BigQuery data sets on the left hand side (see screenshot below).

.. image:: progapi/bigqueryGUI/isb-cgc-cbq_tablename.PNG
:scale: 25
:align: center
1 change: 1 addition & 0 deletions docs/source/sections/Web-UI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Over time we will be updating and enhancing this web interface based on your fee
webapp/GraphingUserData
webapp/IGV-Browser
webapp/OsimisWebViewer
webapp/Register-GCP

**Data used by the Web App**

Expand Down
203 changes: 0 additions & 203 deletions docs/source/sections/controlled-access/Controlled-data-GCP.rst

This file was deleted.

0 comments on commit 79c179a

Please sign in to comment.