1. Guides
  2. Get started
  3. Requirements
Website
  • Overview
  • Quickstart
  • How RestoreTrust works
  • Requirements
  • Organizations and projects
  • Project workers
  • Test schedules
    • File checks
  • Validation gates
  • Time zones and dates
  • Manual runs
  • Notifications
  • Check results
  • Execution logs
  • Reports
  • Evidence and verification
  • Team and roles
  • API keys
  • Billing and plans

Requirements

Check the account, Kubernetes, network, storage, backup, and access prerequisites for RestoreTrust.

Loading documentation…

How RestoreTrust works< PreviousOrganizations and projectsNext >

Powered by heyo

On this page

RestoreTrust accountKubernetes project workerNetwork accessBackups and credentialsValidation criteria

Prepare the following before you create a schedule.

RestoreTrust account

  • An organization and project
  • An active plan with capacity for the resources and check frequency you need
  • Owner, Technical admin, or Editor access to create project resources
  • Access to your email when an invitation or sensitive account change requires a verification code

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.

Kubernetes project worker

Checks run through a project worker in a Kubernetes cluster you control. You need:

  • permission to apply the manifests generated when the worker is created
  • enough compute, memory, and scratch storage for the largest expected restore
  • a usable storage class for temporary check volumes
  • a maximum parallel-jobs setting that fits cluster and source capacity
  • the namespaces selected during worker installation, including the job namespace where check Secrets are created

Follow the Kubernetes installation guide for current Kubernetes compatibility, cluster permissions, and installation verification.

Network access

The worker environment must be able to:

  • resolve DNS and establish outbound TLS to the generated RestoreTrust worker endpoint
  • reach the configured source host and port
  • retrieve the selected backup within the schedule's time and resource limits

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.

Backups and credentials

Prepare at least one supported source:

SourceRequired location informationCredential keys
S3-compatibleEndpoint, port, region, bucket, addressing styleAWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY; optional AWS_SESSION_TOKEN
FTPHost and portRT_SOURCE_USERNAME, RT_SOURCE_PASSWORD
SFTPHost and portRT_SOURCE_USERNAME, RT_SOURCE_PASSWORD
SMBHost, port, and shareRT_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.

Plan for restore size, not compressed size

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.

Validation criteria

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.