Skip to content

Commit 72d8dd3

Browse files
authored
Merge pull request #68 from tobias-urdin/vale-warning
More cleanup after using warning level in Vale
2 parents 001179c + 870aaa8 commit 72d8dd3

File tree

164 files changed

+2476
-2379
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+2476
-2379
lines changed

.github/styles/config/vocabularies/Binero/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ CPUs
2727
GPUs
2828
vCPUs
2929
pCPUs
30+
Gbps
31+
Mbps
3032

3133
# Product, services, companies
3234
AWS|aws

.github/styles/config/vocabularies/OpenStack/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ APIs
66
subnet|Subnet
77
openrc
88
unshelve|Unshelve
9+
Designate

.github/workflows/test.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ jobs:
2727
- name: Install docutils
2828
run: sudo apt-get install -y docutils
2929
- uses: errata-ai/[email protected]
30+
with:
31+
vale_flags: "--glob=!.github/*"

.vale.ini

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
StylesPath = .github/styles
2-
MinAlertLevel = error
2+
MinAlertLevel = warning
33
Packages = RedHat, write-good, alex, proselint
44

55
Vocab = Binero, OpenStack
@@ -13,3 +13,11 @@ RedHat.MergeConflictMarkers = NO
1313

1414
# Disable proselint substition of symbols
1515
proselint.Typography = NO
16+
17+
# Dont be as restrictive of git links
18+
RedHat.GitLinks = NO
19+
20+
# Disable these for now since when iusing warning level these
21+
# warn for index links using slash and being lowercase
22+
RedHat.Slash = NO
23+
RedHat.CaseSensitiveTerms = NO

backup/automatic-backup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Setting up automatic backup
33
===========================
44

5-
To setup an :doc:`automated backup job <index>` using the
5+
To setup an :doc:`automated backup job <index>` by using the
66
:doc:`cloud management portal </getting-started/managing-your-cloud/cloud-management-portal>`
77

88
- Press **Service catalog** and then **Service templates** in the sidebar menu.

backup/index.rst

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,79 @@ Backup
44

55
Using the backup feature in Binero cloud, you are able to backup and restore volumes.
66

7-
Backups will be stored on the object storage of your account in :doc:`availability zone </storage/regions-and-availability-zones>`
8-
**europe-se-1b** using the gp.archive :doc:`storage policy </storage/object-storage/storage-policy>`.
7+
The system stores the backups in the object storage of your account in
8+
:doc:`availability zone </storage/regions-and-availability-zones>` **europe-se-1b**
9+
using the gp.archive :doc:`storage policy </storage/object-storage/storage-policy>`.
910

1011
.. important::
1112

1213
When backing up volumes from availability zone *europe-se-1b*, note that the backups currently
1314
will *also end up in the same availability zone* (and, in part, on the same storage).
1415

1516
If you have data that is not also stored in zone europe-se-1a, we recommend using a different
16-
backup in order to secure your data for a potential storage outage in zone europe-se-1b.
17+
backup to secure your data for a potential storage outage in zone europe-se-1b.
1718

1819
Data integrity
1920
--------------
2021

2122
The backup service in Binero cloud backs up :doc:`volumes </storage/persistent-block-storage/index>`.
2223

23-
When backing up a volume, data will be copied bit-by-bit from the source to the destination over some time (it
24-
takes time to copy large amounts of data).
24+
When backing up a volume the system copies the data bit-by-bit from the source to the destination, it
25+
takes time when copying large amounts of data.
2526

26-
If data is also being written to the source disk during copying, the data on the destination server may get
27-
corrupted. A way to work around this is to shut down the server but since this may not always be an option, taking
28-
some time to consider the potential impact of corrupted data might be advisable.
27+
The system first takes snapshot of the data if it's a volume. If you're writing data to the volume while
28+
taking the snapshot or if you are not using a volume and are writing data while a backup is running the
29+
data might be corrupt before the data is even copied.
2930

30-
For a file server, the risk of corrupted files should be minimal (and in case a file is compromised, the damage is
31-
limited to that file).
31+
It's recommend to not write data while taking a backup and if you can power off your instance during
32+
a backup that makes it more safe, but that's not always an option so you need to consider the impact
33+
if your data in a backup is corrupt.
3234

33-
When backing up a database, however, the entire database might be reliant on a few files and should one of them be
34-
compromised, the database will not start again. In this scenario, the usual solution is to first run a dump of the
35-
database data onto a file on the filesystem. This file would then be safe (as its not written to after the dump) and
36-
in case of a restore, the file could just be read back into the database.
35+
For a file server the risk of corrupted files should be minimal and in case of file damage or data loss
36+
it's limited to that file.
3737

