Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,41 @@ The hook refuses `DOCS_REGISTRY_OFFLINE=1` in CI and on Read the Docs
(where `CI` or `READTHEDOCS` is set), so published builds always show
the services.

### Last verified dates

Pages with operational facts that can't be generated, such as onboarding
steps, access procedures, addresses, versions and contacts, say when
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Resolved
someone last checked those facts against their sources. Their front matter
holds the date, which the page shows at its end (see
[`overrides/partials/content.html`](overrides/partials/content.html)):

```markdown
---
last_verified: 2026-11-17
---
```

- Set the date (`YYYY-MM-DD`) only after you have checked every operational
fact of the page against its source: the Cloud Registry, the repository
and docs of the product, or the live service. Fix what is wrong in the
same pull request.
- `last_verified: null` marks a page with operational facts that nobody has
verified yet; the page says "Facts not verified yet".
- Which pages carry the key: the operator pages (`docs/operators/`), the
researchers' start page and guides, the tutorial on interactive services
(`tutorials/tes-services/`), the API guide
(`partners-and-developers/apis.md`), the demos index and About. Give new
pages with operational facts the key too, with `null` until you have
verified them. This is a convention: the build doesn't require the key.
- Editing a page doesn't change its date, but check every operational fact
that you add or change against its source, as for any change of the
docs. A pull request that sets a date verifies the page as it is on
`main` when it merges: update its branch first, and check what changed.
- Anything else than an unquoted date or `null` fails the build (hook
[`hooks/last_verified.py`](hooks/last_verified.py)).
- The partial is a copy of Material's: when you upgrade Material, compare
it with the new release's `partials/content.html`.

Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Resolved
## Contributing

Contributions are welcome! See the organisation's [contributing
Expand Down
1 change: 1 addition & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
last_verified: 2026-11-17
hide:
- feedback
---
Expand Down
4 changes: 4 additions & 0 deletions docs/demos/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Demos: Start Here

This section lists the demos and test beds of ELIXIR On-Cloud: what each one
Expand Down
12 changes: 12 additions & 0 deletions docs/operators/cloud-registry.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Cloud Registry

## Synopsis
Expand Down Expand Up @@ -1755,6 +1759,14 @@ deployment][cr-ui-updating]). Pre-releases can need the front end to be
upgraded with the registry even within a minor version, as 1.0.0-rc2 needed
1.0.0rc2: follow the release notes of both.

