Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 125 additions & 17 deletions pages/public_cloud/compute/save_an_instance/guide.en-asia.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
title: Backing up an instance
excerpt: Find out how to back up a Public Cloud instance in the OVHcloud Control Panel
updated: 2025-04-28
updated: 2025-10-14
---

<style>
details>summary {
color:rgb(33, 153, 232) !important;
cursor: pointer;
}
details>summary::before {
content:'\25B6';
padding-right:1ch;
}
details[open]>summary::before {
content:'\25BC';
}
</style>

## Objective

You can create a single backup of an instance or configure a schedule in order to automate your instance backups. Backups can be used to restore your instance to a previous state or to create a new, identical instance.
Expand All @@ -14,6 +28,7 @@ You can create a single backup of an instance or configure a schedule in order t

- A [Public Cloud instance](/links/public-cloud/public-cloud) in your OVHcloud account
- Access to the [OVHcloud Control Panel](/links/manager)
- OpenStack CLI. Use [our guide to know how to prepare the environment to use the OpenStack API](/pages/public_cloud/public_cloud_cross_functional/prepare_the_environment_for_using_the_openstack_api). (optional)

## Instructions

Expand All @@ -23,26 +38,119 @@ You can create a single backup of an instance or configure a schedule in order t
> This option is only available through a **Cold Snapshot** for Metal instances. During this process, the Metal instance will be switched to rescue-mode, and once the backup is performed, the instance will reboot back to normal mode.
>

Log in to the [OVHcloud Control Panel](/links/manager), go to the `Public Cloud`{.action} section and select the Public Cloud project concerned. Then click on `Instances`{.action} in the left-hand menu.

Click on the `...`{.action} button to the right of the instance and select `Create a backup`{.action}.

![public-cloud-instance-backup](images/createbackup1.png){.thumbnail}

Enter a name for the backup on the next page. Take note of the pricing information and click on `Confirm`{.action}.

![public-cloud-instance-backup](images/createbackup2.png){.thumbnail}

It is not possible to track the progress of the backup in real time, however, in the `Instance Backup`{.action} section under **Compute** in the left-hand menu, the status will be displayed as "Backup in progress" during the process.

![public-cloud-instance-backup](images/backup_in_progress.png){.thumbnail}

Once the backup is complete, it will be available in the `Instance Backup`{.action} section under **Compute** in the left-hand menu.
> [!primary]
>
> Two types of backup are available:
>
> - Local: A local backup is stored in the same region as your instance.
> - Distant: A distant backup automatically creates a copy of the local backup in a different region of your choice.
>
> Each backup is billed separately — the distant backup will be charged based on the storage pricing of the selected remote region.
>
> Currently, creating a distant backup is not available through the OVHcloud Control Panel. You can only perform this action via the OVHcloud API or OpenStack.
>

