Requirements
Check the account, Kubernetes, network, storage, backup, and access prerequisites for RestoreTrust.
Loading documentation…
Prepare the following before you create a schedule.
Current quotas and the shortest available schedule cadence appear under Plan/Quotas. Do not design around fixed limits from another account or an older plan.
Checks run through a project worker in a Kubernetes cluster you control. You need:
Follow the Kubernetes installation guide for current Kubernetes compatibility, cluster permissions, and installation verification.
The worker environment must be able to:
FTP uses passive data connections in addition to the configured control port. Allow the server's passive data-port range to the same resolved server address. SMB sources must point to a direct server and share; DFS referrals are not a supported source path.
Email and webhook notifications are sent by RestoreTrust, not by the project worker. Webhook destinations must use HTTPS in customer environments; private or internal destinations and IP-literal URLs are not accepted.
Prepare at least one supported source:
| Source | Required location information | Credential keys |
|---|---|---|
| S3-compatible | Endpoint, port, region, bucket, addressing style | AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY; optional AWS_SESSION_TOKEN |
| FTP | Host and port | RT_SOURCE_USERNAME, RT_SOURCE_PASSWORD |
| SFTP | Host and port | RT_SOURCE_USERNAME, RT_SOURCE_PASSWORD |
| SMB | Host, port, and share | RT_SOURCE_USERNAME, RT_SOURCE_PASSWORD |
Use a source credential restricted to the backup locations RestoreTrust needs. Create the values as a Kubernetes Secret in each selected worker's job namespace and register only its metadata in RestoreTrust.
For database restores, know the database engine and exact source version. The console provides the currently supported version choices. Also know whether the artifact uses an archive container, compression, ZIP password, or age encryption.
The temporary environment must hold and process the downloaded artifact, decoded contents, and restored database. A small compressed file can expand substantially. Set each schedule's scratch size with that expansion in mind.
Define what makes a restore useful before scheduling it. Database schedules require gates; choose queries and duration limits that detect failures important to your recovery objective. File checks can require maximum age and minimum or maximum size.
Once these prerequisites are ready, continue with the Quickstart.