Capsule snapshot

This topic describes the Capsule snapshot section, how to create a Capsule snapshot, and its other features.

The Capsule snapshot page allows you to create and manage snapshots of all Capsule folders and Capsules of the Platform on which the Capsule snapshot action is performed. A snapshot is essentially a backup of all Capsule folders and Capsules of a Platform. You can use snapshots to create a Capsule package in order to transport the Capsule folder structure and content from one Platform to another.

To access the Capsule snapshot section, access the System Administration area of the desired Platform and click on the Capsule snapshot tile to open the Capsule snapshot page.

In the Capsule snapshot page, you can see all existing snapshots and their main information: the table is sortable and searchable using the interactive header fields. You can also show or hide columns to your liking by clicking the Column chooser button in the upper right corner of the table.

The table contains the following information:

• Snapshot. This column displays the name of each Capsule snapshot

• Date time. This column displays the date and time of the creation of each Capsule snapshot, in the following format: DD/MM/AAAA, HH:SS

• Environment. This column displays the name of the Platform environment where each Capsule snapshot was created (i.e. "Production" or "Development" etc.)

• Golden copy. This column displays if a snapshot has been flagged as a Golden copy or not, which prevents the Capsule snapshot from being automatically deleted

• User. This column displays the Account name of the user that created each Capsule snapshot

• Comments. This column displays additional comments on each Capsule snapshot. You can click on the desired column field to edit a comment

• Size. This column displays the total storage space in Megabytes that each Capsule snapshot occupies on the Platform machine.

Creating a Capsule snapshot

To create a Capsule snapshot, proceed as follows:

1. From the Capsule snapshot section of the desired Platform, click on the blue plus button  next to "Capsule Snapshot" to open the "Create new snapshot" configuration popup window

2. Enter the name of the snapshot in the "Snapshot name" field

3. Enter your desired note or comment in the "Comment" field, if needed

4. (Optional) Enable the "Golden copy" option to prevent the snapshot from being deleted automatically when the storage space limit is reached. This is also useful when you want to pin a backup snapshot that you can easily identify in case you want to perform a rollback

5. Click on "OK" to save the snapshot

The newly created snapshot contains the full Capsule folder structure and content of the current Platform.

There is a storage space limit. Once it is reached and you try to create a new snapshot, Board will warn you and ask if you want to automatically delete the oldest snapshots to free up the necessary space for the new snapshot. Snapshots that have the "Golden copy" option enabled are excluded from the automatic deletion.

The occupied storage space displayed at the bottom left of the screen includes the sum of the storage space occupied by both Capsule snapshots and Capsule packages.

Managing a Capsule snapshot

The Capsule snapshot page allows you to perform the following management tasks on existing Capsule snapshots:

• Edit a Capsule snapshot

• Rename a Capsule snapshot

• Remove a Capsule snapshot

• Download a Capsule snapshot to your local computer.

• Upload a Capsule snapshot to the Platform you are working on

• Create a Capsule package

To edit a Capsule snapshot, select it to open the snapshot configuration panel and modify the desired options explained in the steps in the Capsule snapshot creation process above. Under the "Content" menu, the snapshot configuration panel displays all the Capsules, Capsule folders, and their hierarchy that the selected snapshot contains.

To rename a Capsule snapshot, select it and click on the rename icon . A popup window will appear where you can rename the snapshot and click "OK" to save it.

To delete a Capsule snapshot, select the desired ones and click on the trash icon.

To upload Capsule snapshots, click on the "UPLOAD" button and choose the .zip file containing the desired snapshots.

To download Capsule snapshots, select the desired ones and click on the "DOWNLOAD" button. A .zip file containing the selected snapshots will be downloaded to your local machine.

To create a Capsule package, select the two desired snapshots and click on the "CAPSULE PACKAGE" button to open the Capsule package configuration panel. See the Create a Capsule package section to learn how to create a Capsule package.