Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for the existing stable memory backups #2306

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Add documentation for the existing stable memory backups #2306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/internet_identity/stable_memory/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ These tests serve two purposes:
* Show that we can indeed fully recover in case of a disaster, assuming
we have a backup of the stable memory.

## Stable Memory Backups

The following stable memory backups are currently used:
* `buffered_archive_entries_v8.bin.gz`: a backup with buffered archive entries.
* `genesis-layout-migrated-to-v8.bin.gz`: a backup initially created with the first version of the stable memory layout and then incrementally migrated to the v8 layout. It contains a few well-known identities / devices, see `known_devices` in `tests/integration/stable_memory.rs`.
* `genesis-memory-layout.bin`: a backup of the initial memory layout. Not migrated. Mainly used to test behavior with respect to outdated / unsupported memory layouts.
* `multiple-recovery-phrases-v8.bin.gz`: a backup with an identity that has multiple recovery phrases. The input validation does no longer allow to create such an identity (only one recovery phrase is allowed). However, legacy users that are in that state need a way to make their identity consistent again. This backup is used to test exactly that.
* `no-persistent-state-v8.bin.gz`: a backup without persistent state. Used to check that II indeed fails to upgrade from such a state.
* `persistent_state_archive_v8.bin.gz`: a backup to check that archive state and configuration are restored correctly.
* `persistent_state_no_archive_v8.bin.gz`: a backup to check that persistent state without an archive is restored correctly.

## Creating New Test Memory Backups

### Using Canister Test Infrastructure
Expand Down
Loading