---
title: Restore runbook
url: https://documentation.cluedin.net/operate/backup-and-restore/restore-runbook
content_type: how-to
section: Deploy & operate > Backup and restore
---

# Restore runbook

> how-to: Steps to accomplish one task.

The restore runbook can be triggered manually or on a predefined schedule. It handles the removal of all persistent disks and restores them from snapshots.

This runbook is a PowerShell script, which CluedIn will provide as needed.

**Prerequisites**

- An active or passive 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. All must be restore from snapshots.

## Automation account

An automation account must be provided. The runbook will be installed into the the automation account. Typically, the runbook should be triggered following a backup/copy event.

## Scaledown

The runbook will optionally scale down the target CluedIn instance after the restore.

![Diagram: the runbook loops through nine disk snapshots in the target resource group, removing each disk and restoring it from snapshot (elasticsearch, openrefine-data, neo4j, rabbitmq, redis, and four sqlserver disks) attached to the CluedIn AKS cluster](https://documentation.cluedin.net/assets/images/paas-operations/restore-runbook.png)

## Input parameters

| Parameter | Default | Description |
|--|--|--|
| LicenseKey | _required_ | License key tag on snapshot |
| Timestamp | _required_ | Timestamp on snapshot |
| HostResourceGroup | _required_ | Name of source resource group |
| Subscription | _required_ | ID of target Azure subscription |
| TargetResourceGroup | _required_ | Name of target resource group |
| TargetAKSClusterName | _required_ | Name of target AKS cluster |
| StorageAccountName | _required_ | Name of storage account |
| Scaledown | `false` | Option to scale down after a successful restore |

## Process

![Flowchart: Start, retrieve snapshots by license key and timestamp, scale down deployments and stateful sets, loop through disks, replace each disk from its snapshot, scale everything up, optionally scale down, Stop](https://documentation.cluedin.net/assets/images/paas-operations/restore-runbook-process.png)

## Permissions

The runbook must be granted the following permissions:

| Resource                     | Assigned Role(s)                                             | Why This Role is Needed                                                                 |
|------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------|
| AKS Resource Group           | Reader                                                       | Required to read AKS configurations and metadata.                                        |
| AKS Instance                 | Contributor                                                  | Required to scale AKS Instance and send aks command.                                     |
| Snapshot Resource Group      | Reader, Disk Snapshot Contributor                           | Required to read snapshots and creating/managing disk snapshots in the resource group.   |
| AKS Node Resource Group      | Reader, Disk Snapshot Contributor, VM Restore Contributor    | Required to read list of disk, delete old disk, and restore new Disk from snapshot.      |
| Storage Account Resource Group | Reader                                                     | Required to read Storage account configurations and metadata.                            |
| Storage Account              | Storage Blob Data Contributor, Storage Account Key Operator Service Role | Required to store pod replica configuration during scaling down. |

Up: [Backup and restore](https://documentation.cluedin.net/operate/backup-and-restore.md)