![public-cloud-instance-backup](images/createbackup3.png){.thumbnail}
> [!tabs]
> Via the OVHcloud Control Panel
>>
>> Log in to [OVHcloud customer area](/links/manager), access the `Public Cloud`{.action} section and select the relevant Public Cloud project. Then click on `Instances`{.action} in the left-hand menu.
>>
>> Click on the `...`{.action} button to the right of the instance and select `Create backup`{.action}.
>>
>> ![public-cloud-instance-backup](images/createbackup1.png){.thumbnail}
>>
>> /// details | Local backup
>>
>> Enter a name for the backup. Review the pricing information and click `Confirm`{.action}.
>>
>> ![public-cloud-instance-backup](images/createbackup2bis.png){.thumbnail}
>>
>> ///
>>
>> It is not possible to monitor backup progress in real time. However, in the `Instance Backup`{.action} section under **Compute** in the left-hand menu, the status `Backup in progress` will be displayed during the process.
>>
>> ![public-cloud-instance-backup](images/backup_in_progress.png){.thumbnail}
>>
>> Once the backup is complete, it will be available in the `Instance Backup`{.action} section under **Compute** in the left-hand menu.
>>
>> ![public-cloud-instance-backup](images/createbackup3.png){.thumbnail}
>>
> Via the OVHcloud API <a name="createinstanceviaapi"></a>
>>
>> Log in to the [OVHcloud API](/links/console) and use the following API call:
>>
>> > [!api]
>> >
>> > @api {v1} /cloud POST /cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/snapshot
>> >
>>
>> Fill in the variables:
>>
>> - **instanceId**: The unique instance ID.
>> - **regionName**: The region name where the source instance is located.
>> - **serviceName**: The OVHcloud project ID.
>> - **distantRegionName (optional)**: The remote region name where the distant backup will be stored.
>> - **distantSnapshotName (optional)**: The name of the distant backup to create in the remote region.
>> - **snapshotName**: The name of the snapshot (local backup) to create.
>>
>> > [!primary]
>> >
>> > Only create a distant backup if the parameters related to the remote region (**distantRegionName** and **distantSnapshotName**) are provided.
>> >
>>
> Via OpenStack
>>
>> Run the following command to display the list of instances:
>>
>> ```bash
>> $ openstack server list
>>
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> | ID | Name | Status | Networks | Image Name |
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> | aa7115b3-83df-4375-b2ee-19339041dcfa | Server 1 | ACTIVE | Ext-Net=51.xxx.xxx.xxx, 2001:41d0:xxx:xxxx::xxxx | Ubuntu 16.04 |
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> ```
>>
>> /// details | Local backup
>>
>> Then run the following command to create a backup of your instance:
>>
>> ```bash
>> $ openstack server image create --name snap_server1 aa7115b3-83df-4375-b2ee-19339041dcfa
>> ```
>>
>> ///
>>
>> /// details | Remote backup
>>
>> Run the following command after following the local backup step:
>>
>> ```bash
>> $ openstack workflow execution create ovh. glance.glance_download '{"src_image_id":"<image_id>", "src_region":"<current_region>", "dst_region":"<remote_region>"}'
>> ```
>>
>> ///
>>
> Via Horizon
>>
>> Click on the `Compute`{.action} menu on the left, then select `Instances`{.action}.<br>
>> Then click on the `Create Snapshot`{.action} button to the right of the instance line.
>>
>> ![public-cloud-instance-backup-horizon1](images/createbackuphorizon1.png){.thumbnail}
>>
>> Fill in the backup name and press the `Create Snapshot`{.action} button.
>>
>> ![public-cloud-instance-backup-horizon2](images/createbackuphorizon2.png){.thumbnail}
>>

### Creating an automated backup of an instance

> [!primary]
>
> If you want to automate this functionality directly via OpenStack, you can create a Mistral workflow associated with a cron trigger.
>

Click on the `...`{.action} button to the right of the instance and select `Create an automatic backup`{.action}.

![public-cloud-instance-backup](images/createbackup4.png){.thumbnail}
Expand Down
142 changes: 125 additions & 17 deletions pages/public_cloud/compute/save_an_instance/guide.en-au.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
title: Backing up an instance
excerpt: Find out how to back up a Public Cloud instance in the OVHcloud Control Panel
updated: 2025-04-28
updated: 2025-10-14
---

<style>
details>summary {
color:rgb(33, 153, 232) !important;
cursor: pointer;
}
details>summary::before {
content:'\25B6';
padding-right:1ch;
}
details[open]>summary::before {
content:'\25BC';
}
</style>

## Objective

You can create a single backup of an instance or configure a schedule in order to automate your instance backups. Backups can be used to restore your instance to a previous state or to create a new, identical instance.
Expand All @@ -14,6 +28,7 @@ You can create a single backup of an instance or configure a schedule in order t

- A [Public Cloud instance](/links/public-cloud/public-cloud) in your OVHcloud account
- Access to the [OVHcloud Control Panel](/links/manager)
- OpenStack CLI. Use [our guide to know how to prepare the environment to use the OpenStack API](/pages/public_cloud/public_cloud_cross_functional/prepare_the_environment_for_using_the_openstack_api). (optional)

## Instructions

Expand All @@ -23,26 +38,119 @@ You can create a single backup of an instance or configure a schedule in order t
> This option is only available through a **Cold Snapshot** for Metal instances. During this process, the Metal instance will be switched to rescue-mode, and once the backup is performed, the instance will reboot back to normal mode.
>

Log in to the [OVHcloud Control Panel](/links/manager), go to the `Public Cloud`{.action} section and select the Public Cloud project concerned. Then click on `Instances`{.action} in the left-hand menu.

Click on the `...`{.action} button to the right of the instance and select `Create a backup`{.action}.

![public-cloud-instance-backup](images/createbackup1.png){.thumbnail}

Enter a name for the backup on the next page. Take note of the pricing information and click on `Confirm`{.action}.

![public-cloud-instance-backup](images/createbackup2.png){.thumbnail}

It is not possible to track the progress of the backup in real time, however, in the `Instance Backup`{.action} section under **Compute** in the left-hand menu, the status will be displayed as "Backup in progress" during the process.

![public-cloud-instance-backup](images/backup_in_progress.png){.thumbnail}

