Skip to content

docs: fill the gaps in the Node operator pages - #153

Merged
uniqueg merged 2 commits into
mainfrom
docs/81-node-operator-gaps
Nov 17, 2026
Merged

uniqueg merged 2 commits into
mainfrom
docs/81-node-operator-gaps

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Summary

Fills the gaps that #81 lists in the Node operator pages, with the maintainers' answers of 2026-11-17:

  1. Who can join: new section "Who can join" on the section's start page. These pages are for compute Nodes: a Node joins with at least one TES or WES service that requires LS Login tokens and registers it in the Cloud Registry. Data nodes (cloud storage, DRS) may join too; their requirements will follow. No verification time is promised: the pages keep "write to the admins". The notes in Onboarding and both tutorials point to the new section.
  2. Done by docs: document service checks, Poiesis and OpenPBS #142.
  3. vsftpd: "write to the service email" stays the documented process.
  4. proTES page: the deployment's proTES (https://protes.rahtiapp.fi/, 0.6.0, LS Login tokens of ECP_CLN:EOC-Compute members, the FI TESK as its TES service, registry discovery off); the tutorial and "Using the Cloud Registry" now say that it lists its TES services in its configuration. TRS-Filer page: https://trs-filer.rahtiapp.fi/ga4gh/trs/v2, public reads, writes with LS Login tokens under the same access rules as the Cloud Registry. proWES and DRS-Filer: "Archived" notes replaced by "Being revived" (unarchived 2026-11-16; not deployed yet; docs follow with the revival). CWL-WES: page and nav entry removed, no more references in the Node operator pages.
  5. Poiesis page: CZ runs Poiesis at https://poiesis.dyn.cloud.e-infra.cz/; FI instances are not part of the deployment yet; it joins the gateway once it checks token groups (generic-issues#21). Written as a dated table so that it is easy to update.
  6. Done by docs: document service checks, Poiesis and OpenPBS #142.

The deployment-specific facts are in "In the ELIXIR On-Cloud" sections marked "As of November 2026", so that they are easy to find and update.

Removing operators/services/cwlwes.md drops its URL; the site has no redirect plugin.

Closes #81

Verification

  • python scripts/check_names.py: passes
  • mkdocs build --strict: passes, no warnings
  • pytest: 25 passed, 100% coverage (unchanged)
  • The addresses were checked: proTES and TRS-Filer answer GET /service-info (proTES 0.6.0, TES 1.1.0), Poiesis CZ answers 200.
  • CI: all checks green (CI passed, Read the Docs build, CodeQL, Sourcery).

Declined review findings

  • Sourcery: document CWL-WES facts. Archived; the maintainers decided that the docs stop referencing it.
  • Sourcery: list the proTES plugins. Not recorded yet; the page points to generic-issues#31.
  • Sourcery: name the storage of the CZ Poiesis. Not recorded; the page keeps the general S3 requirement.

Review

Light lane: docs only. I reviewed the diff myself.

🤖 Generated with Claude Code

Say who can join (compute Nodes with a TES or WES service that
requires LS Login tokens; data nodes later), and document the
deployment's proTES, TRS-Filer and Poiesis. Mark proWES and
DRS-Filer as being revived instead of archived, and remove the
CWL-WES page.

Closes #81

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uniqueg uniqueg self-assigned this Nov 17, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Configuration

Remove the CWL-WES entry from the site navigation to match the deleted service page.

  • mkdocs.yml L101 (removed lines)

Documentation

Review the compute-Node eligibility and onboarding guidance together to check that the TES/WES, LS Login, and Cloud Registry requirements agree across the overview and onboarding pages.

  • docs/operators/index.md L13-24, L29-44, L60 (removed lines)
  • docs/operators/node-onboarding-tutorial.md L26-29
  • docs/operators/onboarding.md L17-26

Check the data-centre guidance for consistent storage, DRS, and federation-requirement status.

  • docs/operators/data-centre-onboarding-tutorial.md L19, L32-35, L87

Review the deployment-specific proTES facts alongside the onboarding tutorial and Cloud Registry guidance that explain how its TES services are configured and discovered.

  • docs/operators/node-onboarding-tutorial.md L399-403
  • docs/operators/services/protes.md L13-15, L25-43
  • docs/operators/using-cloud-registry.md L111-113, L198 (removed lines)

Check the deployment-specific TRS-Filer address and access policy against the service overview.

  • docs/operators/services/index.md L24-31
  • docs/operators/services/trsfiler.md L19-31

Review Poiesis deployment status and gateway behavior together with the related token-group issue reference.

  • docs/operators/services/poiesis.md L34-45, L49 (removed lines)

Check that proWES and DRS-Filer are consistently described as being revived and not yet deployed, and remove the obsolete CWL-WES page.

  • docs/operators/services/drsfiler.md L3-7, L14-20
  • docs/operators/services/prowes.md L3-7, L16-21
  • docs/operators/services/cwlwes.md (deleted)

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg
uniqueg marked this pull request as ready for review November 17, 2026 04:38
@sourcery-ai

sourcery-ai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Linked issues

Checked at commit 9fa8d10

#81 docs: fill the gaps in the Node Operators pages · 3 of 6 met

