Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Connecting a Yandex BareMetal server to Yandex Cloud Backup

Written by
Updated at December 19, 2024

Note

BareMetal is at the Preview stage.

In Cloud Backup, you can configure BareMetal server backup.

For more information on managing servers, see Step-by-step guides for Yandex BareMetal.

The following server operating systems are supported:

  • Debian 10.
  • Debian 11.
  • Ubuntu 16.04 LTS.
  • Ubuntu 18.04 LTS.
  • Ubuntu 20.04 LTS.
  • Ubuntu 22.04 LTS.

To connect a server to Cloud Backup:

  1. Prepare your cloud.
  2. Create a service account.
  3. Activate Cloud Backup.
  4. Lease a test server.
  5. Connect to the server.
  6. Install a backup agent.
  7. Run the backup process.
  8. Restore your server from backup.

See also How to cancel a lease and delete resources.

Prepare your cloud

Sign up for Yandex Cloud and create a billing account:

  1. Go to the management console and log in to Yandex Cloud or create an account if you do not have one yet.
  2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one.

If you have an active billing account, you can go to the cloud page to create or select a folder for your infrastructure to operate in.

Learn more about clouds and folders.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Currently, BareMetal and the server backup feature are offered at no charge.

Create a service account

  1. In the management console, select the folder you want to lease a BareMetal server in.

  2. In the list of services, select Identity and Access Management.

  3. Click Create service account.

  4. Enter a name for the service account. The name format requirements are as follows:

    • The name must be from 3 to 63 characters long.
    • It may contain lowercase Latin letters, numbers, and hyphens.
    • The first character must be a letter and the last character cannot be a hyphen.

  5. Click Add role and select the backup.editor role.

  6. Click Create.

  7. To select the service account you created earlier, click the row with its name.

  8. In the top panel, click Create new key.

  9. Select Create authorized key.

  10. Select an encryption algorithm and click Create.

  11. In the window that opens, click Download file with keys and then click Close.

You will need the authorized key of the service account in the later steps.

Activate Cloud Backup

To activate Cloud Backup, you need at least the backup.editor role for the folder where you want to lease a server and connect it to Cloud Backup.

  1. In the management console, select the folder where you want to lease a server and connect it to Cloud Backup.

  2. In the list of services, select Cloud Backup.

  3. If you have not activated Cloud Backup yet, click Activate.

    If there is no Activate button, Cloud Backup is already activated. Proceed to the next step.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

  1. View the description of the CLI command to activate the service:

    yc backup provider activate --help

  2. Activate the service in the default folder:

    yc backup provider activate --async

    Where --async displays the operation progress info. This is an optional parameter.

    Result:

    id: cdgmnefxiatx********
description: activate provider
created_at: "2024-10-14T09:03:47.960564Z"
created_by: ajec1gaqcmtr********
modified_at: "2024-10-14T09:03:47.960564Z"
done: true
metadata:
  '@type': type.googleapis.com/yandex.cloud.backup.v1.ActivateProviderMetadata
  folder_id: b1go3el0d8fs********
response:
  '@type': type.googleapis.com/google.protobuf.Empty
  value: {}

After activation, the system automatically creates the following backup policies:

  • Default daily: Daily incremental backup with the last 15 backups retained.
  • Default weekly: Weekly incremental backup with the last 15 backups retained.
  • Default monthly: Monthly incremental backup with the last 15 backups retained.

If you prefer not to create them, use the --skip-default-policy parameter.

After activation, the system automatically creates the following backup policies:

  • Default daily: Daily incremental backup with the last 15 backups retained.
  • Default weekly: Weekly incremental backup with the last 15 backups retained.
  • Default monthly: Monthly incremental backup with the last 15 backups retained.

Lease a test server

If you are already leasing a server with an appropriate OS, go to Connect to the server. Make sure to check the network permissions you need to configure on the server.

  1. In the management console, select the folder you want to lease a server in.

  2. In the list of services, select BareMetal.

  3. Click Lease server.

  4. Select the ru-central1-m availability zone.

  5. Select the ru-central1-m3 pool.

  6. Under Configuration:

    1. Select the server configuration, e.g., BA-i203-S-10G.

    2. Configure disk partitioning:

      1. Click Configure disk layout.
      2. Keep the default partitioning and click Save.

      Note

      The disk partitioning parameters are vital to have your server restored from a backup later on. Learn more in Restore your server from backup.

  7. Under Image, select the Ubuntu 22.04 LTS image.

  8. Under Lease conditions, specify:

    1. Number of servers: 1.
    2. Lease duration: 1 month.

  9. Under Network settings:

    1. Click Create a private subnet.

    2. Optionally, if you need to enable DHCP for automatic IP address assignment, do so in the Routing settings section.

    3. Enter bm-subnetwork for the subnet name and click Create subnet.

    4. In the Public address field, select Automatically.

      For the Cloud Backup agent to exchange data with the backup provider servers, make sure the server has network access to the IP addresses of Cloud Backup resources based on the following table:

      Port range Protocol Destination name CIDR blocks
      80 TCP CIDR 213.180.193.0/24
      80 TCP CIDR 213.180.204.0/24
      443 TCP CIDR 84.47.172.0/24
      443 TCP CIDR 84.201.181.0/24
      443 TCP CIDR 178.176.128.0/24
      443 TCP CIDR 213.180.193.0/24
      443 TCP CIDR 213.180.204.0/24
      7770-7800 TCP CIDR 84.47.172.0/24
      8443 TCP CIDR 84.47.172.0/24
      44445 TCP CIDR 51.250.1.0/24

  10. Under Access:

    1. Generate a password for the root user. To do this, click Password next to the Generate field.

    Warning

    Once you have ordered your server, you will no longer be able to view the password. Save the password to a secure location right away.

    1. In the Public SSH key field, paste the contents of the public key file. You need to create an SSH key pair yourself.

  11. Under Server information, enter the server Name: bm-server.

  12. Click Lease server.