Once the backup is complete, it will be available in the `Instance Backup`{.action} section under **Compute** in the left-hand menu.
> [!primary]
>
> Two types of backup are available:
>
> - Local: A local backup is stored in the same region as your instance.
> - Distant: A distant backup automatically creates a copy of the local backup in a different region of your choice.
>
> Each backup is billed separately — the distant backup will be charged based on the storage pricing of the selected remote region.
>
> Currently, creating a distant backup is not available through the OVHcloud Control Panel. You can only perform this action via the OVHcloud API or OpenStack.
>

![public-cloud-instance-backup](images/createbackup3.png){.thumbnail}
> [!tabs]
> Via the OVHcloud Control Panel
>>
>> Log in to [OVHcloud customer area](/links/manager), access the `Public Cloud`{.action} section and select the relevant Public Cloud project. Then click on `Instances`{.action} in the left-hand menu.
>>
>> Click on the `...`{.action} button to the right of the instance and select `Create backup`{.action}.
>>
>> ![public-cloud-instance-backup](images/createbackup1.png){.thumbnail}
>>
>> /// details | Local backup
>>
>> Enter a name for the backup. Review the pricing information and click `Confirm`{.action}.
>>
>> ![public-cloud-instance-backup](images/createbackup2bis.png){.thumbnail}
>>
>> ///
>>
>> It is not possible to monitor backup progress in real time. However, in the `Instance Backup`{.action} section under **Compute** in the left-hand menu, the status `Backup in progress` will be displayed during the process.
>>
>> ![public-cloud-instance-backup](images/backup_in_progress.png){.thumbnail}
>>
>> Once the backup is complete, it will be available in the `Instance Backup`{.action} section under **Compute** in the left-hand menu.
>>
>> ![public-cloud-instance-backup](images/createbackup3.png){.thumbnail}
>>
> Via the OVHcloud API <a name="createinstanceviaapi"></a>
>>
>> Log in to the [OVHcloud API](/links/console) and use the following API call:
>>
>> > [!api]
>> >
>> > @api {v1} /cloud POST /cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/snapshot
>> >
>>
>> Fill in the variables:
>>
>> - **instanceId**: The unique instance ID.
>> - **regionName**: The region name where the source instance is located.
>> - **serviceName**: The OVHcloud project ID.
>> - **distantRegionName (optional)**: The remote region name where the distant backup will be stored.
>> - **distantSnapshotName (optional)**: The name of the distant backup to create in the remote region.
>> - **snapshotName**: The name of the snapshot (local backup) to create.
>>
>> > [!primary]
>> >
>> > Only create a distant backup if the parameters related to the remote region (**distantRegionName** and **distantSnapshotName**) are provided.
>> >
>>
> Via OpenStack
>>
>> Run the following command to display the list of instances:
>>
>> ```bash
>> $ openstack server list
>>
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> | ID | Name | Status | Networks | Image Name |
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> | aa7115b3-83df-4375-b2ee-19339041dcfa | Server 1 | ACTIVE | Ext-Net=51.xxx.xxx.xxx, 2001:41d0:xxx:xxxx::xxxx | Ubuntu 16.04 |
>> +--------------------------------------+-----------+--------+--------------------------------------------------+--------------+
>> ```
>>
>> /// details | Local backup
>>
>> Then run the following command to create a backup of your instance:
>>
>> ```bash
>> $ openstack server image create --name snap_server1 aa7115b3-83df-4375-b2ee-19339041dcfa
>> ```
>>
>> ///
>>
>> /// details | Remote backup
>>
>> Run the following command after following the local backup step:
>>
>> ```bash
>> $ openstack workflow execution create ovh. glance.glance_download '{"src_image_id":"<image_id>", "src_region":"<current_region>", "dst_region":"<remote_region>"}'
>> ```
>>
>> ///
>>
> Via Horizon
>>
>> Click on the `Compute`{.action} menu on the left, then select `Instances`{.action}.<br>
>> Then click on the `Create Snapshot`{.action} button to the right of the instance line.
>>
>> ![public-cloud-instance-backup-horizon1](images/createbackuphorizon1.png){.thumbnail}
>>
>> Fill in the backup name and press the `Create Snapshot`{.action} button.
>>
>> ![public-cloud-instance-backup-horizon2](images/createbackuphorizon2.png){.thumbnail}
>>

### Creating an automated backup of an instance

> [!primary]
>
> If you want to automate this functionality directly via OpenStack, you can create a Mistral workflow associated with a cron trigger.
>

Click on the `...`{.action} button to the right of the instance and select `Create an automatic backup`{.action}.

![public-cloud-instance-backup](images/createbackup4.png){.thumbnail}
Expand Down
Loading