README.md

Merritt

Merritt is the digital preservation repository for the University of California, available to libraries, academic departments, laboratories and other organizational units within UC.

Original System Specifications

• Merritt Object Model
• Technical Specifications
• Digital Object Guidelines

User Documentation

• For the latest Merritt documentation, see the wiki.
• Manifest Validation Tool
• Manifest Validation Tool with Unit Tests
• Merritt Development Resources

Code Repositories

Core Microservices

%%{init: {'theme': 'neutral', 'securityLevel': 'loose', 'themeVariables': {'fontFamily': 'arial'}}}%%
graph TD
  RDS[(Inventory DB)]
  UI("Merritt UI")
  click UI href "https://github.com/CDLUC3/mrt-dashboard" "source code"
  ING(Ingest)
  click ING href "https://github.com/CDLUC3/mrt-ingest" "source code"
  ST(Storage)
  click ST href "https://github.com/CDLUC3/mrt-store" "source code"
  STACC(Storage - Access)
  click STACC href "https://github.com/CDLUC3/mrt-store" "source code"
  INV(Inventory)
  click INV href "https://github.com/CDLUC3/mrt-inventory" "source code"
  CLOUD(("Cloud Storage"))
  click CLOUD href "https://github.com/CDLUC3/mrt-cloud" "source code"
  LDAP[/LDAP\]
  ZFS[/ZFS Working Storage/]
  ZOO>Zookeeper]
  click ZOO href "https://github.com/CDLUC3/mrt-zoo" "source code"
  EZID(EZID Service)
  click EZID href "https://ezid.cdlib.org/" "service link"
  BROWSER[[Browser]]

  subgraph flowchart
    BROWSER --> |ingest or retrieval| UI
    UI --> |authorization| LDAP
    RDS --> UI
    UI --> |"file or ingest manifest"| ING
    ING --> |queue job| ZOO
    ING --> |check obj lock| ZOO
    ZOO --> |start job| ING
    ING -.-> |local id request| INV
    ING --> EZID
    ING --> |download content| ZFS
    ING --> |"sync deposit"| ST
    ST --> CLOUD
    ZFS --> ST
    ZOO --> INV
    INV -.-> |retrieve storage manifest| ST
    INV --> RDS
    UI ---> |retrieval req| STACC
    STACC --> |retrieval req| CLOUD
    CLOUD -.-> |presigned URL| STACC
    STACC -.-> |presigned URL| UI
    CLOUD -.-> |presigned retrieval| BROWSER
  end

  style CLOUD fill:#77913C
  style RDS fill:#F68D2F
  style LDAP fill:cyan
  style ZOO fill:cyan
  style EZID fill:cyan
  
  classDef FOCUS stroke:red,stroke-width:5px,fill:yellow

Loading

Merritt UI Permalink Resolution

graph TD
  N2T[N2T Service]
  click N2T href "https://n2t.net/" "service link"
  UI[Merritt UI]
  Permalink[/Merrit UI Permalink/]

  UI --> |contains| Permalink
  Permalink --> N2T
  N2T -.-> |resolves to| EZID
  EZID -.-> |resolves to| UI

Loading

Audit and Replication Services (Java)

%%{init: {'theme': 'neutral', 'securityLevel': 'loose', 'themeVariables': {'fontFamily': 'arial'}}}%%
graph TD
  CLOUD(("Cloud Storage"))
  click CLOUD href "https://github.com/CDLUC3/mrt-cloud" "source code"
  RDS[(Inventory DB)]
  AUD(Audit)
  click AUD href "https://github.com/CDLUC3/mrt-audit" "source code"
  REP(Replication)
  click REP href "https://github.com/CDLUC3/mrt-replic" "source code"

  subgraph flowchart
    RDS --> AUD
    RDS --> REP
    CLOUD --> AUD
    CLOUD --> REP
    REP --> CLOUD
  end

  style CLOUD fill:#77913C
  style RDS fill:#F68D2F

Loading

Code Repositories

• Ruby
  • UI
• Java
  • Ingest
  • Inventory
  • Storage (Store and Access)
  • Replication
  • Audit (Fixity Check)

Other Production Services (Python/XSLT)

• ETD - Electronic Theses and Dissertations

Libraries

• Java
  • Core
  • Cloud
• Java and Ruby
  • Merritt ZK (created in 2024)
• Ruby
  • SSM Gem - Shared with other UC3 services
  • Merritt Atom - Nuxeo processing for ingest
    • Uses Ruby Ingest

Configuration

• Tomcat

Supporting Services

• Java
  • Merritt Box Tools
• Ruby
  • Admin Tool
  • Merritt End to End Tests
  • Merritt Integration Test Images
  • Merritt Crons Jobs
    • Merritt Consistency reports
    • Merritt OpenSearch Visualizations
    • Merritt Object Health analysis
  • Ingest Workspace Manifest Builder
  • Merritt Admin Tool for New AWS Account
• Docker
  • Merritt Docker
• Other
  • Merritt LDAP Permission Tools
  • Merritt Maintenance Scripts

Documentation Tools (Python)

• Merritt Repository Tagger

Merritt DevOps

• Merritt Build System Design
• Merritt Tomcat Deploy
• Merritt Service Release Manifest
• Merritt Sceptre Scripts
• Deprecated?
  • Merritt Ansible Deployment Tools

Project Overview

• Project Board
• System Operations Board
• System Enhancement Ideas Grouped by Theme

More info

• Deprecated Functionality