Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

PROBLEM: AIP recovery documentation is unclear how to copy uncompressed replicated AIPs and requires API request updates #1546

Closed
3 tasks
sarah-mason opened this issue Mar 28, 2022 · 1 comment
Labels
Status: review The issue's code has been merged and is ready for testing/review. Type: documentation The issue requires documentation.
Milestone

Comments

@sarah-mason
Copy link

Version of the documentation
1.13

Page (and section, if applicable) where the issue occurs
https://www.archivematica.org/en/docs/storage-service-0.19/recovery/#example-recovery-request

Description of the issue
There are some changes required to the documentation to make AIP recovery clear, especially when using a replicator location. They are:

  • How to copy uncompressed replicated AIPs is not stated
  • The recovered AIP permissions for the Storage Service to perform AIP recovery is not stated
  • The API request needs to be updated to reflect the API documentation

Suggested fix
Documentation updates should include:

  • uncompressed AIP replicas must be copied to the recovery location with the original AIP uuid in the package name, not the replica uuid
  • permissions for AIPs and all files must be set to archivematica as owner to work properly
  • API request should be updated based on API documentation in dev manual and a link to API documentation added

For Artefactual use:

Before you close this issue, you must check off the following:

  • All pull requests related to this issue are properly linked
  • All pull requests related to this issue have been merged
  • Details about this issue have been added to the release notes (if applicable)
@sarah-mason sarah-mason added the Type: documentation The issue requires documentation. label Mar 28, 2022
@sromkey sromkey added the Status: ready The issue is sufficiently described/scoped to be picked up by a developer. label Mar 28, 2022
@sromkey sromkey added this to the 1.17.0 milestone Sep 9, 2024
@replaceafill replaceafill self-assigned this Sep 18, 2024
@replaceafill replaceafill added Status: in progress Issue that is currently being worked on. and removed Status: ready The issue is sufficiently described/scoped to be picked up by a developer. labels Sep 18, 2024
@replaceafill replaceafill removed their assignment Sep 23, 2024
@replaceafill replaceafill added Status: review The issue's code has been merged and is ready for testing/review. and removed Status: in progress Issue that is currently being worked on. labels Sep 23, 2024
@JBosse-Artefactual
Copy link

The issue has been resolved in 0.22 documentation of the recovery process can now replace both compressed and uncompressed AIPs as described in the documentation. To be added to the documentation "Ensure the AIP recovery directory is empty before starting the recovery process, and if a recover directory exists inside the internal processing location (e.g. /var/archivematica/storage_service/var/archivematica/storage_service/recover), make sure it is empty as well."

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Status: review The issue's code has been merged and is ready for testing/review. Type: documentation The issue requires documentation.
Projects
None yet
Development

No branches or pull requests

4 participants