nuoarchive

nuoarchive is a command-line tool that performs the following tasks:

To get the location of the archive, run nuocmd get archives. File Archives use the directory pathname with no prefix as the location and Log-structured Archives (LSA), use lsa:<directory>

Important Notes

  • Before performing nuoarchive, ensure that no SM is running on the archive storage, as nuoarchive cannot be executed while the archive is in use by an SM.

    If the SM is using the archive, the execution stops with the following error message:

    [ERROR] check: Archive is already in use: <location>

    Similarly, if nuoarchive is running on an archive (in any mode), then any attempt to start an SM on that archive fails reporting that the archive is locked.

  • nuoarchive commands must be invoked by the operating system user account that owns the archive directory.

    If another user invokes nuoarchive, the following error message is generated:

    nuoarchive: Permissions error: archive owned by system account 'other_user'

    To run nuoarchive on an encrypted archive (see Transparent Data Encryption) the storage password that was current when the archive was last in use is required. By default, nuoarchive prompts for the storage password. The password is not displayed on the screen. To provide the password non-interactively, either use a Linux pipe command to send the password through standard input or set the storage password in the NUODB_STORAGE_PASSWORD environment variable. If an incorrect password is provided, nuoarchive will fail.

  • Access to the archive storage as a local directory is required:

    • In bare metal environments, use ssh <archive_owner>@<archive_host>.

    • In containerized environments such as Docker, use docker exec -it <archive_container_name> bash.

    • In Kubernetes environments, use kubectl exec -it <archive_container_name> bash.