Architects & Operators: Start Here¶
This section is primarily for architects, who decide whether to adopt GA4GH products and patterns, and also for operators, who want their Node safe and to keep controlling access to their resources. It shows how a Node runs a TES service in the ELIXIR On-Cloud federation and how it connects to the deployment's other services.
What these docs cover
These docs cover the ELIXIR On-Cloud sandbox/demo deployment, how to integrate with it, and tutorials, for architects and operators, partners and developers, and researchers. Generic instructions for installing and using the individual products are in each product's own docs, linked from here.
What a Node runs¶
A compute Node offers compute and storage to the federation:
- Compute: at least one GA4GH Task Execution Service (TES) or Workflow Execution Service (WES) in front of the Node's cluster, which requires access tokens of LS Login: e.g., TESK or Poiesis on Kubernetes, Funnel on an HPC or HTC cluster.
- Storage: an S3 or FTP server that the TES service uses for the input and output files of tasks.
- Registration: the Node's services are registered in the Cloud Registry of the deployment, so that others can find them.
A Node can also run the other services of the deployment.
Who can join¶
These pages are for compute Nodes. A compute Node joins the federation with at least one TES or WES service that requires LS Login access tokens, and registers it in the Cloud Registry. Data nodes, which offer cloud storage or data through the GA4GH DRS API, may join too: their requirements will follow. Tutorial: Onboard a Data Centre shows what they can offer today. Write to the admins at cloud-service@elixir-europe.org before you start.
Steps to join¶
- Read Onboarding.
- Deploy a TES or WES service and a storage server at your Node.
- Register your service in the Cloud Registry.
- Optional: deploy more services, and connect your own services to LS Login.
Pages in this section¶
| Page | What it covers |
|---|---|
| Onboarding | The steps for a Node to join the federation. |
| Tutorial: Onboard a Node | Step by step, from a cluster to a registered, verified TES service behind the gateway. |
| Tutorial: Onboard a Data Centre | Step by step, from a cluster to storage for tasks and a registered, verified TRS service. |
| Cloud Registry | The settings of the deployment's registry, for the admins who run it. |
| Using the Cloud Registry | How to look up, register and maintain services, and what the labels mean. |
| Using the Cloud Registry UI | How to log in to the registry's front end, who has which rights, and whom to ask. |
| LS Login | How to connect JupyterHub, HedgeDoc and MinIO to LS Login. |
| Services | The services of the deployment and their role. |