Skip to content

Commit 3717b8b

Browse files
docs: offline snapshots (#548)
* docs: offline snapshots Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> * 📄 Update LLMs.txt snapshot for PR review --------- Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent c967008 commit 3717b8b

2 files changed

Lines changed: 32 additions & 4 deletions

File tree

.llms-snapshots/llms-full.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6904,22 +6904,36 @@ You can manually create, restore, and delete snapshots for each module as needed
69046904

69056905
Snapshots are also automatically created during the upgrade process, capturing a snapshot when upgrading to a new version. If preferred, you can opt out in the advanced options to skip creating a snapshot or prevent overwriting an existing one. However, given the sensitivity of such processes, we strongly recommend always having a snapshot available or at least ensuring a way to restore your data—for example, by being prepared to redeploy your application quickly.
69066906

6907+
Snapshots can also be downloaded and uploaded offline using the CLI, allowing you to store them externally and re-import them later if needed.
6908+
69076909
---
69086910

69096911
## Limitations
69106912

6911-
As determined by the Internet Computer (see the [specification](https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-take_canister_snapshot)), only one snapshot per module is currently allowed. If this evolves in the future, Juno will be updated accordingly.
6913+
Snapshots are stored on-chain, and the cost of a snapshot's memory consumption is charged to the module itself. This means they follow the lifecycle of your modules — if the module is deleted or runs out of cycles, its snapshot is also removed.
6914+
6915+
Each module is currently limited to one snapshot at a time. This approach offers a balance between flexibility and cost-efficiency, providing a reliable recovery point without unnecessary on-chain storage costs.
69126916

6913-
Snapshots are stored on-chain, and the cost of a snapshot’s memory consumption is charged to the module itself. This means they follow the lifecycle of your modules — if the module is deleted or runs out of cycles, its snapshot is also removed.
6917+
If the need for multiple snapshots arises in the future, support may be expanded. Reach out and let us know.
69146918

69156919
This is why snapshots should not be mistaken for backups. Unlike true backups, they do not provide historical retention, off-chain storage, or protection against accidental loss of control. For long-term data protection, external backups — such as secure cold storage for sensitive data — are recommended.
69166920

6921+
With the ability to download snapshots offline, you can create your own backup routine, for example, keeping copies in secure storage for long-term protection.
6922+
69176923
---
69186924

69196925
## Frequency of Snapshots
69206926

69216927
Snapshots are automated during code upgrades, with the option to opt out. Alternatively, snapshots can be managed manually.
69226928

6929+
---
6930+
6931+
## Advanced Use
6932+
6933+
In addition to standard recovery, snapshots can also be uploaded to reapply the code and state from one module to another. For example, you can download a snapshot from Satellite A and use it to replace Satellite B.
6934+
6935+
This should be used carefully though, as snapshots also include elements such as public access keys and user IDs. Applying one module's snapshot to another may cause unintended side effects.
6936+
69236937
# Access Keys
69246938

69256939
Access keys play a crucial role in granting permissions to Mission Controls, Satellites or Analytics within Juno.

docs/management/snapshots.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,34 @@ You can manually create, restore, and delete snapshots for each module as needed
1616

1717
Snapshots are also automatically created during the upgrade process, capturing a snapshot when upgrading to a new version. If preferred, you can opt out in the advanced options to skip creating a snapshot or prevent overwriting an existing one. However, given the sensitivity of such processes, we strongly recommend always having a snapshot available or at least ensuring a way to restore your data—for example, by being prepared to redeploy your application quickly.
1818

19+
Snapshots can also be downloaded and uploaded offline using the CLI, allowing you to store them externally and re-import them later if needed.
20+
1921
---
2022

2123
## Limitations
2224

23-
As determined by the Internet Computer (see the [specification](https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-take_canister_snapshot)), only one snapshot per module is currently allowed. If this evolves in the future, Juno will be updated accordingly.
25+
Snapshots are stored on-chain, and the cost of a snapshot's memory consumption is charged to the module itself. This means they follow the lifecycle of your modules — if the module is deleted or runs out of cycles, its snapshot is also removed.
26+
27+
Each module is currently limited to one snapshot at a time. This approach offers a balance between flexibility and cost-efficiency, providing a reliable recovery point without unnecessary on-chain storage costs.
2428

25-
Snapshots are stored on-chain, and the cost of a snapshot’s memory consumption is charged to the module itself. This means they follow the lifecycle of your modules — if the module is deleted or runs out of cycles, its snapshot is also removed.
29+
If the need for multiple snapshots arises in the future, support may be expanded. Reach out and let us know.
2630

2731
This is why snapshots should not be mistaken for backups. Unlike true backups, they do not provide historical retention, off-chain storage, or protection against accidental loss of control. For long-term data protection, external backups — such as secure cold storage for sensitive data — are recommended.
2832

33+
With the ability to download snapshots offline, you can create your own backup routine, for example, keeping copies in secure storage for long-term protection.
34+
2935
---
3036

3137
## Frequency of Snapshots
3238

3339
Snapshots are automated during code upgrades, with the option to opt out. Alternatively, snapshots can be managed manually.
3440

41+
---
42+
43+
## Advanced Use
44+
45+
In addition to standard recovery, snapshots can also be uploaded to reapply the code and state from one module to another. For example, you can download a snapshot from Satellite A and use it to replace Satellite B.
46+
47+
This should be used carefully though, as snapshots also include elements such as public access keys and user IDs. Applying one module's snapshot to another may cause unintended side effects.
48+
3549
[console]: ../terminology.md#console

0 commit comments

Comments
 (0)