Skip to content

docs: update Cloud Registry page to 1.0.0rc1 - #92

Merged
uniqueg merged 2 commits into
mainfrom
docs/cr-1.0.0rc1
Nov 2, 2026
Merged

uniqueg merged 2 commits into
mainfrom
docs/cr-1.0.0rc1

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Summary

Updates the operator page of the ELIXIR On-Cloud registry (docs/operators/cloud-registry.md) from Cloud Registry v0.6.0 to v1.0.0rc1 (released 2026-11-02), and the front end from the branch ai-post-deploy to Cloud Registry UI v1.0.0-rc1, its first release. The page stays an addendum: it links the product docs and keeps only this deployment's values and decisions.

  • Version bump: info box ("Last checked against Cloud Registry v1.0.0rc1 and Cloud Registry UI v1.0.0-rc1", with the PEP 440 vs SemVer spelling), overview (chart cloud-registry-1.0.0-rc1.tgz of the v1.0.0rc1 release, image docker.io/elixircloud/cloud-registry:1.0.0rc1, new row for the UI image), verification and download commands, install command, checks (version 1.0.0rc1, max_services_per_user: 20, max_unused_service_types: 0 in controlled mode), and all registry links to /en/v1.0.0rc1/.
  • "From 1.0.0rc1" warnings removed: the warning box and the markers on services per user, invitations and rate limits; max_services_per_user: 20 is no longer commented out in the values file.
  • New "Upgrading from 0.6.0" (data is kept), linking the registry's "From 0.6.0" guide and the chart's notes "To app version 1.0.0rc1": services limit (20, check counts after the first start, admins' earlier services), policies (nothing to change for this values file), organization fields (a public curl | jq check before upgrading), the fully qualified default image, replicas, verify, upgrade and restart once. The UI upgrade is in the same step: release image docker.io/elixircloud/cloud-registry-ui:1.0.0-rc1, verified and pinned by digest; LOGIN_PROVIDERS/LOGIN_REDIRECT_URI instead of LS_LOGIN_URL/OIDC_* (the app stops if only the old ones are set, and warns if they are set next to LOGIN_PROVIDERS); the UI's LS Login client ID in config.security.auth.audience; registry first, then UI.
  • 0.4.0 and 0.5.0 paths shortened into "Upgrading from 0.4.0 or 0.5.0", keeping the deployment-specific points and links to the product guides and chart notes (which still cover them).
  • Replicas: cloudRegistry.replicas: 2 in the values file, with the chart's PodDisruptionBudget, instead of the "chart can't set replicas" warning; the restore command scales back to 2; a new check lists the pods and the PDB.
  • Front end: "UI version" now deploys the signed release image; new "Verifying the UI image" (look up the digest, verify the digest with gh attestation verify); "Building the image" removed. NEXT_PUBLIC_SERVICE_ENVIRONMENTS is dropped from the settings, as the UI reads environments and URL schemes from the registry's service info (the "known limitation" of the create form is gone too). The Deployment example pins docker.io/elixircloud/cloud-registry-ui:1.0.0-rc1@sha256:<digest>.
  • Admin mode: the opt_in_roles: [] workaround for front ends without the switch is only mentioned in the 0.5.0 path; all UI releases have the switch.

Public page: no secrets, tokens or client IDs (placeholders only), no internal hostnames.

Sources: cloud-registry v1.0.0rc1 (release assets, docs/releases/1.0.0rc1.md, docs/upgrading.md, docs/operations.md, deployment/README.md, cloud_registry/ga4gh/registry/service.py for the log lines), the RTD build at /en/v1.0.0rc1/, cloud-registry-ui dev at 5a0a635 (docs/operator-guide/*, docs/user-guide/registering.md, docs/releases/1.0.0-rc1.md).

Light lane: docs only, one page, no logic; reviewed the diff myself.

Verification

  • python scripts/check_names.py: passed.
  • mkdocs build --strict: passed (anchor validation is warn in mkdocs.yml, so the strict build checks internal anchors); all #… links of the page resolve in the built HTML.
  • pytest: 25 passed, 100% coverage.
  • Registry links: every anchor of the /en/v1.0.0rc1/ links exists on the fetched RTD pages (incl. upgrading/#from-060, #stored-services, deployment/#to-app-version-100rc1, #replicas, configuration/#services-per-user, access-control/#invitations).
  • Release assets: cloud-registry-1.0.0-rc1.tgz and .sigstore.json on v1.0.0rc1; the chart's version is 1.0.0-rc1, appVersion 1.0.0rc1.
  • Ran the page's commands: gh release download v1.0.0rc1 …, gh attestation verify of the chart and of oci://docker.io/elixircloud/cloud-registry:1.0.0rc1, and of the image by digest (@sha256:ea70b04a…, as the UI section does): all passed. The jq check of organization fields was tested on sample data and against the live API (no hits).
  • Not verifiable yet: the UI tag v1.0.0-rc1 doesn't exist, so the UI links (cloud-registry-ui.readthedocs.io/en/v1.0.0-rc1/…, the GitHub release) and the UI image commands only work after the tag. Their anchors were checked against the UI's dev sources and, where present, the current latest build.
  • CI: all checks passed on eedc8ac (Docs, Test, PR title, CodeQL, Sourcery, Read the Docs preview build; gate CI passed).
  • Sourcery: 5 threads, all answered and resolved. Fixed in eedc8ac: the restore waits until the app pods are gone before mongorestore --drop; the 0.6.0 upgrade notes that the public list leaves out pending services (the startup warning names them) and that writes through 0.6.0 pods during the rollout bypass the new checks (scale to 0 first to rule that out).

Declined review findings

  • Sourcery, UI release not yet available: intended; the PR is merged only after the UI tag v1.0.0-rc1, its image and its docs exist.
  • Sourcery, max_unused_service_types: 0 in the checks vs. the default 10: the service info of 1.0.0rc1 reports 0 in the controlled mode (release notes, #313/#316), so the check is right.

Open questions

None.

Closes #91

🤖 Generated with Claude Code

https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG

Summary by Sourcery

Update the Cloud Registry operator page for the v1.0.0rc1 registry and UI releases, covering deployment configuration, verification, and upgrade procedures.

Enhancements:

  • Update the ELIXIR On-Cloud registry operator documentation for Cloud Registry v1.0.0rc1 and Cloud Registry UI v1.0.0-rc1.
  • Document the migration from Cloud Registry 0.6.0 and consolidate earlier upgrade paths, including the new registry and UI configuration requirements.
  • Refresh deployment guidance for signed, digest-pinned release images, two registry replicas, PodDisruptionBudgets, verification checks, and release-specific documentation links.

Documentation:

  • Replace branch-based front-end deployment instructions with guidance for the signed Cloud Registry UI v1.0.0-rc1 release image and its updated login settings.
  • Update registry configuration examples and checks for service limits, organization validation, invitations, service metadata, and UI-provided environment and URL scheme settings.

Bump the operator page of the ELIXIR On-Cloud registry from Cloud
Registry v0.6.0 to v1.0.0rc1, and the front end from the branch
ai-post-deploy to the Cloud Registry UI release v1.0.0-rc1.

- Info box, overview, chart file (cloud-registry-1.0.0-rc1.tgz),
  images, verification commands and links now point to 1.0.0rc1;
  the "from 1.0.0rc1" warning and markers are gone.
- New "Upgrading from 0.6.0", with the front end upgrade in the same
  step: verified release image pinned by digest, LOGIN_PROVIDERS
  instead of LS_LOGIN_URL/OIDC_*, the client ID in the audience,
  registry first.
- The 0.4.0 and 0.5.0 paths are shortened to their deployment-specific
  points, with links to the product guides.
- Replicas: cloudRegistry.replicas 2 with the chart's
  PodDisruptionBudget, instead of the warning.
- Front end: environments and URL schemes come from the registry's
  service info, so NEXT_PUBLIC_SERVICE_* settings are dropped; the
  image build section is replaced by verifying the release image.

Closes #91

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG
@sourcery-ai

sourcery-ai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates the Cloud Registry operator addendum from v0.6.0 to registry v1.0.0rc1 and UI v1.0.0-rc1, adding release-image verification, coordinated upgrade procedures, replica/PDB operations, and refreshed deployment configuration and links.

Sequence diagram for the coordinated Cloud Registry upgrade

sequenceDiagram
    participant Operator
    participant Registry
    participant UI
    participant Users

    Operator->>Registry: helm upgrade
    Registry-->>Operator: rollout status
    Operator->>Registry: kubectl rollout restart
    Registry-->>Operator: rollout status
    Operator->>UI: Deploy verified digest-pinned release image
    UI->>Registry: Read service info and allowed settings
    Users->>UI: Log in and use registry
    UI->>Registry: Create, update, or delete services
Loading

Flow diagram for verified release image deployment

flowchart TD
    Chart[Download release chart]
    ChartVerify[gh attestation verify chart]
    RegistryImage[Inspect registry image digest]
    RegistryVerify[Verify registry image attestation]
    UIImage[Inspect UI image digest]
    UIVerify[Verify UI image attestation]
    Deploy[Deploy verified chart and digest-pinned UI image]

    Chart --> ChartVerify
    RegistryImage --> RegistryVerify
    UIImage --> UIVerify
    ChartVerify --> Deploy
    RegistryVerify --> Deploy
    UIVerify --> Deploy
Loading

File-Level Changes

Change Details Files
Refresh the deployment addendum for the Cloud Registry 1.0.0rc1 and UI 1.0.0-rc1 releases.
  • Bump chart, registry/UI images, commands, checks, configuration values, and product links to the new releases.
  • Update version terminology for the registry's PEP 440 release and the chart/UI SemVer release.
  • Remove obsolete pre-release warnings and branch-build guidance.
docs/operators/cloud-registry.md
Add deployment and migration guidance for the new registry release.
  • Document the data-preserving upgrade path from 0.6.0, including service limits, organization fields, policies, image naming, replicas, and restart sequencing.
  • Condense earlier 0.4.0 and 0.5.0 migration paths while retaining deployment-specific requirements.
  • Document two replicas, the chart-managed PodDisruptionBudget, and related operational checks and restore behavior.
docs/operators/cloud-registry.md
Replace branch-built front-end instructions with signed release-image deployment guidance.
  • Document digest lookup and GitHub attestation verification for the UI release image.
  • Update UI login variable migration, audience requirements, registry-derived service settings, and release deployment manifest.
  • Remove image-building instructions and obsolete environment/configuration limitations.
docs/operators/cloud-registry.md
Validate the documentation and referenced release artifacts.
  • Run name checks, strict MkDocs build, tests, anchor validation, release asset checks, and documented chart/image verification commands.
  • Record that UI release links and image commands remain pending until the UI tag is published.
docs/operators/cloud-registry.md

Possibly linked issues


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

@read-the-docs-community

read-the-docs-community Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 elixir-on-cloud-docs | 🛠️ Build #35577493 | 📁 Comparing eedc8ac against latest (87d075b)

  🔍 Preview build  

1 file changed
± operators/cloud-registry/index.html

@uniqueg
uniqueg marked this pull request as ready for review November 2, 2026 10:09

@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 5 issues

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

## Individual Comments

### Comment 1
<location path="docs/operators/cloud-registry.md" line_range="1339" />
<code_context>
   --authenticationDatabase admin --gzip --archive --drop' \
   < cloud-registry-<timestamp>.archive.gz \
-  && kubectl scale deploy/cloud-registry --replicas=1 -n <namespace>
+  && kubectl scale deploy/cloud-registry --replicas=2 -n <namespace>
 ```

</code_context>
<issue_to_address>
**Restore can mix live writes**

When a registry pod is still terminating or handling a request after scaling to zero, `kubectl scale --replicas=0` returns before the pods have necessarily exited, so `mongorestore --drop` can replace collections while a pod is writing; the restored data is then mixed with or overwritten by live writes.

Wait until all registry pods have terminated before running `mongorestore --drop`.
</issue_to_address>

### Comment 2
<location path="docs/operators/cloud-registry.md" line_range="118" />
<code_context>
+limit of services once the registry has them (see the UI's [upgrade
+notes][cr-ui-upgrading-1.0.0-rc1]). For this deployment:
+
+1. **Services per user:** the values file below limits users other than
+   admins to 20 services each (see [Services per
+   user](#services-per-user)), not to the default of 50. The app counts
</code_context>
<issue_to_address>
**Writes bypass upgrade safeguards**

When users or clients continue writing while Helm rolls out the new registry, old 0.6.0 pods continue serving requests during the rollout, so owners can register past the new 20-service limit or add organization fields after the pre-upgrade scan. Those writes persist when the old pods exit, leaving over-limit accounts and services that require cleanup; users then cannot register more services or update records that retain unsupported fields.

Pause writes for the upgrade and repeat the checks after all old pods have stopped, cleaning up any affected services before resuming writes.

Also at `docs/operators/cloud-registry.md:136`.
</issue_to_address>

### Comment 3
<location path="docs/operators/cloud-registry.md" line_range="51" />
<code_context>
 | Admins | members of the LS Login group `ECP_CLN:ADMIN`, in admin mode (see [Admins](#admins)) |
-| Helm chart | `cloud-registry-0.6.0.tgz` of the [v0.6.0 release][cr-release] (deploys the image `elixircloud/cloud-registry:0.6.0`) |
+| Helm chart | `cloud-registry-1.0.0-rc1.tgz` of the [v1.0.0rc1 release][cr-release] (deploys the image `docker.io/elixircloud/cloud-registry:1.0.0rc1`) |
+| Front end image | `docker.io/elixircloud/cloud-registry-ui:1.0.0-rc1` of the [v1.0.0-rc1 release][cr-ui-release] (see [UI version](#ui-version)) |
 | Database | MongoDB 7.0, deployed by the chart |

</code_context>
<issue_to_address>
**UI release instructions are unavailable**

When the page is used before the UI `v1.0.0-rc1` tag, image, and release documentation are published, the documented image cannot be pulled or verified, and the linked release pages are unavailable, so operators cannot complete the prescribed UI installation or upgrade.

Publish the UI tag, image, and linked release documentation before directing operators to use them, or document an available UI release instead.

Also at `docs/operators/cloud-registry.md:172`, `docs/operators/cloud-registry.md:850`, `docs/operators/cloud-registry.md:867-871`, `docs/operators/cloud-registry.md:1439-1440`.
</issue_to_address>

### Comment 4
<location path="docs/operators/cloud-registry.md" line_range="143" />
<code_context>
     ```bash
     curl -fsS https://elixir-on.cloud/ga4gh/registry/v1/services \
-      | jq '[.[].environment] | unique'
+      | jq '[.[] | select(.organization // {} | keys - ["name", "url"] | length > 0) | .id]'
     ```

</code_context>
<issue_to_address>
**Upgrade preflight misses hidden services**

When the deployment has pending or non-public services with organization fields other than `name` and `url`, when stored services are pending or otherwise non-public, anonymous `GET /services` omits them, so the jq preflight misses records with unsupported organization fields; after the upgrade their updates are rejected and owners were not warned beforehand. The startup warning occurs only after the change.

Inspect the full stored-service inventory with admin access before upgrading, or explicitly warn that hidden invalid services will only be identified by startup logs after the upgrade.
</issue_to_address>

### Comment 5
<location path="docs/operators/cloud-registry.md" line_range="1054-1055" />
<code_context>
+1. The service info shows version `1.0.0rc1` and the deployment's fields.
+   Its registration rules show the recommended settings: the environments
+   `["prod", "test"]`, the URL schemes `["https"]`, the service types
+   `controlled` (with `"max_unused_service_types": 0`, as only admins add
+   types) and `"max_services_per_user": 20`:

     ```bash
</code_context>
<issue_to_address>
**Service-info check reports a mismatch**

When operators use the prescribed values file without overriding `max_unused_service_types`, the values file leaves `max_unused_service_types` at its default of 10, while the documented service-info check expects 0, so the check reports a mismatch for a deployment using the supplied configuration.

Set `config.custom.access_control.max_unused_service_types` to 0 in the values file, or update the documented expected value to match the configuration.
</issue_to_address>

Linked issues

#91 docs: update Cloud Registry page to 1.0.0rc1 · 5 of 5 met

# Requirement Status Notes
1 Update the page's version information, overview, verification and installation commands, and registry documentation links for v1.0.0rc1. ✅ Met The chart and registry image use the new versions, and the registry documentation references point to v1.0.0rc1.
2 Remove the “from 1.0.0rc1” warnings and markers. ✅ Met The warning and markers are removed, and the services-per-user setting is included in the values file.
3 Add upgrade guidance from 0.6.0, including the coordinated UI upgrade and its login and audience changes. ✅ Met The page documents the data-preserving registry upgrade, the verified UI release image, login variable changes, audience requirement, and registry-first order.
4 Use the chart's new cloudRegistry.replicas setting for the recommended two replicas. ✅ Met The values example sets cloudRegistry.replicas: 2 and the page describes the chart's PodDisruptionBudget.
5 Shorten older upgrade paths covered by product documentation while keeping links to those guides. ✅ Met The 0.4.0 and 0.5.0 paths are summarized with links to the registry guides and chart notes.

Sourcery assessment

Approval pending. 5 findings to address first.

Blocking findings: docs/operators/cloud-registry.md:1339, docs/operators/cloud-registry.md:118, docs/operators/cloud-registry.md:51, docs/operators/cloud-registry.md:143, docs/operators/cloud-registry.md:1055


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

Comment thread docs/operators/cloud-registry.md Resolved
Comment thread docs/operators/cloud-registry.md Resolved
Comment thread docs/operators/cloud-registry.md Resolved
Comment thread docs/operators/cloud-registry.md Resolved
Comment thread docs/operators/cloud-registry.md Resolved
- Restore: wait until the app's pods are gone before mongorestore.
- Upgrade from 0.6.0: pending services are not in the public list, the
  startup warning names them; writes through 0.6.0 pods bypass the new
  checks during the rollout, scaling to 0 first rules that out.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG
@uniqueg
uniqueg merged commit e6ce3e7 into main Nov 2, 2026
14 of 17 checks passed
@uniqueg
uniqueg deleted the docs/cr-1.0.0rc1 branch November 2, 2026 10:25
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: update Cloud Registry page to 1.0.0rc1

1 participant