Finally, check the registry's own entry among its services, as for any
other service (see [After a deployment or an
upgrade](using-cloud-registry.md#after-a-deployment-or-an-upgrade)): while
the registry is listed (see [Listing the registry
itself](#listing-the-registry-itself)), the app brings the entry up to date
when it starts, so it must show the new version. An entry of the registry
that was registered like other services instead has to be edited by hand.

Rolling back from 1.0.0rc2 to an earlier version needs the database of that
version, as it was (see [Upgrading from 1.0.0rc1](#upgrading-from-100rc1)).
Don't roll back to an image older than 0.4.0 (e.g., that of the previous
Expand Down
13 changes: 13 additions & 0 deletions docs/operators/data-centre-onboarding-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Tutorial: Onboard a Data Centre

## Synopsis
Expand Down Expand Up @@ -309,6 +313,15 @@ Register your tools and workflows from a trusted client, as described in
[Registering tools][trsfiler-registering-tools] in the TRS-Filer docs.
Researchers then find them through the TRS API of your service.

## 7. Keep the registry entry up to date

End every upgrade, move or change of TRS-Filer, e.g., with `helm upgrade`,
with this step: **update the service's Cloud Registry entry, or check that
sync did.** With sync on, check that the entry shows the new version,
labelled `synced`; after a new URL or API type, ask the
[admins][elixir-on-cloud-email] to verify it again. See [After a deployment
or an upgrade](using-cloud-registry.md#after-a-deployment-or-an-upgrade).

## Planned

- **Writes with tokens** in TRS-Filer ([trs-filer#7][trsfiler-7]), which
Expand Down
4 changes: 4 additions & 0 deletions docs/operators/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Architects & Operators: Start Here

This section is primarily for architects, who decide whether to adopt GA4GH
Expand Down
4 changes: 4 additions & 0 deletions docs/operators/ls-login.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# LS Login

[LS Login](https://lifescience-ri.eu/ls-login/) (Life Science Login) is the
Expand Down
26 changes: 25 additions & 1 deletion docs/operators/node-onboarding-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Tutorial: Onboard a Node

## Synopsis
Expand Down Expand Up @@ -453,7 +457,27 @@ TESK, as described in [Deployment][sidecar-deployment]:
The central Pubgrade service of the ELIXIR On-Cloud isn't deployed yet
([generic-issues#32][gi-32]), so nothing notifies the sidecar so far.
Until then, upgrade TESK by hand, following the [upgrade
notes][tesk-upgrading].
notes][tesk-upgrading], and end with [step
9](#9-keep-the-registry-entry-up-to-date).

## 9. Keep the registry entry up to date

End every upgrade, move or change of your TES service, by hand or by
Pubgrade-Sidecar, with this step: **update the service's Cloud Registry
entry, or check that sync did.** Others find your service through its
entry, so it must follow your service:

- With sync on (TESK): check that the entry shows the new version, labelled
`synced`. To sync at once, rather than waiting for the next sync, use
`PUT /services/<id>/sync` of the registry.
- Without sync (Poiesis and Funnel, registered by hand): edit the entry
so that it matches the service again.
- After a new URL or API type: ask the
[admins][elixir-on-cloud-email] to verify the entry again.

See [After a deployment or an
upgrade](using-cloud-registry.md#after-a-deployment-or-an-upgrade) for
the details.

## Data centres

Expand Down
17 changes: 15 additions & 2 deletions docs/operators/onboarding.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Onboarding

Follow these steps to connect your Node to the ELIXIR On-Cloud federation.
Expand Down Expand Up @@ -104,7 +108,16 @@ For what the admins check before they verify an entry, and who uses the
verified entries, see [What the admins
check](using-cloud-registry.md#what-the-admins-check).

## 4. Next steps
## 4. Keep the registry entry up to date

Each time you upgrade, move or change your TES service, end with this step:
**update the service's Cloud Registry entry, or check that sync did** (see
[After a deployment or an
upgrade](using-cloud-registry.md#after-a-deployment-or-an-upgrade)). Others
find your service through its entry, so it must follow your service.

## 5. Next steps

- Deploy more [services](services/index.md).
- Deploy more [services](services/index.md), and end each deployment with
the same step.
- Connect your own services to [LS Login](ls-login.md).
4 changes: 4 additions & 0 deletions docs/operators/service-info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Prepare Your Service Info

## Synopsis
Expand Down
4 changes: 4 additions & 0 deletions docs/operators/services/drsfiler.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# DRS-Filer

!!! warning "Being revived"
Expand Down
8 changes: 7 additions & 1 deletion docs/operators/services/funnel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: 2026-11-17
---

# Funnel

[Funnel](https://github.com/calypr/funnel) is a [GA4GH TES][ga4gh-tes]
Expand All @@ -8,7 +12,9 @@ PBS.

Funnel is the TES service for Nodes with an HPC or HTC cluster. After you
deploy it, register it in the [Cloud Registry][elixir-cloud-registry] (see
[Onboarding](../onboarding.md)).
[Onboarding](../onboarding.md)). End every upgrade or change of it by
updating its entry, which has no sync (see [After a deployment or an
upgrade](../using-cloud-registry.md#after-a-deployment-or-an-upgrade)).

## Docs

Expand Down
4 changes: 4 additions & 0 deletions docs/operators/services/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Services

These are the services that a Node can run in the ELIXIR On-Cloud. Each
Expand Down
9 changes: 8 additions & 1 deletion docs/operators/services/poiesis.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Poiesis

[Poiesis](https://github.com/JaeAeich/poiesis) is a [GA4GH TES][ga4gh-tes]
Expand All @@ -7,7 +11,10 @@ service for Kubernetes. It runs each task in its own pod.

Poiesis is a TES service for Nodes with a Kubernetes cluster, next to
[TESK](tesk.md). After you deploy it, register it in the [Cloud
Registry][elixir-cloud-registry] (see [Onboarding](../onboarding.md)).
Registry][elixir-cloud-registry] (see [Onboarding](../onboarding.md)). End
every upgrade or change of it by updating its entry, which has no sync (see
[After a deployment or an
upgrade](../using-cloud-registry.md#after-a-deployment-or-an-upgrade)).

## Docs

Expand Down
9 changes: 8 additions & 1 deletion docs/operators/services/protes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# proTES

[proTES](https://github.com/elixir-cloud-aai/proTES) is a gateway for
Expand All @@ -12,7 +16,10 @@ to proTES, and proTES distributes them to the Nodes. It can read
the verified TES services of a [Cloud Registry][elixir-cloud-registry], so
that a new Node is used once it is registered and verified; the ELIXIR
On-Cloud's proTES lists its TES services in its configuration instead
(see below).
(see below). Register a proTES that you deploy in the Cloud Registry like
any other TES service, and end every upgrade or change of it by updating
its entry, or checking that sync did (see [After a deployment or an
upgrade](../using-cloud-registry.md#after-a-deployment-or-an-upgrade)).

## Docs

Expand Down
4 changes: 4 additions & 0 deletions docs/operators/services/prowes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# proWES

!!! warning "Being revived"
Expand Down
15 changes: 12 additions & 3 deletions docs/operators/services/tesk.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: 2026-11-17
---

# TESK

[TESK](https://github.com/elixir-cloud-aai/TESK) is a [GA4GH TES][ga4gh-tes]
Expand All @@ -7,12 +11,15 @@ service for Kubernetes. It runs each task as a Kubernetes Job.

TESK is the TES service for Nodes with a Kubernetes or OpenShift cluster.
After you deploy it, register it in the [Cloud
Registry][elixir-cloud-registry] (see [Onboarding](../onboarding.md)).
Registry][elixir-cloud-registry] (see [Onboarding](../onboarding.md)). End
every upgrade or change of it by checking that sync updated its entry (see
[After a deployment or an
upgrade](../using-cloud-registry.md#after-a-deployment-or-an-upgrade)).

## Docs

- [TESK docs](https://tesk.readthedocs.io/)
- [Helm chart and its values](https://github.com/elixir-cloud-aai/TESK/tree/master/charts/tesk)
- [Helm chart and its values](https://github.com/elixir-cloud-aai/TESK/tree/dev/charts/tesk)

## Notes for the deployment

Expand All @@ -30,4 +37,6 @@ Registry][elixir-cloud-registry] (see [Onboarding](../onboarding.md)).
- For a step-by-step setup, see the [Node onboarding
tutorial](../node-onboarding-tutorial.md).
- To use the Node's S3 storage (see [Onboarding](../onboarding.md)), set the
chart's `storage` value to `s3` and follow the chart's README.
chart's `storage` value to `s3` and follow
[S3](https://tesk.readthedocs.io/en/latest/deployment/#s3) in the TESK
docs.
10 changes: 9 additions & 1 deletion docs/operators/services/trsfiler.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# TRS-Filer

[TRS-Filer](https://github.com/elixir-cloud-aai/trs-filer) is a lightweight
Expand All @@ -7,7 +11,11 @@ workflows.
## Role in the deployment

TRS-Filer is the TRS implementation of the ELIXIR On-Cloud project. Use it
to offer tools and workflows through the TRS API.
to offer tools and workflows through the TRS API. After you deploy it,
register it in the [Cloud Registry][elixir-cloud-registry], and end every
upgrade or change of it by checking that sync updated its entry (see [After
a deployment or an
upgrade](../using-cloud-registry.md#after-a-deployment-or-an-upgrade)).

## Docs

Expand Down
4 changes: 4 additions & 0 deletions docs/operators/using-cloud-registry-ui.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Using the Cloud Registry UI

## Synopsis
Expand Down
31 changes: 31 additions & 0 deletions docs/operators/using-cloud-registry.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Using the Cloud Registry

## Synopsis
Expand Down Expand Up @@ -184,6 +188,33 @@ The [user guide of the UI][cr-ui-user-guide] covers registering, editing and
sharing services step by step; [Using the Cloud Registry
UI](using-cloud-registry-ui.md) adds what applies to this deployment.

### After a deployment or an upgrade

The registry is the source of truth for the services of the deployment, and
these docs list services from it. It stays right only if every change of a
service reaches its entry. **End every deployment, upgrade or move of a
service with this step: update its entry, or check that sync did.**

- **With sync on:** once the new version answers, sync the entry at once
(`PUT /services/<id>/sync`) or wait for the next sync. Then check that
the entry shows the new values, e.g., the version, with the label
`synced`. If it shows `out-of-sync`, see [Out-of-sync
reasons](#out-of-sync-reasons).
- **Without sync** (a manual entry, e.g., of Funnel or Poiesis): edit the
entry by hand, so that it matches the service again.
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Resolved
- **A new version of the API** (`type.version`): sync applies it to the
same entry, after an admin has approved it if it is new (see [Out-of-sync
reasons](#out-of-sync-reasons)). Ask for a new version in time.
- **A new URL or another API** (`type.group` or `type.artifact`): with sync
on, the URL can't change: turn sync off first, or import the service
anew (see [Labels](#labels)). Another API needs a new entry. Either
change removes the verification: ask the
[admins][elixir-on-cloud-email] to verify the entry again. If you
registered a new entry, delete the old one, so that it isn't listed next
to its replacement.
- **A service that you take down:** delete its entry, or tell the
[admins][elixir-on-cloud-email].

[cr-access-control]: <https://cloud-registry.readthedocs.io/en/latest/access-control/>
[cr-admin-mode]: <https://cloud-registry.readthedocs.io/en/latest/access-control/#admin-mode>
[cr-api]: <https://cloud-registry.readthedocs.io/en/latest/api/>
Expand Down
4 changes: 4 additions & 0 deletions docs/partners-and-developers/apis.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Using the APIs

This page shows how to send a request to a service of the ELIXIR On-Cloud
Expand Down
4 changes: 4 additions & 0 deletions docs/researchers/cli.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
last_verified: null
---

# Use the Command Line

This page shows how to use the services of ELIXIR On-Cloud from your terminal
Expand Down
Loading
Loading