Backup runbook
On this page
The backup runbook can be triggered manually or on a set schedule. It is responsible for capturing snapshots of all persistent disks used by CluedIn.
This runbook is a PowerShell script, which CluedIn will provide as needed.
Prerequisites
- An active CluedIn cluster with a valid license
- The runbook script
- An automation account
- A storage account
- Sufficient permissions
Typical persistent disks
CluedIn configurations may vary, but a typical instance includes the nine disks as shown below.
Automation account
An automation account must be provided. The runbook will be installed into the the automation account. Typically, the runbook should be scheduled to run once a day outside of office hours.
Snapshots
Upon a successful run, the runbook generates nine snapshots and stores them in a resource group for seven days.
Input parameters
| Parameter | Default | Description |
|---|---|---|
| ClusterName | required | Name of the target AKS cluster |
| CustomerName | required | Name of customer |
| Subscription | required | ID of the azure subscription |
| SnapshotType | Incremental | Incremental or Full |
| BackupResourceGroup | required | Name of resource group where the snapshots will be saved to |
| RetentionCount | 7 | Number of days to retain the snapshots |
| EnableScaling | true | Scale down the cluster during restore |
Process
Scaling up or down deployments is optional. However, it is recommended to prevent data loss while capturing snapshots.