Skip to content
2 changes: 1 addition & 1 deletion docs/background/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ nav:
- "CCMP vs. OpenStack API": gui-vs-api.md
- "Deleting projects": project-deletion.md
- "Object storage": object-storage.md
- "Disaster recovery": disaster-recovery.md
- "Recovery service": recovery-service.md
- kubernetes
- Marketplace: marketplace.md
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 0 additions & 41 deletions docs/background/disaster-recovery.md

This file was deleted.

58 changes: 58 additions & 0 deletions docs/background/recovery-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
description: What is the recovery service feature and why you want it
---
# Recovery service

When you [create a new server](../howto/openstack/nova/new-server.md) in {{brand}} you will notice an option named **Recovery service**, which is enabled by default.

![Recovery service is enabled by default for new servers](assets/disaster-recovery-option-on-by-default.png)

Even if you choose to disable it for a particular server, keep in mind that you have the option to enable it at a later time.

![The recovery service feature can be manually activated for any server](assets/disaster-recovery-option-manual-activation.png)

In the following, we explain what this option does, how it works in the background, and why you should consider enabling it.

## What it is

The *recovery service* feature is available via the {{gui}} and applies to servers and volumes that use our [Ceph](https://docs.ceph.com/) backend.
That would be **all** servers but the ones of the `s` [flavor](../reference/flavors/index.md#compute-tiers).

## How it works

As soon as you enable the recovery service for a server or a single volume, you start getting snapshots for the corresponding [*RADOS Block Device* (RBD)](https://docs.ceph.com/en/latest/glossary/#term-Ceph-Block-Device) image.

Those snapshots are created automatically once per day.
By default, you have the snapshots of the last 10 days.
Optionally, you may choose to keep snapshots for the past 30 days.
The cost of a 30-day snapshot retention is 2× (**not** 3×) the cost of a 10-day snapshot retention.

You can also make the snapshots immutable.
In that case, you will not be able to delete snapshots during the retention period manually.

Keep in mind that you cannot delete a volume with snapshots.
So, as an example, if you have chosen a retention period of 30 days and also enabled immutability, then you will not be able to delete the volume before 30 days have passed.

At any time, you may disable the recovery service, modify the retention period, or disable immutability for snapshots.

![Recovery service, retention period, and immutability controls](assets/recovery-service-controls.png)

Let's say, for instance, that you have enabled the recovery service and also the immutability feature for snapshots.
At some point, you want to change the retention period or disable immutability altogether;
you can do any of that.
Later on, you decide you do not need the volume anymore;
you disable the recovery service, wait for 10 or 30 days, and then delete the volume.

## Why enable it

Provided snapshots are available, you can restore a server or a single volume to any of those snapshots.
For instance, you may discover that due to faulty application logic or simply a bug, you are now experiencing data corruption.
Then, one of your options would be to [go back in time](../howto/openstack/nova/restore-srv-to-snap.md) by restoring one of the available snapshots and keep going from there.

## Restoration time

You should know that the recovery service feature creates *point-in-time* snapshots on the storage level.
The time required to restore a server to a particular snapshot depends on its size.
During restoration, the server is shut off.
After the restore, you need to power the server back on manually.
Although this whole process takes time analogous to volume size, as we pointed out, we should also note that it only takes seconds to complete on average.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-09.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/openstack/nova/assets/new-server/shot-16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
4 changes: 2 additions & 2 deletions docs/howto/openstack/nova/boot-image-volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,9 @@ In the following, we show how to perform the conversion using the {{gui}} or the

![Choosing a flavor](assets/bfi-to-bfv/shot12.png)

Consider leaving the [*Disaster recovery*](../../../background/disaster-recovery.md) option enabled, and see if you want an external IP address for the server.
Consider leaving the [*Recovery service*](../../../background/recovery-service.md) option enabled, and see if you want an external IP address for the server.

![Enabling disaster recovery and asking for external IP](assets/bfi-to-bfv/shot13.png)
![Enabling the recovery service and asking for external IP](assets/bfi-to-bfv/shot13.png)

Select the *default* security group and choose a *keypair* for the server.

Expand Down
48 changes: 28 additions & 20 deletions docs/howto/openstack/nova/new-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: How to create a new virtual server in Cleura Cloud

Once you have an [account in
{{brand}}](../../getting-started/create-account.md), you can create virtual machines --- henceforth simply _servers_ --- using either the {{gui}} or the OpenStack CLI.
Let us demonstrate the creation of a new server, following both approaches.

## Prerequisites

Expand All @@ -25,7 +24,7 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f

Notice all these rounded boxes on that pane, each for defining, configuring, and instantiating a different {{brand}} object.
Go ahead and click the _Server_ box.

Another pane, titled _Create a Server_, slides over.
At the top, type in a name for the new server and select one of the available regions.

Expand All @@ -39,11 +38,11 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
If that network is dual-stack or has one IPv4-based subnet, you may want the server to be publicly accessible via an IPv4 address.
In that case, make sure to activate the _Connect a floating IP to the server_ switch.
Then, use the dropdown menu below to set the _Create External IP on_ parameter to the network you have already attached the server to.

Now, pay attention to the _Server profile_ parameter.

![Select server profile](assets/new-server/shot-04.png)

From the corresponding dropdown menu, you must select a profile.
Currently, the following profiles are available:

Expand All @@ -57,13 +56,13 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f

* the _Generic_ profile is for general-purpose cloud servers,
* the _High CPU_ profile is for servers designed to host CPU-intensive applications, and
* the _Low Latency Disk_ profile is for servers that use a local low-latency disk.
* the _Low Latency Disk_ profile is for servers created over a local low-latency disk.

We should point out that some profiles may not be available in all regions.
Choose the _Generic_ profile for now, which is available in any of the regions.

In the _Boot source_ section below, click the dropdown menu on the left and make sure you select _Image_, so you can choose one of the readily available OS images to boot the new server off of.

![Select boot source and image](assets/new-server/shot-05.png)

To pick a specific image, click on the dropdown menu on the right.
Expand All @@ -90,29 +89,37 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
You may leave the root device size unchanged, or modify it to be a bit higher than the default.

When, at a later time, you decide to delete the server, you can do so but **keep** its boot volume (you may want, for example, to attach that volume to a new server).
Just disable the _Delete on termination_ option if you want this kind of flexibility.
Disable the _Delete on termination_ option if you want this kind of flexibility.
On the other hand, if you want your root volume to be automatically deleted when the server is deleted, the _Delete on termination_ option is already enabled for you.
In any case, use this option with caution.

![Boot target, volume, and volume size](assets/new-server/shot-07.png)

Also, notice the _Storage classes (types)_ parameter, which actually deals with [volume types](../../../reference/volumes/index.md).
By default, this parameter is set to _cbs_.

You may want to leave the _Disaster recovery_ option enabled.
Next, you may choose to leave the _Recovery service_ option enabled.
If you do, then daily server snapshots will be created, and you will have the option for easy and fast roll-ups to previous snapshots.
Please be aware that leaving this option enabled increases the server's monthly estimated cost (again, it is displayed in the green rectangular area at the top).

![Disaster recovery option](assets/new-server/shot-08.png)
Take note of the _Retention Days_ parameter, which by default is set to 10 days;
that means that each snapshot will be kept for 10 days, and only then deleted automatically.

You also have the option to enable the _Immutable_ switch.
By doing so, you will not be able to manually delete snapshots before the retention period is over.
Also, you will not be able to delete the server volume until all immutable snapshots are deleted.

Please be aware that enabling the recovery service increases the server's monthly estimated cost (again, it is displayed in the green rectangular area at the top).

![Recovery service option](assets/new-server/shot-08.png)

To control network access to the server, use the dropdown menu to the right of [_Security Groups_](../neutron/create-security-groups.md) and choose one.

![Choose a security group](assets/new-server/shot-09.png)

If you already have one or more key pairs in your {{brand}} account, you can now select a public key to be included in the `~/.ssh/authorized_keys` file of the server's default user.
(For the image you have selected, that user would be `ubuntu`.)
(For the image you have selected, that would be the `ubuntu` user.)
That way, you can securely log into the remote user's account via SSH without typing a password.

![Indicate an existing keypair](assets/new-server/shot-10.png)

In case there are no key pairs to choose from, activate the _Set password_ option and set a password for the default user account (`ubuntu`).
Expand All @@ -122,12 +129,13 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
A configuration script is automatically prepared based on the choices you have already made.
That script runs during system boot and performs housekeeping tasks like user account creation, enabling acceptable authentication methods, and configuring remote package repositories.
Click on _Advanced Options_ to see the default script.
Also, optionally enable the _Upgrade packages_ option, so any available package upgrades are applied during system boot.

![Default server configuration script and user data propagation method](assets/new-server/shot-12.png)

Regarding the _User-data propagation method_ above, notice that the _Use metadata service_ is pre-selected for you.
For more on what this is and why you might want to select the _Use configuration drive_ method, please read our guide on [launching a server with a configuration drive](config-drive.md).

It is now time to create your {{brand}} server.
Click the green _Create_ button, and the new server will be readily available in a few seconds.

Expand Down Expand Up @@ -314,7 +322,7 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
## Viewing information about the newly created server
=== "{{gui}}"
At any time, from the {{gui}} you may see all servers, and get detailed information regarding each one of them.
Expand the left-hand side vertical pane, click _Compute_, then _Servers_, and, in the central pane, select the region you want.
Expand the left-hand side vertical pane, click _Compute_, then _Servers_, and, in the central pane, select the region and the server you want.

![View server details](assets/new-server/shot-14.png)
=== "OpenStack CLI"
Expand All @@ -333,7 +341,7 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
=== "{{gui}}"
While viewing information regarding your server, you may get its IPv6 or public IPv4 address (e.g., from the _Addresses_ tab), and connect to it remotely via SSH.
Alternatively, you may launch a web console and log in.
Click on the three-dot icon on the right of the server header, and from the pop-up menu that appears, select _Remote Console_.
Click the orange :material-dots-horizontal-circle: icon on the right of the server row, and from the pop-up menu that appears, select _Remote Console_.

![Launch remote console](assets/new-server/shot-15.png)

Expand All @@ -348,5 +356,5 @@ On the other hand, if you prefer to work with the OpenStack CLI, please do not f
openstack console url show zug
```

Usage of the web console is discouraged, though.
Instead, securely connect to your server via SSH.
Usage of the web console is discouraged, though.
Instead, securely connect to your server via SSH.
Loading
Loading