Rhythm 2.0 Specifications

Appearance

WF-PFM-QRY-021Provision and remove module data with the workspace lifecycle

Markdown

WF-PFM-QRY-021

Provision and remove module data with the workspace lifecycle

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Implements
CAP-PFM-QRY-017, CAP-PFM-QRY-018, CAP-PFM-QRY-019

KindWorkflowProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65

Provision and remove module data with the workspace lifecycle ​

What It Does ​

The workspace provisioning, deletion or reset workflow invokes the registered module participants. The selected lifecycle operation and participant resource declarations determine what reset retains.

The Flow ​

Provision every registered search type with defaults, ledger state and initial rebuild work. Remove workspace query definitions, schedules, reports, generations, file rows and queue work, assignments and Explorer state while retaining product-level custom-table history. Delete provider documents before clearing search configuration, claims, ledger and rebuild records. Clear Platform self-test rows, workspace policy and snapshot ledger versions in dependency-safe order after other owners remove their rows. Remove staged and published package bytes before workspace export history, then settings for deletion; reset clears history while retaining settings.

When Something Fails ​

The workspace job retries unfinished provisioning. A type can lack its scope until retry succeeds. Retry unfinished deletion batches. Completed file objects can remain in the legacy storage bucket until its retention lifecycle removes them. Wait for open work or report blocked cleanup when provider credentials are absent. Blocked scopes can retain provider documents. The workspace job retries an incomplete batch. Some snapshot rows can remain until deletion progresses. Retry incomplete storage or persistence cleanup. Unfinished bytes or rows can remain until retry, with staging also subject to its three-day retention.

Idempotency and Concurrency ​

Provisioning reuses existing scopes. Purge participants report more work until their batches are empty and can retry incomplete cleanup. Search purge waits for open rebuild work; workers stop indexing deleting workspaces and events acknowledge without further writes there.

Controls

47 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AVL-004 TC-AVL-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-CRY-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-DAT-005 TC-IAM-001 TC-IAM-002 TC-IAM-003 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-MON-002 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-SEC-001 TC-SEC-002 TC-SEC-003 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software