Skip to content
Closed
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
71 changes: 71 additions & 0 deletions docs/registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Registration and early access to an event

Datatrail registration records a dataset and its files. Replication copies the
registered files to another storage element such as Minoc, where they become
accessible from CANFAR. A successful registration request does not mean that a
transfer has finished.

## Check an event first

Use the ordinary CLI to inspect the event before requesting more work:

```bash
datatrail unregistered search EVENT_ID
datatrail ps SCOPE EVENT_ID
```

Replace `EVENT_ID` with the event number and `SCOPE` with the event's actual
scope, for example `chime.event.baseband.raw`. A recorded
registration failure can identify a missing classification, missing parent
dataset, or another problem that submitting the same request will not fix.

The normal date-based registration schedule leaves time for human
classification. An authorized on-site operator can submit one event earlier
with the `datatrail-admin` tools. This uses the site's existing service
configuration and data mounts; installing `datatrail-cli` on CANFAR alone does
not grant that access.

## On-site operator workflow

The administrator command and its preview/status options are documented in the
[manual registration runbook](https://github.com/CHIMEFRB/datatrail/blob/main/docs/services/manual-registration.md).
Use a released administrator image containing those options, and run
`datatrail-admin registration single-dataset --help` to check the installed
version's interface.

Confirm that data capture has finished and the source files are fully written.
Inside the authorized site's configured registration environment:

```bash
datatrail-admin registration single-dataset chime baseband --name EVENT_ID --dry-run
datatrail-admin registration single-dataset chime baseband --name EVENT_ID
datatrail-admin registration status chime baseband --name EVENT_ID
```

The preview identifies the source files and intended registration without
submitting work. Review it before confirming the second command. An accepted
request enters the registration queue; classification, registration, and
policy-driven replication can still fail or remain pending afterward.

For a dataset outside the usual classification rules, an operator may select an
existing parent dataset with approved policies using the administrator
workflow. Review the parent and its retention/replication policies explicitly.
The command does not create new policies or guarantee a transfer deadline.

Do not delete local completion markers or repeatedly resubmit a request to
speed up replication. Inspect its status and failure reason first. Once the
recorded Minoc replicas are available, use the normal [`pull`](pull.md) or
[`pull-manifest`](pull-manifest.md) workflow on CANFAR.

## Registration service alerts

`datatrail doctor` checks the CLI configuration and service readiness when you
run it. Continuous registration monitoring belongs to the site's deployed
monitoring service. Operators should configure the expected workers, alert
routing, and failure/recovery tests described in the
[registration monitoring runbook](https://github.com/CHIMEFRB/datatrail/blob/main/docs/services/registration_monitoring.md).

A missing or stale worker and a running worker that stops making progress are
different failures. An alert should identify the affected site and worker and
provide its restart/escalation instructions. Alert delivery must be tested in
the deployed environment before relying on it.
3 changes: 3 additions & 0 deletions docs/unregistered.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ unregistered datasets bucket along with the reason it failed. The
This is usually the first place to look when an event you expect to find with
[`scout`](scout.md) or [`ps`](ps.md) is missing entirely from Datatrail.

For an authorized manual registration request, see
[Registration and early access](registration.md).

## `search`

```bash
Expand Down
4 changes: 4 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ Downloading a dataset.
## 🕵️ [scout](scout.md)

Investigating number of files for a dataset across storage elements.

## [Registration and early access](registration.md)

Check an event, request authorized on-site registration, and follow its progress to CANFAR.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ nav:
- Welcome: user_guide.md
- Install: install.md
- Initialise: initialising.md
- Registration and early access: registration.md
- Commands:
- clear: clear.md
- inventory: inventory.md
Expand Down
Loading