Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Events captured by the Bridge as part of the snapshot's history (CURRENT)

EventData*

Who/What initiates it?

Initiated By

Snapshot Initiated
  • snapshot-action: SNAPSHOT_INITIATED
  • initiating-user: <user-email>
  • snapshot-id: <snapshot-id>
Bridge
Snapshot Transfer to Chronopolis Complete
  • snapshot-action: SNAPSHOT_STAGED
  • snapshot-id: <snapshot-id>
Bridge
Snapshot CompleteSnapshot Complete

alternateIds: ['id1', 'id2', 'id3',...]

TODO: add
  • snapshot-action: SNAPSHOT_
COMPLETE method
  • COMPLETED
  • alternate-ids: <list of bag IDs>
  • snapshot-id: <snapshot-id>

Call to complete snapshot made by Intake Service

Event captured by Bridge

Node

Request Restore Snapshot

initiating-user: <user email>

restore-action: RESTORE_REQUESTED

Bridge User
Restore Initiated

restore-id: <restore-id>

restore-action: RESTORE_INITIATED

initiating-user-email: <request initiating user email>

Bridge Admin
Restore Completed

restore-id: <restore-id>

restore-action: RESTORE_COMPLETED

expiration-date: yyyy-MM-dd

Bridge System
Restore Expired

restore-id: <restore-id>

restore-action: RESTORE_EXPIRED

Bridge System

*All events have a date stamp associated with them.

Additionally, nodes can append node specific events to the snapshot history at any time  via the /snapshot/{snapshot-id}/history  REST call.

...

Events captured by the Bridge Intake Service (CURRENT)

*Snapshot InitiatedINITIATEDuser
  • snapshot-id: <snapshot-id>
  • snapshot-action: SNAPSHOT_STAGED
  • email: (or user-id:)Bridge name
    Event
    Data
    Initiated By
    Bagging Completed

    Who/What initiates it?

    • snapshot-action: SNAPSHOT_
    • BAGGED
    BridgeSnapshot Transfer to Chronopolis Complete
    • bag-
    • ids: <list of bag IDs>
    • manifest-checksums: <list of sha256sums>
    • snapshot-id: <snapshot-id>
    Intake Service
    Snapshot Replication to DPN Nodes
    • snapshot-action: SNAPSHOT_REPLICATED
    • bag-ids: <list of bag IDs>
    • node: <node
    • namespace or ID>
    • snapshot-id: <snapshot-id>
    Intake Service

    Actions we should be capturing in snapshot history (TO DO)

    EventData*

    Initiated By

    Implementation Status
    Snapshot Bit Integrity Check Complete
    • snapshot-action: SNAPSHOT_COMPLETE
    • alternate-ids: <list of bag IDs>
    • BIT_INTEGRITY_CHECK
    • result: <SUCCESS or FAILURE>
    • snapshot-id: <snapshot-id>
    ACE webhook?Intake Service

    Bridge status events which are not captured in snapshot history

    ...