Stay organized with collections
Save and categorize content based on your preferences.
This page contains instructions for how to restore a Harbor instance backup in
Google Distributed Cloud (GDC) air-gapped.
Restores require an existing backup to function. The restore uses the specified
backup data for the restoration.
A restore only supports restoring a Harbor instance that has the same reference as
the backup. The original Harbor instance must be deleted before
restoration starts.
Before you begin
To create a restore, you must have access to the following:
The necessary identity and access roles:
Harbor Instance Admin: has full access to manage Harbor instances in a project. Ask your Organization IAM Admin to grant you the Harbor Instance Admin (harbor-instance-admin) role.
Secret Admin: required for operating in the GDC console. Ask your Organization IAM Admin to grant you the Secret Admin (secret-admin) role.
An existing backup. You create backups from the following sources:
GDC creates backups automatically as defined in the backup plan
schedule. For more information, see
Create a backup plan.
INSTANCE_NAMESPACE: the namespace containing
the Harbor instance. The backup plan containing the backup to restore must be in the same namespace with the Harbor instance to restore.
BACKUP_NAME: the name of the backup that the system restores.
RESTORE_DESCRIPTION: a text description of the
restore being created.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThis guide explains how to restore a Harbor instance backup in Google Distributed Cloud (GDC) air-gapped environments, requiring an existing backup to function.\u003c/p\u003e\n"],["\u003cp\u003eRestoration is only possible for a Harbor instance that matches the backup's reference, and the original instance must be deleted before starting the restore process.\u003c/p\u003e\n"],["\u003cp\u003eYou need the Harbor Instance Admin and Secret Admin roles to create a restore, which can be granted by your Organization IAM Admin.\u003c/p\u003e\n"],["\u003cp\u003eBackups can be created automatically via a defined backup plan schedule or manually, both of which are prerequisites to restoring.\u003c/p\u003e\n"],["\u003cp\u003eRestores can be initiated through the GDC console by selecting a backup and clicking "Restore a backup" or via the API by specifying the restore name, namespace, backup name, and a description.\u003c/p\u003e\n"]]],[],null,["# Create a restore\n\nThis page contains instructions for how to restore a Harbor instance backup in\nGoogle Distributed Cloud (GDC) air-gapped.\n\nRestores require an existing backup to function. The restore uses the specified\nbackup data for the restoration.\nA restore only supports restoring a Harbor instance that has the same reference as\nthe backup. The original Harbor instance must be deleted before\nrestoration starts.\n\nBefore you begin\n----------------\n\nTo create a restore, you must have access to the following:\n\n- The necessary identity and access roles:\n\n - Harbor Instance Admin: has full access to manage Harbor instances in a project. Ask your Organization IAM Admin to grant you the Harbor Instance Admin (`harbor-instance-admin`) role.\n - Secret Admin: required for operating in the GDC console. Ask your Organization IAM Admin to grant you the Secret Admin (`secret-admin`) role.\n- An existing backup. You create backups from the following sources:\n\n - GDC creates backups automatically as defined in the backup plan schedule. For more information, see [Create a backup plan](/distributed-cloud/hosted/docs/latest/gdch/platform-application/pa-ao-operations/harbor-backup/create-backup-plan-harbor).\n - You create manual backups. For more information, see [Create a manual backup](/distributed-cloud/hosted/docs/latest/gdch/platform-application/pa-ao-operations/harbor-backup/create-manual-backup-harbor).\n\nCreate a restore\n----------------\n\nCreate a restore in the GDC console or the API. \n\n### Console\n\n1. Sign in to the GDC console.\n2. In the navigation menu, click **Backup for harbor instance**.\n3. Click **Backups**.\n4. Click the name of the backup you want to restore.\n5. Click refresh**Restore a backup**\n\n### API\n\n apiVersion: artifactregistry.gdc.goog/v1\n kind: HarborInstanceRestore\n metadata:\n name: \u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-l devsite-syntax-l-Scalar devsite-syntax-l-Scalar-Plain\"\u003eRESTORE_NAME\u003c/span\u003e\u003c/var\u003e\n namespace: \u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-l devsite-syntax-l-Scalar devsite-syntax-l-Scalar-Plain\"\u003eINSTANCE_NAMESPACE\u003c/span\u003e\u003c/var\u003e\n spec:\n backupName: \u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-l devsite-syntax-l-Scalar devsite-syntax-l-Scalar-Plain\"\u003eBACKUP_NAME\u003c/span\u003e\u003c/var\u003e\n description: \u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-l devsite-syntax-l-Scalar devsite-syntax-l-Scalar-Plain\"\u003eRESTORE_DESCRIPTION\u003c/span\u003e\u003c/var\u003e\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003eRESTORE_NAME\u003c/var\u003e: the name of the restore.\n- \u003cvar translate=\"no\"\u003eINSTANCE_NAMESPACE\u003c/var\u003e: the namespace containing the Harbor instance. The backup plan containing the backup to restore must be in the same namespace with the Harbor instance to restore.\n- \u003cvar translate=\"no\"\u003eBACKUP_NAME\u003c/var\u003e: the name of the backup that the system restores.\n- \u003cvar translate=\"no\"\u003eRESTORE_DESCRIPTION\u003c/var\u003e: a text description of the restore being created."]]