Service Registration & Ownership
Every Origin, Cache, and namespace prefix in a federation exists as a registration in the federation’s Registry.
Registrations follow a self-service workflow:
- Your service registers itself automatically as
Incomplete. - You claim the registration through a service-provided link.
- You submit a completed registration form for administrator review.
- Once approved, you can manage, transfer, or update the registration.
For guidance on choosing a prefix, see Choosing a Namespace Prefix. To register a prefix manually in advance, see Federation Namespace Prefix Registration.
Registration Lifecycle
| Status | Meaning |
|---|---|
Incomplete | Auto-registered by the service. Unowned and awaiting form completion. |
Pending | Claimed by an owner with a submitted form. Awaiting administrator review. |
Approved | Granted federation access. |
Denied | Turned down by an administrator. Editable and resubmittable for review. |
- Transition Rules: Claiming and submitting an
Incompleteregistration moves it toPending. An administrator then moves it toApprovedorDenied. - Re-submitting: Denial is non-final. Editing and resubmitting a
Deniedregistration returns it toPending. - Trust Boundary: Approval is the primary trust boundary. The Director only routes traffic to
Approvedservices, and once approved, core properties can only be altered by an administrator.
How Services Register
1. Automatic Registration
When an Origin or Cache starts up, it automatically registers with the federation’s Registry by proving ownership of its issuer keypair.
It submits its public key, namespace prefix(es), and site name, entering the system as Incomplete.
2. Finding the Registration Link
While any of the service’s registrations remains incomplete, the service generates a registration completion link for each incomplete prefix (valid for 15 minutes and re-minted every 10 minutes). Access these links through:
- Service Logs / stdout: Every 10 minutes the service logs, at
errorlevel,Server registration is incomplete; open the link below in a browser and log in to the registry to complete it ..., followed by oneComplete server registration at <link> (expire at <time>)line per prefix. The expiry is printed in the server’s local time zone. - Link File: The same
Complete server registration at ...lines (one per prefix) are written to the path defined inServer.RegistrationCompletionLinkFile, facilitating headless or automated setups. A prefix’s line disappears on the poll after its registration is complete, and the file is removed once no incomplete registration remains (and when the service shuts down). - Origin Admin UI: Displayed under the Data Exports table for each prefix.
To turn the reminder off, set Server.RegistrationCompletionLinkFile to an empty string: the service then neither polls the Registry for completeness nor logs or writes the link. The Origin Admin UI keeps showing the registration status.
3. Claiming Ownership
- Open the completion link.
- Log in through the Registry’s authentication flow (e.g., CILogon) if prompted.
- Review the registration details on the claim page and click Accept.
Upon acceptance, the Registry verifies the link’s token against the service’s public key and assigns ownership to your Pelican user account. The link then expires and is removed.
Rules & Constraints:
- Only unowned registrations can be claimed.
- Unowned registrations can be claimed in any status (including registrations approved prior to ownership enforcement).
- Ownership requires an authenticated Pelican user account; anonymous or token-only access is not permitted.
4. Submitting Details
Once claimed, you will be directed to the registration form:
- Complete all required federation fields (e.g., institution, description, custom fields).
- Confirm the security contact (defaults to your account).
- Submit the form to transition status to
Pending(displayed to admins as “Pending (Ready to review)”).
Note: Your service does not require a restart during this process. It detects approval on its next advertisement cycle (about one minute) and goes live. An Origin is only accepted by the Director once its server registration and every exported namespace are approved.
Post-Registration Management
As a registration owner, you can manage your resource through the Registry UI:
- Resubmit Denied Entries: Your
Deniedregistrations are listed at/view/registry/denied/on the Registry (they do not appear on the dashboard). Edit one and submit it to return it to thePendingqueue. - Transfer Ownership: From the card of an
Approvedregistration you own, generate a single-use invite link (valid for 7 days; it is shown only once). Once a colleague logs into their Pelican account and redeems the link, ownership is transferred to them; the second redemption of the same link will be rejected.
Upgrading to Pelican 26.0+
In Pelican 26.0+, ownership is bound to your Registry User ID rather than login usernames or identity strings (e.g., CILogon sub).
- Unowned Legacy Registrations: Registrations created before Pelican 26.0 can be claimed using a completion link once running 26.0+, or via the Origin Web UI on any version.
- Legacy Ownership Strings: Registrations owned by a CILogon subject are re-homed onto the Pelican account carrying that subject when the Registry starts, provided exactly one active account matches. The check runs on every Registry start, so owners who have not logged in yet are picked up later. Registrations owned by any other string, or by an ambiguous or deactivated account, are left unchanged; use an ownership-transfer link for those.
- CLI Registrations with
--with-identity: The identity you present is matched to the Pelican account carrying it (log into the Registry web UI once beforehand so the account exists). If no single account matches, the registration is created unowned and can be claimed later. - Loss of Admin Access: If you lose access to your Pelican service following an upgrade, request an ownership-transfer link from a federation administrator to re-bind the service to your account.
- Registration Status: Only registrations created after the Registry runs Pelican 26.0+ start as
Incomplete; the Registry assigns the status regardless of the registering service’s version. Existing registrations retain their current status and meaning.
For Federation Administrators
Administrators manage registrations via the Registry web UI (see Serving a Pelican Registry):
- Review Queue: The dashboard lists Pending Registrations (complete forms awaiting your decision) above Incomplete Registrations (the server admin has not claimed or completed the form yet; nothing to review). Both lists offer deny and edit; approve is offered on
PendingandDeniedentries. - Editing & Decisions: You can edit registration fields before approving or denying a submission, even for unowned entries. Editing an Incomplete registration does not assign ownership, and it remains Incomplete until explicitly claimed. When denying a submission, you can update the description field to provide actionable feedback for the server admin before they resubmit.
- Transfer Invites: You can generate an ownership-transfer link to reassign any approved registration to another active Pelican user account.