Globus Connect Server Endpoint Setup

Name

globus-connect-server endpoint setup - Create a new Globus Connect Server Endpoint

Synopsis

globus-connect-server endpoint setup -c CLIENT-ID -o OWNER --contact-email ADDRESS DISPLAY_NAME [OPTIONS]…​

Description

The globus-connect-server endpoint setup command provides a command-line interface to creating a new Globus Connect Server v5.4 endpoint. Before using this command, you must first obtain credentials from https://auth.globus.org/v2/web/developers. You will need to provide the Client Id and Secret to this tool in order to create the endpoint.

At the bare minimum, you must supply the -c, -o, --organization, with their arguments and a display name, but you may use some of the other parameters. Many of these are used by the Globus web page to help your users find your endpoint in order to use your storage. The more information you supply the more meaningful the search results will be, and the more useful your endpoint will be for your users.

When you invoke this command with its required arguments, it will create an endpoint for the client with the information you’ve provided. This process takes several minutes to complete, as it registers a domain name for your endpoint and also obtains a host certificate that can be used for interaction with the endpoint, its managed data, and its configuration API.

Upon completion, it will create a file called deployment-key.json (by default). This file is important. It must be kept in order to be able to deploy the Globus services for this endpoint on a Data Transfer Node. It must also be kept confidential, as it can be used to unlock the data key used to encrypt your endpoint’s configuration.

After running this command, the most common next step is to use the globus-connect-server node setup command to configure the Globus services on a data transfer nodes to make the endpoint usable.

Options

-h, --help

Show a help message and exit.

--version

Show the version and exit.

-c, --client-id CLIENT_ID (required)

Auth Client ID for this Globus Connect Server Endpoint. See https://auth.globus.org/v2/web/developers to create this ID.

-o, --owner USERNAME (required)

Identity username of the owner of this endpoint (e.g. janedoe@example.edu). This must be a valid identity username in Globus Auth. The user who owns identity will be granted the owner role on this endpoint, which will allow them to create and view storage gateway configuration for this endpoint.

--organization ORGANIZATION

Organization that owns this endpoint

-d, --deployment-key PATH

Path for deployment key configuration. If this file exists, it will be loaded and used as the source for the deployment key (for example, if you had previously run this command but interrupted it). If it doesn’t exist, then a new deployment key is created and stored in this file. By default the value deployment-key.json is used.

--keywords KEYWORD,…​

Comma-separated list of keywords to help searches for this endpoint.

--department DEPARTMENT

Department within the organization that runs the Data Transfer Nodes.

--contact-email ADDRESS (required)

Email address of the support contact for the Data Transfer Nodes serving this endpoint.

--contact-info INFO

Other non-email contact information for the endpoint, e.g. phone and mailing address.

--info-link URL

Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it"s accepting public connections.

--description DESCRIPTION

Description of this endpoint.

--public / --private

Set the Endpoint to be public or private.

Example

This invocation creates an endpoint using the client_id stored in the $CLIENT_ID environment variable, setting admin@example.org as the endpoint owner, with the endpoint’s organization set to Example Organization and its display name set to Example Endpoint. If you are planning on setting up your own endpoint, use your own Globus username as the owner and a meaningful organization and display name.

globus-connect-server endpoint setup "Example Endpoint"\
    -c $CLIENT_ID \
    -o admin@example.org \
    --contact-email support@example.org \
    --organization "Example Organization"