Backup/Restore Usage Details

This guide walks through the disaster recovery process within Telicent Core.

The aim is to provide a narrative that guides an admin user through using the backup endpoints to view, create, restore or delete back-ups of Smart Cache Graph and Smart Cache Search data. It will show the results of calls, what to expect and the steps to take to carry out each of the operations listed here.

Detailed steps

For each operation, we will illustrate the calls to make, the process behind the scenes, the results returned and the differences between the various Smart Cache implementations.

Smart Cache Graph

Smart Cache Search

Search can back up a selected index or all eligible current indices. See creating a Search backup.

Submitting and monitoring asynchronous jobs

Caveats

Endpoints

Replace https://telicent.core.domain with your deployment URL. The examples use the gateway paths /api/sparql/backups for Graph and /api/search/backups for Search. Direct Graph requests use /$/backups; direct Search requests use /backups.

Authentication

Any and all authentication tokens will be hidden as will any other secured information not pertinent to the purpose of this document. We will assume that $TC_OIDC_TOKEN will represent a working token for a user with sufficient administration permissions to call these endpoints.

Permissions

Use an account with the backup permissions required by your deployment. Search checks separate permissions for writing, restoring, deleting and reading backups; group membership alone may not grant every operation.

Private data

In the guided examples, results and responses may be truncated or edited in order to hide proprietary or sensitive information.

Changing data

Some of the data described, in particular the response data returned, may be subject to change. This is in part due to the functionality being new and still under review and customer feedback. Additional value will be added where possible and ineffective information removed.

Check the API supported by your deployed version before using these examples.

Enabling backups

Graph requires ENABLE_BACKUPS=true; its backup endpoints are disabled by default. Search enables backups by default. Setting ENABLE_BACKUPS=false in Search disables snapshot repository health checks and makes backup endpoints return HTTP 503.

Graph backup storage and Search snapshot repository storage must be configured and accessible to their respective services. Search examples explicitly use scs-snapshots-repo, the built-in default repository name. Use your deployment’s repository name if different. DEFAULT_SNAPSHOTS_REPOSITORY controls the repository fallback where applicable; specifying repositoryName explicitly avoids ambiguity.