Documentation

Overview

This page is the documentation home for APTrust. Content that used to be available on the Member Wiki (wiki.aptrust.org) is now located here.

Documentation is organized into the following categories.

• Overview
• Trusted Digital Repository (TDR – ISO 16363)
• Software Documentation
• Technical Documentation (restricted to members)

• Trusted Digital Repository
• OAIS Documents
  • Designated Community
  • Definition of AIP
  • Definition of DIP
  • Definition of SIP
  • Mandatory Responsibilities
  • Preservation and Storage
• TDR 3.0 Organizational Infrastructure
  • 3.1.1 Mission Statement
  • 3.1.2 Preservation strategic plan
  • 3.1.2.1 Succession, contingency, escrow plans
  • 3.1.2.2 Monitor Environment for time to deploy Succession, Contengency, Escrow
  • 3.1.3 Collection Policy
  • 3.2.1 Identified duties and appointed staff
  • 3.2.1.1 Identified and established duties
  • 3.2.1.2 Appropriate number of staff
  • 3.2.1.3 Professional Development Program
  • 3.3.1 Designated community
  • 3.3.2.1 Review and update preservation policies
  • 3.3.2 Preservation policies
  • 3.3.3 Documented history of changes
  • 3.3.4 Commit to Transparency
  • 3.3.5 Information integrity measurements
  • 3.3.6 Self-assessment and external certification
  • 3.4.1 Business planning processes
  • 3.4.2 Financial transparency, compliance, and audits
  • 3.4.3 Risk, benefit, investment, expenditure
  • 3.5.1 Contracts or deposit agreements for content
  • 3.5.1.1 Contracts or deposit agreements for preservation rights
  • 3.5.1.2 Completeness of agreements with depositors
  • 3.5.1.3 Policies about preservation responsibility
  • 3.5.1.4 Policies about liability and rights challenges
  • 3.5.2 Track and manage property rights/restrictions
• TDR 4.0 Digital Object Management
  • 4.1.1 Content information and information properties
  • 4.1.1.1 Identification of information properties
  • 4.1.1.2 Record of content information and information properties
  • 4.1.2 The repository shall clearly specify the information that needs to be associated with specific Content Information at the time of its deposit.
  • 4.1.3 Recognition and parsing of SIPs
  • 4.1.4 Verification of Producer
  • 4.1.5 Verification of SIP
  • 4.1.6 Control over digital objects document
  • 4.1.7 Communication with producer/depositor
  • 4.1.8 Acquisition records
  • 4.2.1 Associated definition for each AIP or class of AIPs
  • 4.2.1.1 Identify which definition applies to which AIP
  • 4.2.1.2 Definition of each AIP
  • 4.2.2 Description of how AIPs are constructed from SIPs
  • 4.2.3 Document final disposition of all SIPs
  • 4.2.3.1 Procedures if a SIP is not incorporated or discarded
  • 4.2.4 Convention that generates persistent, unique identifiers for AIPs
  • 4.2.4.1 Uniquely identify each AIP
  • 4.2.4.1.1 Have unique identifiers
  • 4.2.4.1.2 Assign and maintain persistent identifiers of the AIP and its components
  • 4.2.4.1.3 Describe any processes for changes to identifiers
  • 4.2.4.1.4 Provide a list of all identifiers and check for duplications
  • 4.2.4.1.5 System of identifiers is adequate now and in the future
  • 4.2.4.2 System of reliable linking/resolution services in order to find identified objects
  • 4.2.5 Tool and resources to provide authoritative Representation Information for all objects
  • 4.2.5.1 Tools or methods to identify the file types of all objects
  • 4.2.5.2 Tools or methods to determine what Representation Information is necessary for understandability
  • 4.2.5.3 Have access to the requisite Representation Information
  • 4.2.5.4 Tools or methods to ensure that Representation Information is persistently associated with objects
  • 4.2.6 Documented processes for acquiring PDI for associated Content Data Object
  • 4.2.6.1 Documented processes for acquiring PDI
  • 4.2.6.2 Execute documented processes for acquiring PDI
  • 4.2.6.3 PDI is persistently associated with the Content Data Object
  • 4.2.7 Content Information is understandable for Designated Community at the time of AIP creation
  • 4.2.7.1 Processes for testing understandability for Designated Community of the Content Information of AIPs
  • 4.2.7.2 Execute testing process of Content Information of AIPs
  • 4.2.7.3 Bring Content Information of AIP up to level of understandability if it fails testing
  • 4.2.8 Verify each AIP for completeness and correctness
  • 4.2.9 Independent mechanism for verifying the integrity of the content
  • 4.2.10 Contemporaneous records of actions and administration processes relevant to AIP creation
  • 4.3.1 Documented preservation strategies relevant to its holdings
  • 4.3.2 Mechanisms for monitoring its preservation environment
  • 4.3.2.1 Mechanisms for monitoring and notification when Representation Information is inadequate for the Designated Community to understand the data holdings
  • 4.3.3 Mechanisms to change preservation plans as a result of its monitoring activities
  • 4.3.3.1 Mechanisms for creating, identifying or gathering any extra Representation Information required
  • 4.3.4 Provide evidence of the effectiveness of its preservation activities
  • 4.4.1 Specifications for how the AIPs are stored down to the bit level
  • 4.4.1.1 Content Information preservation
  • 4.4.1.2 Monitoring integrity of AIPs
  • 4.4.2 AIP storage and preservation records
  • 4.4.2.1 AIP procedures
  • 4.4.2.2 Compliance with specification
  • 4.5.1 Specify minimum information requirements to enable the Designated Community to discover and identify material
  • 4.5.2 Capture or create minimum descriptive information for each AIP
  • 4.5.3 Create bi-directional linkages between each AIP and its descriptive information
  • 4.5.3.1 Maintaining Associations
  • 4.6.1 Comply with Access Policies
  • 4.6.1.1 Log and review all access management failures and anomalies
  • 4.6.2 Follow policies and procedures that enable the dissemination of digital objects that are traceable to the originals
  • 4.6.2.1 Record and act upon problem reports about errors in data and responses from users
