search

uabrc / uabrc.github.io

UAB Research Computing Documentation
https://docs.rc.uab.edu
21 stars 12 forks source link

Globus shared collections #785

Closed wwarriner closed 2 weeks ago

wwarriner commented 3 weeks ago

What would you like to see added?

Add information on how to share collections in Globus (https://docs.rc.uab.edu/data_management/transfer/globus/).

This should include the following information. We might do this in a different order, depending on what makes most logical sense.

  1. How to create a collection from an endpoint
  2. How to share a collection with other users
    • For personal endpoints...
      • How to enable sharing specific directories via personal endpoints
      • Sharing from personal endpoints requires a Globus Plus subscription. This can be achieved by being part of the UAB (HA) subscription group. See how to request below.
  3. How to request addition to the UAB (HA) group to enable sharing.
    • Must use the Globus method of making the request.
    • Must also create a support request via our support email indicating the request has been made. This helps us verify legitimate requests.
    • The support request should include justification for needing to share a collection.
wwarriner commented 2 weeks ago

More information for this, taken from a ticket.

The process for changing the path is straightforward, but I don't have the best documentation for it right now. Let me attempt to walk you through the process here:

  1. Ensure Globus Connect Personal (GCP) is running on your computer.

  2. Find the Globus application in your System Tray (Windows) or Menulet (MacOS). It should look like a circle with a lower-case "g" character in it.

  3. Right-click the icon to open the context-menu and click "Options..." (Windows) or "Preferences..." (MacOS) to open a dialog box.

  4. Click the "Access" tab. From here you can manage which folders are available on the endpoint.

  5. On Windows click the plus "+" button to add a new folder to the list, and the hyphen or minus "-" button to remove a folder.

  6. To share a folder with other users you MUST click check the "Shareable" box for that folder.

  7. The "Writeable" checkbox allows others to modify the contents of the folder. Leave this unchecked if you want the folder to be read-only on the endpoint.

  8. When finished managing folders, click the "Save" button to save your changes and exit the dialog box.

We highly recommend not sharing the endpoint directly. Instead, create a Guest Collection from the endpoint, then share the Guest Collection.

  1. Log in to https://app.globus.org
  2. Click the "Collections" button on the left-hand menu.
  3. Find your collection using the search bar, or by clicking "dminstered by You".
  4. Click the Endpoint in the list to open its properties menu.
  5. Click the "Collections" tab at the top.
  6. Click the "Add Guest Collection" button.
  7. Select the directory to share. I am reasonably confident about what's listed below, but you may have to experiment with these a little to be sure you've picked the right directories before sharing with other researchers.
    • Note that the default is "/", which is the first folder being shared on the endpoint. This is what you picked in the previous set of instructions. From "/" you can narrow it down to a sub-folder.
    • If you shared "/data/share/" on your GCP computer, that would be "/" in the directory field. Then if you wanted to share "/data/share/experiment1" you would put "/experiment1".
    • You can also pick a different folder that was shared above, if more than one is shared. So if you also shared "/data/share2" in GCP, you would type the full path as "/data/share2".
  8. Add other metadata like a Display Name and Description, and click "More Fields" to see others.
  9. Click "Create Collection" when done, to create the collection.
  10. You should be taken to the "Permissions" tab for the collection you just created.
  11. To share with others, click "Add Permissions -- Share With" and fill out the form.

We highly recommend limiting shares with only necessary collaborators for that particular data, to maximize security. You can create multiple collections, each pointing to specific subfolders, to share with separate collaborators. This will help control access.

wwarriner commented 2 weeks ago

Closing in favor of #800