38-
A way to work around this problem (in part) is to first :doc:`snapshot </storage/snapshots/index>` your volume and then
39-
backup the snapshot. That way, new writes will be moved away from the snapshot (which is read-only) and data will be
40-
safer. Bare in mind that a snapshot could also cut writes in half so exporting databases is still advisable.
38+
When backing up a database the entire database might be reliant on a few files and should one of them
39+
become corrupt, the database will not start again. In this scenario, the usual solution is to first run
40+
a dump of the database data onto a file on the filesystem. This file would then be safe (as its not written
41+
to after the dump) and in case of a restore, you can import the data back into the database from the dump.
4142

4243
Shutting of your instance will make the backup entirely safe from above issues.
4344

4445
.. tip::
4546

46-
We strongly recommend doing a restore test of your backups. Since :doc:`restoring <restore-volume>` to a new volume
47-
and creating a new instance that could run parallel to your production workload, this is a good way to ensure data
48-
consistency in your backup.
47+
We strongly recommend doing a restore test of your backups. Since :doc:`restoring <restore-volume>` to a
48+
new volume and creating a new instance that could run parallel to your production workload, this is a good
49+
way to ensure data consistency in your backup.
4950

5051
Setting up backup
5152
-----------------
5253

53-
The Binero cloud backup feature can be used in two main ways, see below.
54+
You can use the Binero cloud backup feature in two main ways, see below.
5455

5556
Manual backup
5657
^^^^^^^^^^^^^
5758

58-
When doing a manual backup, your data would be pushed to the backup storage once upon request. This could be done for
59-
example, before doing a migration or upgrade (although a snapshot might also be a good alternative for this) or if you want
60-
to have a copy of an installed server stored offline in case of the real server for example being deleted - and then backing
61-
up the data separately.
59+
A manual backup is useful before doing a migration, upgrade or when retire an old system but want to
60+
keep a copy of the data.
6261

6362
More information in our :doc:`manual-backup` article.
6463

6564
Automated backup
6665
^^^^^^^^^^^^^^^^
6766

68-
The platform is able to automatically run backup jobs for you. This can be setup via the :doc:`platform automation tool </platform-automation/index>`, however
69-
we strongly recommend using our :doc:`service catalog </service-catalog/schedule-backup>` to simplify creating an automated backup job.
67+
The platform is able to automatically create backups for you. This can be setup via the
68+
:doc:`platform automation tool </platform-automation/index>`, we strongly recommend using
69+
our :doc:`service catalog </service-catalog/schedule-backup>` to enable automated backup.
7070

7171
The platform will not do incremental backups when using the built-in workflow to run backups.
7272

7373
More information in our :doc:`automatic-backup` article.
7474

7575
.. note::
7676

77-
Before creating a backup, please note that you are strongly recommended to also dump any database to disk before running
78-
the job. If the job is ran on a schedule, also dump your database on a schedule inside your instance (and do it before
79-
the backup is created).
77+
Before creating a backup, note that you are strongly recommended to also dump any database to disk. If
78+
the backup is ran on a schedule, also dump your database on a schedule inside your instance before the
79+
system takes the backup.
8080

8181
.. toctree::
8282
:caption: Available services

backup/manual-backup.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,28 @@ You are able to use one of the following methods to take a backup.
1818
Cloud management portal
1919
-----------------------
2020

21-
To create a backup of a volume using the :doc:`/getting-started/managing-your-cloud/cloud-management-portal`
21+
To create a backup of a volume by using the
22+
:doc:`/getting-started/managing-your-cloud/cloud-management-portal`
2223

2324
- Press **Storage** and then **Backups** in the sidebar menu.
2425

25-
- Press the **+** icon in the bottom right corner.
26+
- Press the **+** icon in the lower right corner.
2627

27-
- Select a volume from the dropdown menu. If you are unsure about which volume (due to IDs being used) you
28-
can check the instance to see which volumes are attached to it:
28+
- Select a volume from the dropdown menu. If you are unsure about which volume (ID) you
29+
can check the instance to see which volumes is currently attached to it:
2930

3031
- Press **Compute** and then **Instances**.
3132

3233
- Press the instance you want to backup.
3334

3435
- Press the **Volumes** tab.
3536

36-
- Note the name of the attached volumes (there may be several).
37+
- Note the name of the attached volumes (there might be many).
3738

3839
- Give your backup a name.
3940

40-
- Press **Force** if the volume is attached to an instance or else the backup will
41-
not be allowed and will error.
41+
- Press **Force** if the volume is currently attached to an instance or else the backup
42+
will give an error.
4243

4344
- Optionally, give your backup a description.
4445