# Requirement Status Notes
1 Document who can join, what a Node must provide, and how long verification takes. 🟡 Partly met Compute Node requirements and the instruction to contact the admins are documented, but the requirements for data nodes are explicitly deferred.
2 Explain how admins verify a registered TES service and which services use verified entries. ✅ Met The registry pages describe the admins’ checks and explain that registry-discovering proTES uses verified TES entries; the deployment’s proTES is documented as using a configured list instead.
3 Document the process for getting the vsftpd federation account. ✅ Met The onboarding instructions say to write to the service email for the username and password.
4 Document the deployment’s proTES details and the addresses and contents of proWES, CWL-WES, DRS-Filer, and TRS-Filer. 🟡 Partly met The change documents proTES’s address, version, access, TES service and registry-discovery setting, and gives deployment status for proWES and DRS-Filer plus TRS-Filer details; proTES’s plugins and remaining configuration are still deferred.
5 Document how Poiesis is used in the deployment, including which Nodes run it and which storage they use. 🟡 Partly met The page identifies the CZ and FI Node status and explains when Poiesis joins the gateway, but does not say which storage the deployment’s Poiesis instance uses.
6 Document Funnel with OpenPBS, in addition to Slurm. ✅ Met The Funnel page includes OpenPBS guidance; it is marked untested on an OpenPBS cluster.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 4 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/operators/index.md" line_range="43" />
<code_context>
 1. Read [Onboarding](onboarding.md).
-2. Deploy a TES service and a storage server at your Node.
-3. Register your TES service in the Cloud Registry.
+2. Deploy a TES or WES service and a storage server at your Node.
+3. Register your service in the Cloud Registry.
 4. Optional: deploy more [services](services/index.md), and connect your own
</code_context>
<issue_to_address>
**WES-only operators cannot onboard**

When an operator wants to join with only a WES service, the index advertises WES deployment and registration, but the onboarding guide and tutorial cover TES only, and the service list identifies proWES as a gateway rather than a WES implementation. The pages therefore leave WES-only operators without a documented way to complete onboarding.

Provide WES-specific deployment and registration instructions, or remove WES-only Nodes from the advertised joining steps.

Also at `docs/operators/onboarding.md:17`, `docs/operators/onboarding.md:19`, `docs/operators/index.md:31-33`, `docs/operators/node-onboarding-tutorial.md:27`.
</issue_to_address>

### Comment 2
<location path="docs/operators/services/index.md" line_range="24" />
<code_context>
 | Service | Standard | Role |
 |---|---|---|
 | [proTES](protes.md) | [GA4GH TES][ga4gh-tes] | Gateway in front of several TES services. |
-| [CWL-WES](cwlwes.md) | [GA4GH WES][ga4gh-wes] | Archived, unmaintained. Ran CWL workflows on a TES service. |
-| [proWES](prowes.md) | [GA4GH WES][ga4gh-wes] | Archived, unmaintained. Gateway in front of several WES services. |
-| [DRS-Filer](drsfiler.md) | [GA4GH DRS][ga4gh-drs] | Archived, unmaintained. Served data objects. |
</code_context>
<issue_to_address>
**CWL-WES deployment facts absent**

The issue asks for CWL-WES’s address and contents, including which TES it uses. The change removes its service entry without stating whether it is deployed or documenting those facts.
</issue_to_address>

### Comment 3
<location path="docs/operators/services/protes.md" line_range="42-43" />
<code_context>
+gateway](../node-onboarding-tutorial.md#7-get-added-behind-the-gateway)).
+The service info of proTES (`GET /ga4gh/tes/v1/service-info`) lists the TES
+services that it uses. The rest of its configuration, such as its plugins
+and how it authenticates at its TES services, is tracked in
+[generic-issues#31][gi-31].

 [gi-31]: <https://github.com/elixir-cloud-aai/generic-issues/issues/31>
</code_context>
<issue_to_address>
**proTES plugins remain unspecified**

The issue asks for the deployment’s proTES plugins, but the page says that plugin configuration is tracked in generic-issues#31 rather than documenting which plugins it uses.
</issue_to_address>

### Comment 4
<location path="docs/operators/services/poiesis.md" line_range="40-41" />
<code_context>
+
+| Node | Address | Status |
+|---|---|---|
+| Czech Republic (CZ) | <https://poiesis.dyn.cloud.e-infra.cz/> | runs; not behind the gateway yet |
+| Finland (FI) | none | not part of the deployment yet |
+
+Poiesis joins the TES services of the [gateway](protes.md) once it checks
</code_context>
<issue_to_address>
**Poiesis storage not documented**

The table identifies which Nodes run Poiesis, but the page does not say which storage it uses.
</issue_to_address>

Sourcery assessment

Approval pending. 4 findings to address first.

Blocking findings: docs/operators/index.md:43, docs/operators/services/index.md:24, docs/operators/services/protes.md:43, docs/operators/services/poiesis.md:41


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/operators/index.md Resolved
Comment thread docs/operators/services/index.md Resolved
Comment thread docs/operators/services/protes.md Resolved
Comment thread docs/operators/services/poiesis.md Resolved
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New gaps against the linked issues

@uniqueg
uniqueg merged commit e47b66d into main Nov 17, 2026
17 checks passed
@uniqueg
uniqueg deleted the docs/81-node-operator-gaps branch November 17, 2026 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fill the gaps in the Node Operators pages

1 participant