GCS Deploy is a Python utility to automate the full deployment and destruction of a Globus Connect Server endpoint. It sets up a fully functional endpoint with a storage gateway, identity mapping, and mapped collection—all driven by a single configuration JSON file.
Prerequisite: Globus Connect Server v5
For typical usage:
pip install .Once installed, the CLI command gcs-deploy becomes available.
If you're actively developing this package:
pip install -e .This allows local code edits to immediately affect the installed command.
gcs-deploy deploy path/to/config.jsonThis sets up:
- A Globus endpoint
- A registered node
- A storage gateway (POSIX)
- A mapped collection
During the deployment process, you will be prompted to log in manually twice to complete the Globus endpoint registration and authentication steps.
gcs-deploy destroy path/to/config.jsonThis tears down the above setup (in reverse):
- Deletes the mapped collection
- Deletes the storage gateway
- Cleans up the node and endpoint
- Restarts Apache services
During destroy, you will be prompted once for authentication to authorize the removal of the Globus endpoint.
You must provide a JSON file like this:
{
"endpoint_display_name": "AWS-Endpoint",
"organization": "The University of Melbourne",
"owner": "[email protected]",
"contact_email": "[email protected]",
"gateway_name": "My Host Gateway",
"user_domain": "unimelb.edu.au",
"collection_name": "My Collection",
"collection_path": "/home/my-user/",
"deployment_key_path": "deployment-key.json",
"identity_mapping": {
"DATA_TYPE": "expression_identity_mapping#1.0.0",
"mappings": [
{
"source": "{username}",
"match": ".*@unimelb\.edu\.au",
"output": "my-user"
}
]
}
}