@@ -48,19 +49,17 @@ To create a backup of a volume using the :doc:`/getting-started/managing-your-cl
4849

4950
An option for doing incremental backups exists but the platform will not keep track of the full backups.
5051

51-
Our recommendation is therefore that you only do full backups as deleting the full dump would invalidate
52-
the incremental backups that are tied to it.
53-
5452
OpenStack Horizon
5553
-----------------
5654

57-
To create a backup of a volume using :doc:`/getting-started/managing-your-cloud/openstack-horizon`
55+
To create a backup of a volume by using
56+
:doc:`/getting-started/managing-your-cloud/openstack-horizon`
5857

5958
- Under **Project**, click **Volumes** and then **Volumes** in the sidebar menu.
6059

6160
- Click **Create backup** in the dropdown menu to the far right on the row of the volume that you
62-
want to backup. You are able to see which instance the volume is attached to in the **Attached to**
63-
column.
61+
want to backup. You are able to see which instance the volume is currently attached to in the
62+
**Attached to** column.
6463

6564
- Give your backup a name and optionally a description.
6665

@@ -71,10 +70,11 @@ To create a backup of a volume using :doc:`/getting-started/managing-your-cloud/
7170
OpenStack Terminal Client
7271
-------------------------
7372

74-
To create a volume using the :doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
73+
To create a volume by using the
74+
:doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
7575

7676
- Run this command: ``openstack volume list``, save the ID of the volume you want to backup. Its visible
77-
which instance the volumes are attached to in the **Attached to** column.
77+
which instance the volumes is currently attached to in the **Attached to** column.
7878

7979
- Run this command: ``openstack volume backup create --force --name [BACKUP_NAME] [VOLUME_ID]``, replacing
8080
with the name of the backup and the ID from the previous step.

backup/restore-volume.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@ Restore volume from backup
44

55
When restoring from backup, you would restore an entire volume.
66

7-
Restoring single files is not possible but would require an :doc:`instance </compute/index>` be
8-
setup, launched and then the files could be collected from the instance.
7+
Restoring single files is not possible and requires creating a
8+
new :doc:`instance </compute/index>` created you can then collect
9+
the files from the instance.
910

1011
To restore, you would first create a volume, restore to it and then
1112
:doc:`create and instance from the volume </storage/persistent-block-storage/creating-an-instance-from-a-volume>`.
1213

1314
Cloud management portal
1415
-----------------------
1516

16-
To restore a backup to a volume using the :doc:`/getting-started/managing-your-cloud/cloud-management-portal`
17+
To restore a backup to a volume by using the
18+
:doc:`/getting-started/managing-your-cloud/cloud-management-portal`
1719

1820
- Press **Storage** and then **Backups** in the sidebar menu.
1921

@@ -33,12 +35,14 @@ To restore a backup to a volume using the :doc:`/getting-started/managing-your-c
3335
.. note::
3436

3537
While there is an option to create a new volume when restoring a backup, this does not work due to
36-
not taking availability zones into consideration. Therefore you need to first create a volume.
38+
not taking availability zones into consideration, you need to first create a new empty volume that
39+
you can restore to.
3740

3841
OpenStack Horizon
3942
-----------------
4043

41-
To restore a backup of a volume using :doc:`/getting-started/managing-your-cloud/openstack-horizon`
44+
To restore a backup of a volume by using
45+
:doc:`/getting-started/managing-your-cloud/openstack-horizon`
4246

4347
- Under **Project**, click **Volumes** and then **Backups** in the sidebar menu.
4448

@@ -59,21 +63,23 @@ To restore a backup of a volume using :doc:`/getting-started/managing-your-cloud
5963
OpenStack Terminal Client
6064
-------------------------
6165

62-
To restore a volume using the :doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
66+
To restore a volume by using the
67+
:doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
6368

6469
- Run this command: ``openstack volume backup list``, note the size of the backup that you want to
65-
restore as well as the ID.
70+
restore and the backup ID.
6671

67-
- Follow the steps in our :doc:`/storage/persistent-block-storage/create-volume` guide to create an
68-
empty volume of the same size as the backup. Note the ID it gets. Can also be gotten by
69-
running ``openstack volume list``.
72+
- Follow the steps in our :doc:`/storage/persistent-block-storage/create-volume` guide to create a
73+
new empty volume of the same size as the backup. Note the new volume ID, of find the volume with
74+
command ``openstack volume list``.
7075

7176
- Run this command: ``openstack volume backup restore --force [BACKUP_ID] [VOLUME_ID]``
7277

7378
.. note::
7479

7580
As of writing this, the restore via CLI is not working as intended on all versions of the
76-
client. If you get issues from above command, please try a restore via one of the other options.
81+
client. If you get issues from above command, try a newer version of the client or restore
82+
via one of the other options.
7783

7884
.. seealso::
7985

0 commit comments

Comments
 (0)