Quickstart

This guide takes you from an empty account to a first completed check.

Before you begin

You need:

• permission to create resources in a RestoreTrust project
• a supported plan with capacity for a project worker and check
• a Kubernetes cluster where you can apply the generated worker manifests
• network access from that cluster to RestoreTrust and your backup source
• one supported backup or file to test

Review the full requirements before using a production-like cluster.

1. 1

   Create an organization and project

   Complete account verification, create or join an organization, and create a project. Use projects to separate workers, credentials, schedules, and API keys. Organization members inherit their roles across its projects; use separate organizations when human access must differ.

2. 2

   Install a project worker

   In the active project, open Project workers and create a worker. Set its maximum parallel jobs to a value your cluster and source can sustain. Apply the generated Kubernetes manifests, then wait until the worker is Online.

   See Project workers and the Kubernetes installation guide for the detailed cluster procedure.

3. 3

   Prepare secret metadata and values

   Open Secrets and create source credential metadata. In the project worker's job namespace, create a Kubernetes Secret with the displayed name and the required keys.

   RestoreTrust stores the metadata and Kubernetes Secret name, not the values. See Source credentials for the keys expected by each source type.

4. 4

   Add the backup source

   Open Sources, select S3, FTP, SFTP, or SMB, and enter the host details. Select the matching active source secret, save, and confirm that the values describe the location the project worker can reach.

5. 5

   Create a schedule

   Open Schedules and choose the project worker, source, backup path, and file-matching method. Select a file check or a database restore. For database restores, choose the exact database version and add gates that test the result.

   Configure the cadence and optional notification channels. Schedule times and date variables are evaluated in UTC.

6. 6

   Run and review a check

   Start a manual run from the schedule or choose the option to run once after creation. Open the resulting check to review its status, logs, probes, messages, and available evidence.

If the first run fails, use the failed stage and relevant logs to narrow the cause. A successful first run is a baseline; improve the schedule with gates that represent the data and recovery conditions your organization actually depends on.