Save the server name and ID for use in the later steps.

For more information on leasing a server, see the BareMetal documentation.

Connect to the server

  1. In the management console, select the folder the server belongs to.
  2. In the list of services, select BareMetal.
  3. In the row with the server you need, click and select Start KVM console.
  4. In the window that opens, click KVM console.

To establish a server connection, specify its public IP address which can be found in the management console, in the Public address field under Network settings on the server page.

  1. In the terminal, run this command:

    ssh root@<server_public_IP_address>

    If this is your first time connecting to the server, you will get an unknown host warning:

    The authenticity of host '51.250.83.243 (51.250.83.243)' can't be established.
ED25519 key fingerprint is SHA256:6Mjv93NJDCaf/vu3NYwiLQK4tKI+4cfLtkd********.
This key is not known by any other names.
Are you sure you want to continue connecting (yes/no/[fingerprint])?

  2. Type yes in the terminal and press Enter.

  3. Enter the password you specified when creating the server and press Enter.

To establish a server connection, specify its public IP address which can be found in the management console, in the Public address field under Network settings on the server page.

Make sure the Windows account has read permissions for the folder containing the keys.

  1. To connect to the server, run the following command in the command line:

    ssh root@<server_public_IP_address>

    If this is your first time connecting to the server, you will get an unknown host warning:

    The authenticity of host '89.169.132.223 (89.169.132.223)' can't be established.
ECDSA key fingerprint is SHA256:DfjfFB+in0q0MGi0HnqLNMdHssLfm1yRanB********.
Are you sure you want to continue connecting (yes/no/[fingerprint])?

  2. Type yes in the terminal and press Enter.

  3. Enter the password you specified when creating the server and press Enter.

Install a backup agent

  1. Copy the file with the service account authorized key you created earlier to the server. To do this, run this command on the local machine:

    scp <path_to_authorized_key_file_on_local_machine> \
root@<server_public_IP_address>:<absolute_path_to_folder_on_server>

  2. Install the Yandex Cloud CLI. To do this, run this command on the server:

    curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash

  3. Authenticate in the Yandex Cloud CLI as a service account:

    yc config set service-account-key <absolute_path_to_authorized_key>

  4. Get an IAM token:

    yc iam create-token

  5. Install the jq utility:

    apt update && apt install -y jq

  6. Install the backup agent:

    wget https://storage.yandexcloud.net/backup-distributions/agent_installer_bms.sh && \
sudo bash ./agent_installer_bms.sh \
  -t=<IAM_token> \
  -p=<backup_policy_ID>

    Where:

    • -t: Service account IAM token you got earlier. This is a required parameter.
    • -p: ID of the backup policy you need to link to the server. Multiple IDs should be comma-separated. This is an optional parameter.

    Wait for the message informing you the agent is registered:

    ...
Agent registered with id D9CA44FC-716A-4B3B-A702-C6**********

Run the backup process

To start creating a backup outside of the backup policy schedule, run this command:

yc backup policy execute \
  --id <policy_ID> \
  --instance-id <server_ID>

Wait for the operation to complete.

Also, you can run the command in asynchronous mode using the --async parameter and track the backup process using the yc backup resource list-tasks command.

Restore your server from backup

Note

You cannot restore a VM backup to a BareMetal server, nor restore a BareMetal server backup to a VM.

If you need to restore one server's backup to another, or if the OS had been reinstalled on the source server, reinstall the backup agent on that server.

To avoid errors when recovering from a backup, start by comparing the parameters of the disks and partitions of the backup against those of the VM or Yandex BareMetal server. For more information, see Viewing the parameters of disks and partitions in a backup.

Tip

If the server had used a RAID array, we recommend that you restore the backup to a server with a similar partition configuration. We also recommend that you make the partitions at least as big as on the source server.

  1. Get a list of server backups:

    yc backup backup list \
  --instance-id <server_ID>

    Save the backup ID.

  2. Restore your server from backup:

    yc backup backup recover \
  --source-backup-id="<backup_ID>" \
  --destination-instance-id="<server_ID>"

    Wait for the operation to complete.

    Also, you can run the command in asynchronous mode using the --async parameter and track the backup process using the yc backup resource list-tasks command.

How to cancel a lease and delete resources

  1. Cancel a BareMetal server lease.
  2. Delete the backup in Cloud Backup using the CLI.
Previous
Viewing backup statistics
Next
Overview