• TDR 5.0 Infrastructure and Security Risk Management
  • 5.1.1 Identify and manage the risks to its preservation operations
  • 5.1.1.1 Employ technology watches
  • 5.1.1.1.2 Procedures in place to monitor and receive notifications
  • 5.1.1.1.3 Procedures in place to evaluate when changes are needed
  • 5.1.1.1.4 Procedures, commitment and funding to replace hardware
  • 5.1.1.1.5 Software technologies appropriate to the services
  • 5.1.1.1.6 Procedures in place to monitor and receive notifications when software changes are needed
  • 5.1.1.1.7 Procedures in place to evaluate when changes are needed to current software
  • 5.1.1.1.8 Procedures, commitment and funding to replace software when evaluation indicates the need to do so
  • 5.1.1.2 The repository shall have adequate hardware and software support for backup functionality sufficient for preserving the repository content and tracking repository functions.
  • 5.1.1.3 Effective mechanisms to detect bit corruption or loss
  • 5.1.1.3.1 Record and report to its administration all incidents of data corruption or loss, and steps shall be taken to repair/replace
  • 5.1.1.4 Process to record and react to the availability of new security updates based on a risk-benefit assessment
  • 5.1.1.5 Defined processes for storage media and/or hardware change (e.g., refreshing, migration)
  • 5.1.1.6 Identified and documented critical processes that affect its ability to comply with its mandatory responsibilities
  • 5.1.1.6.1 Documented change management process that identifies changes to critical processes that potentially affect the repository’s ability to comply
  • 5.1.1.6.2 Process for testing and evaluating the effect of changes to the repository’s critical processes document
  • 5.1.2 Manage the number and location of copies of all digital objects document
  • 5.1.2.1 Mechanisms in place to ensure any/multiple copies of digital objects are synchronized document
  • 5.2.1 Maintain a systematic analysis of security risk factors associated with data, systems, personnel, and physical plant document
  • 5.2.2 Implemented controls to adequately address each of the defined security risks
  • 5.2.3 Staff shall have delineated roles, responsibilities, and authorizations related to implementing changes
  • 5.2.4 Suitable written disaster preparedness and recovery plan(s), including at least one off-site backup of all preserved information

• DART: Digital Archivist’s Resource Tool
• Registry
• Partner Tools
• Preservation Services

• Security
  • 2.0 IAM
    • APTrust AWS IAM Summary
    • Data Integrity – Fixity and Hashes
    • Digital Certificates for SSL
    • IAM Summary
    • Registry IAM
    • Security Summary and Strategy
    • SSH Keys, Tokens, and Devices
    • Systems Secrets Management
  • Security Principles
  • Authentication & Administration
  • Business Continuity
  • Risk Management, Threats, and Mitigations
  • 2.0 Monitoring and Audit
    • Logging
    • Monitoring
    • Monitoring and Logging Infrastructure
  • 2.0 Processes
• Development
  • Code Repositories
  • Software Development Styleguide
  • Support and Maintenance
  • Member API
  • New Institution Checklist
  • Technical Glossary
• System Infrastructure
  • Components
    • Bastion Host
    • Container and Cluster Configuration Summary
    • Elasticache
    • NSQ Infrastructure
    • Preservation Infrastructure
      • Preservation Sequence Diagram
    • RDS Postgres
    • Registry Infrastructure
  • Storage
    • Storage Infrastructure
  • Networking
    • Load Balancing Implementation and Infrastructure Summary
    • DNS Implementation and Infrastructure Summary
    • NAT Gateway Implementation and Infrastructure Summary
    • Networking Infrastructure Summary
    • Security Groups Summary
• Enterprise Systems
  • DockerHub
  • GitHub
  • GitLab
  • Google Workspaces
    • APTrust Mailing Lists
  • Legacy Systems
  • Slack
  • Trello
  • Twitter
  • WordPress
• Operational Technical Documentation
  • AWS Systems Deployment
  • Onboarding Members
  • Updating APTrust Container Clusters
  • Updating Infrastructure
  • Current Institutional Onboarding Spec (Setup Institutions in APTrust)
  • Reporting
• Historic Documentation