Skip to content
Snippets Groups Projects
Commit 9cba5a54 authored by eharstad's avatar eharstad
Browse files

updating globus docs

parent e37462df
No related branches found
No related tags found
1 merge request!323updating globus docs
Showing
with 83 additions and 82 deletions
......@@ -36,14 +36,14 @@ more error-prone methods such as scp and winSCP. 
Users must first sign up for an account on
the <a href="https://www.globusid.org/create" class="external-link">Globus Connect website</a> or may use their NU credentials to sign in without creating a separate Globus ID.
Accounts are free and grant users access to any Globus endpoint for
which they are authorized. An endpoint is simply a file system to or
Accounts are free and grant users access to any Globus collection for
which they are authorized. A collection is simply a file system to or
from which a user transfers files. All HCC users are authorized to
access their own /home, /work, and /common directories on Crane via the Globus endpoints (named: `hcc#crane`). Those who have purchased Attic storage space can
access their /attic directories via the Globus endpoint hcc\#attic. To
initialize or activate the endpoint, users will be required to enter
access their own /home, /work, and /common directories on Crane and Swan via the Globus collections (named: `hcc#crane` and `hcc#swan`). Those who have purchased Attic storage space can
access their /attic directories via the Globus collection `hcc#attic`. To
initialize or activate the collection, users will be required to enter
their HCC username, password, and Duo credentials for authentication.
The steps involved in activating endpoints and making data transfers
The steps involved in activating collections and making data transfers
are detailed in the following links. Please contact us at <a href="mailto:hcc-support@unl.edu" class="external-link">hcc-support@unl.edu</a> if you encounter any difficulties.
---
......@@ -52,10 +52,10 @@ are detailed in the following links. Please contact us at <a href="mailto:hcc-s
- [Log into Globus](https://app.globus.org) (do this first!)
- [Activating HCC
Endpoints]({{< relref "activating_hcc_cluster_endpoints" >}})
Collections]({{< relref "activating_hcc_cluster_endpoints" >}})
- [File Transfers Between
Endpoints]({{< relref "file_transfers_between_endpoints" >}})
Collections]({{< relref "file_transfers_between_endpoints" >}})
- [File Transfers to/from Personal
Workstations]({{< relref "file_transfers_to_and_from_personal_workstations" >}})
......
+++
title = "Activating HCC Cluster Endpoints"
description = "How to activate HCC endpoints on Globus"
title = "Activating HCC Cluster Collections"
description = "How to activate HCC collections on Globus"
weight = 20
+++
You will not be able to transfer files to or from an HCC endpoint using Globus Connect without first activating the endpoint. Endpoints are available for Crane (`hcc#crane`), Swan, (`hcc#swan`), and Attic (`hcc#attic`). Follow the instructions below to activate any of these endpoints and begin making transfers.
You will not be able to transfer files to or from an HCC collection using Globus Connect without first activating the collection. Collections are available for Crane (`hcc#crane`), Swan, (`hcc#swan`), and Attic (`hcc#attic`). Follow the instructions below to activate any of these collections and begin making transfers.
1. [Sign in](https://app.globus.org) to your Globus account using your campus credentials or your Globus ID (if you have one). Then click on 'Endpoints' in the left sidebar.
{{< figure src="/images/Glogin.png" >}}
{{< figure src="/images/endpoints.png" >}}
1. [Sign in](https://app.globus.org) to your Globus account using your campus credentials or your Globus ID (if you have one). If you use CILogo to authenticate, you will be redirected to your local campus/facility authentication page (UNL in this example) to enter your campus credentials. Once you've authenticated, you will be redirected back to your Globus dashboard.
{{< figure src="/images/globus_login.png" >}}
Then click on 'Collections' in the left sidebar.
{{< figure src="/images/globus_click_collections.png" >}}
2. Find the endpoint you want by entering '`hcc#crane`', '`hcc#swan`', or '`hcc#attic`' in the search box and hit 'enter'. Once you have found and selected the endpoint, click the green 'activate' icon. On the following page, click 'continue'.
{{< figure src="/images/activateEndpoint.png" >}}
{{< figure src="/images/EndpointContinue.png" >}}
2. Find the collection you want by entering '`hcc#crane`', '`hcc#swan`', or '`hcc#attic`' in the search box and hit 'enter'. Once you have found and selected the collection, click the green 'activate' icon. On the following page, click 'continue'.
{{< figure src="/images/globus_click_activate_icon.png" >}}
{{< figure src="/images/globus_click_activate_continue.png" >}}
3. You will be redirected to the HCC Globus Endpoint Activation page. Enter your *HCC* username and password (the password you usually use to log into the HCC clusters).
{{< figure src="/images/hccEndpoint.png" >}}
......@@ -23,16 +25,16 @@ You will not be able to transfer files to or from an HCC endpoint using Globus C
the activation will be complete. If you use a Yubikey for
authentication, select the 'Passcode' option and then press your
Yubikey to complete the activation. Upon successful activation, you
will be redirected to your Globus *Manage Endpoints* page.
will be redirected to your Globus *File Manager* page.
{{< figure src="/images/EndpointPush.png" >}}
{{< figure src="/images/endpointComplete.png" >}}
{{< figure src="/images/globus_collection_activated.png" >}}
The endpoint should now be ready
The collection should now be ready
and will not have to be activated again for the next 7 days.
To transfer files between any two HCC clusters, you will need to
activate both endpoints individually.
activate both collections individually.
Next, learn how to [make file transfers between HCC endpoints]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_between_endpoints" >}}) or how to [transfer between HCC endpoints and a personal computer]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_to_and_from_personal_workstations" >}}).
Next, learn how to [make file transfers between HCC collections]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_between_endpoints" >}}) or how to [transfer between HCC collections and a personal computer]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_to_and_from_personal_workstations" >}}).
---
......
......@@ -5,7 +5,7 @@ weight = 60
+++
A Globus Connect group is simply a group of individual Globus users.
Groups are useful when you want to create a shared endpoint and give
Groups are useful when you want to create a shared collection and give
the same permissions to several different users. To create a group, you
simply choose a group name and invite whomever you want to join. You
will have complete control over the group enrollment as well as the role
......@@ -13,24 +13,24 @@ and status of each member.
1. To get started, select the 'Groups' tab from the left sidebar of your Globus
home page. Click on 'Create New Group' in the top right corner of the page.
{{< figure src="/images/newGroup.png" >}}
{{< figure src="/images/globus_new_group.png" >}}
2. Once you have entered a unique group name and description, click
'Create Group'.
{{< figure src="/images/createGroup.png" >}}
{{< figure src="/images/globus_create_group.png" >}}
3. To invite Globus users to join the group, select the 'Groups' tab on the left-hand side of the page.
Then select the group name, and then 'Invite Others'.
{{< figure src="/images/InviteOthers.png" >}}
{{< figure src="/images/globus_invite_others.png" >}}
4. You will be able to enter the invitee's email address directly,
or search for them using their Globus user name. Once you have entered or selected
the user, click the 'Send Invitation' button.
{{< figure src="/images/sendInvitation.png" >}}
{{< figure src="/images/globus_send_invitation.png" >}}
5. You can check the status of members by selecting the 'group' tab from your homepage,
selecting the group, and then selecting the 'members' tab
{{< figure src="/images/members.png" >}}
{{< figure src="/images/globus_group_members.png" >}}
---
......@@ -5,7 +5,7 @@ weight = 50
+++
If you would like another colleague or researcher to have access to your
data, you may create a shared endpoint on Crane, Swan, or Attic. You can personally manage access to this endpoint and
data, you may create a shared collection on Crane, Swan, or Attic. You can personally manage access to this collection and
give access to anybody with a Globus account (whether or not
they have an HCC account). *Please use this feature responsibly by
sharing only what is necessary and granting access only to trusted
......@@ -17,35 +17,35 @@ creating shares in your `home` directory.
{{% /notice %}}
1. Sign in to your Globus account, click on the 'File Manager' tab
and search for the endpoint that you will use to host your shared
endpoint. For example, if you would like to share data in your
Crane `work` directory, search for the `hcc#crane` endpoint. Once
you have found the endpoint, it will need to be activated if it has
not been already (see [endpoint activation instructions
and search for the collection that you will use to host your shared
collection. For example, if you would like to share data in your
Crane `work` directory, search for the `hcc#crane` collection. Once
you have found the collection, it will need to be activated if it has
not been already (see [collection activation instructions
here]({{< relref "activating_hcc_cluster_endpoints" >}})).
If it is already activated, select the endpoint by clicking on the
If it is already activated, select the collection by clicking on the
name. Then select the 'share' button on the right sidebar.
{{< figure src="/images/sharedEndpoint.png" >}}
{{< figure src="/images/shareButton.png" >}}
{{< figure src="/images/globus_share_select.png" >}}
{{< figure src="/images/globus_share_share.png" >}}
2. Click on 'Add a Guest Collection'. In the 'Path' box, enter the full path to the directory you
would like to share. Only files under this directory will be shared
to the endpoint users you grant access. Enter a descriptive endpoint
name and provide a
short description of the endpoint if you wish. Finally, click 'Create Share'.
{{< figure src="/images/createShare.png" >}}
to the users you grant access. Enter a name for the collection and provide a
short description if you wish. Finally, click 'Create Share'.
{{< figure src="/images/globus_create_share.png" >}}
3. To share the endpoint with someone, click on 'Add Permissions -- Share With'. Next enter the *relative path* of the
3. To share the collection with someone, click on 'Add Permissions -- Share With' under the 'Permissions' tab for the shared collection you just created. Next enter the *relative path* of the
directory that this user should be able to access. For example, if
the source path of your shared endpoint
is `/work/<groupid>/<userid>/share` but you would like your
the source path of your shared collection
is `/work/<groupid>/<userid>` but you would like your
colleague to only have access
to `/work/<groupid>/<userid>/share/dataX`, then the 'Path' should be
entered as simply `/dataX`. Under 'Username or Email' type the Globus ID (or group name if you have selected 'group') of the user (or group) to whom you would like to grant
to `/work/<groupid>/<userid>/share`, then the 'Path' should be
entered as simply `/share`. Under 'Username or Email' type the Globus ID (or group name if you have selected 'group') of the user (or group) to whom you would like to grant
access. Finally, click the blue 'Add Permission' button.
You should see the user or group added to the list.
{{< figure src="/images/addPermission.png" >}}
{{< figure src="/images/sharedGroup.png" >}}
{{< figure src="/images/globus_share_with.png" >}}
{{< figure src="/images/globus_add_permission.png" >}}
{{< figure src="/images/globus_permission_added.png" >}}
---
......
+++
title = "File Transfers Between Endpoints"
title = "File Transfers Between Collections"
description = "How to transfer files between HCC clusters using Globus"
weight = 30
+++
To transfer files between HCC clusters, you will first need to
[activate]({{< relref "/handling_data/data_transfer/globus_connect/activating_hcc_cluster_endpoints" >}}) the
two endpoints you would like to use (the available endpoints
two collections you would like to use (the available collections
are: `hcc#crane` `hcc#swan`, and `hcc#attic`). Once
that has been completed, follow the steps below to begin transferring
files. (Note: You can also transfer files between an HCC endpoint and
any other Globus endpoint for which you have authorized access. That
files. (Note: You can also transfer files between an HCC collection and
any other Globus collection for which you have authorized access. That
may include a [personal
endpoint]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_to_and_from_personal_workstations" >}}),
collection]({{< relref "/handling_data/data_transfer/globus_connect/file_transfers_to_and_from_personal_workstations" >}}),
a [shared
endpoint]({{< relref "/handling_data/data_transfer/globus_connect/file_sharing" >}}),
or an endpoint on another computing resource or cluster. Once the
endpoints have been activated, the file transfer process is generally
the same regardless of the type of endpoints you use. For demonstration
purposes we use two HCC endpoints.)
collection]({{< relref "/handling_data/data_transfer/globus_connect/file_sharing" >}}),
or a collection on another computing resource or cluster. Once the
collections have been activated, the file transfer process is generally
the same regardless of the type of collections you use. For demonstration
purposes we use two HCC collections.)
1. Once both endpoints for the desired file transfer have been
1. Once both collections for the desired file transfer have been
activated, [sign in](https://app.globus.org) to
your Globus account (if you are not already) and select
"Transfer or Sync to.." from the right sidebar. If you have
your Globus account (if you are not already) and select the *File Manager* tab from the left sidebar, and then select *Transfer or Sync to...* from the right sidebar. If you have
a small screen, you may have to click the menu icon
first.
{{< figure src="/images/Transfer.png">}}
{{< figure src="/images/globus_select_transfer.png">}}
2. Enter the names of the two endpoints you would like to use, or
select from the drop-down menus (for
example, `hcc#attic` and `hcc#crane`). Enter the
2. In the two "Collection" text boxes, enter the names of the two collections you would like to use (for example, `hcc#attic` and `hcc#crane`). Alternatively, you can select from one of your recently used, bookmarked, owned, or shared collections that are pulled up when you click on the text box to enter your search. Enter the
directory paths for both the source and destination (the 'from' and
'to' paths on the respective endpoints). Press 'Enter' to view files
'to' paths on the respective collections). Press 'Enter' to view files
under these directories. Select the files or directories you would
like to transfer (press *shift* or *control* to make multiple
selections) and click the blue highlighted arrow to start the
transfer.
{{< figure src="/images/startTransfer.png" >}}
{{< figure src="/images/globus_start_transfer.png" >}}
3. Globus will display a message when your transfer has completed
(or in the unlikely event that it was unsuccessful), and you will
also receive an email. Select the 'refresh' icon to see your file
in the destination folder.
{{< figure src="/images/transferComplete.png" >}}
3. Globus will display a message that your transfer was submitted successfully, and you can click on "View details" in this message to see the status of the transfer. You will also receive an email when the transfer has completed (this is especially helpful in the case of large, long-duration transfers). Finally, to see your newly transferred file(s) in the destination folder, select the "refresh list" icon for that collection.
{{< figure src="/images/globus_refresh_list.png" >}}
---
......
......@@ -7,31 +7,31 @@ weight = 40
*Globus Connect Personal* allows you to transfer files to and from your
personal computer. Once this software is installed, file transfers are
simple and proceed in much the same way as transfers between HCC
endpoints.
collections.
1. Install [Globus Connect Personal](https://www.globus.org/globus-connect-personal) on your computer. Follow the
detailed instructions for your operating system provided in the
links below:
- [Mac](https://docs.globus.org/how-to/globus-connect-personal-mac/) (Intel - OS X 10.4 or higher)
- [Mac](https://docs.globus.org/how-to/globus-connect-personal-mac/) (Intel - OS X 10.9 or higher)
- [Linux](https://docs.globus.org/how-to/globus-connect-personal-linux/) (x86-based)
- [Windows](https://docs.globus.org/how-to/globus-connect-personal-windows/) (7, 8, and 10)
2. Once Globus Connect Personal
has been successfully installed, your personal endpoint will show up
in the 'Administered by You' section of the 'Endpoints' tab of
your Globus home page. This endpoint is private by default, and
has been successfully installed, your personal collection will show up
in the 'Administered by You' section of the 'Collections' tab of
your Globus home page. This collection is private by default, and
therefore not visible or accessible to other Globus users.
{{< figure src="/images/endpointAdmin.png" >}}
{{< figure src="/images/globus_personal_collection.png" >}}
3. Make transfers to and from
your personal endpoint just as you would from a public endpoint.
your personal collection just as you would from a public collection.
From your Globus account, select the 'File Manager' tab
from the left sidebar and enter the name of your new endpoint the 'Collection' text box. Press 'Enter' and then
from the left sidebar and enter the name of your new collection in the 'Collection' text box. Press 'Enter' and then
navigate to the appropriate directory. Select "Transfer of Sync to.." from the right sidebar (or select the "two panels"
icon from the top right corner) and Enter the second endpoint (for example: `hcc#crane`, `hcc#swan`, or `hcc#attic`),
icon from the top right corner) and Enter the second collection (for example: `hcc#crane`, `hcc#swan`, or `hcc#attic`),
type or navigate to the desired directory, and initiate the file transfer by clicking on the blue
arrow button.
{{< figure src="/images/PersonalTransfer.png" >}}
{{< figure src="/images/globus_personal_transfer.png" >}}
------------------------------------------------------------------------
......
......@@ -10,6 +10,10 @@ interactively. The CLI allows users to transfer files and manipulate
directory structures on a remote endpoint without use of the web
interface.
{{% notice info %}}
Here, the term "Endpoint" is used instead of "Collection", but in this context they are interchangable. Although Globus has switched to using the term "collection" on the transfer portal, the cli described here still uses "endpoint".
{{% /notice %}}
---
### Connecting to Globus on the Command Line
......
static/images/globus_add_permission.png

211 KiB

static/images/globus_click_activate_continue.png

138 KiB

static/images/globus_click_activate_icon.png

44.6 KiB

static/images/globus_click_collections.png

100 KiB

static/images/globus_collection_activated.png

107 KiB

static/images/globus_create_group.png

87.2 KiB

static/images/globus_create_share.png

212 KiB

static/images/globus_group_members.png

102 KiB

static/images/globus_invite_others.png

83.2 KiB

static/images/globus_login.png

313 KiB

static/images/globus_new_group.png

61.2 KiB

static/images/globus_permission_added.png

253 KiB

static/images/globus_personal_collection.png

72.6 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment