Skip to content

Commit ada3c56

Browse files
committed
OSDOCS-15822: removes TP frombootc backup docs
1 parent 44da128 commit ada3c56

File tree

6 files changed

+50
-48
lines changed

6 files changed

+50
-48
lines changed

microshift_backup_and_restore/microshift-backup-and-restore.adoc

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,12 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
You can manually back up and restore the {microshift-short} database on all supported systems. Greenboot health checks must be completed and you must stop the {microshift-short} service prior to any backups.
9+
You can manually back up and restore the {microshift-short} database on all supported systems. For application data, you must create custom procedures.
1010

11-
[NOTE]
12-
====
13-
Only {microshift-short} data is backed up with the following procedures. Application data is not included.
14-
====
15-
16-
* On `rpm-ostree` systems, {microshift-short} automatically creates a backup on every start. These automatic backups are deleted and replaced with the latest backup each time the system restarts.
17-
* If you are using an `rpm-ostree` system, the data is automatically restored after Greenboot rolls the system back. This data restoration ensures that the database matches the software running on the host after the rollback is completed.
18-
* On other system types, you must back up and restore data manually.
11+
include::modules/microshift-about-data-backups.adoc[leveloffset=+1]
1912

2013
include::modules/microshift-service-stopping.adoc[leveloffset=+1]
2114

2215
include::modules/microshift-backing-up-manually.adoc[leveloffset=+1]
2316

24-
//additional resources for backing-up module
25-
[role="_additional-resources"]
26-
.Additional resources
27-
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service]
28-
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service]
29-
3017
include::modules/microshift-restoring-data-backups.adoc[leveloffset=+1]
31-
32-
//include::modules/microshift-service-starting.adoc[leveloffset=+1]
33-
34-
//additional resources for restoring-data module
35-
[role="_additional-resources"]
36-
.Additional resources
37-
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service]
38-
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
//Module included in the following assemblies:
2+
//
3+
// * microshift_backup_and_restore/microshift-auto-recover-manual-backup.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-about-data-backups_{context}"]
7+
= About backing up and restoring {microshift-short} data
8+
9+
Before you can create a manual backup, greenboot health checks must finish running and you must stop the {microshift-short} service.
10+
11+
* On `rpm-ostree` systems, {microshift-short} automatically creates a backup on every start. These automatic backups are deleted and replaced with the latest backup each time the system restarts.
12+
* Data is also automatically restored on an `rpm-ostree` system after a greenboot system rollback. This data restoration ensures that the database matches the software running on the host after the rollback is completed.
13+
* On other system types, you must back up and restore data manually.
14+
15+
Automated backups are in the `/var/lib/microshift-backups` directory by default. You can use this directory for manually backing up and restoring data by specifying it in each command. When you restore a backup, you must use the entire file path.
16+
17+
[NOTE]
18+
====
19+
The following procedures only backup and restore {microshift-short} data. Application data is not included.
20+
====
21+

modules/microshift-auto-recovery-example-bootc-systems.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66
[id="microshift-auto-recovery-example-bootc-systems_{context}"]
77
= Using automatic recovery in image mode for {op-system-base} systems
88

9-
:FeatureName: Image mode for {op-system-base}
10-
11-
include::snippets/technology-preview.adoc[]
12-
139
As a use case, consider the following example situation in which you want to automate the `auto-recovery` process for image mode for {op-system-base-full} systems that use the systemd service.
1410

1511
[IMPORTANT]
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
//Module included in the following assemblies:
22
//
33
// * microshift_updating/microshift-update-options.adoc
4+
// * microshift_backup_and_restore/microshift-auto-recover-manual-backup.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="microshift-backing-up-manually_{context}"]
78
= Backing up {microshift-short} data manually
89

9-
You can back up {microshift-short} data manually at any time. Back up your data before system updates to preserve it for use if an update fails or for other system trouble. Automated backups are created in the `/var/lib/microshift-backups` directory. You can use this directory for manually backing up and restoring data by specifying it in each command. When you create a backup, you must use the entire file path for the output file.
10+
You can back up {microshift-short} data manually at any time. Back up your data before system updates to preserve it for use if an update fails or for other system trouble. You can use the `/var/lib/microshift-backups` for manually backing up and restoring data by specifying it in each command. When you create a backup, you must use the entire file path for the output file.
1011

1112
.Prerequisites
1213

@@ -15,16 +16,15 @@ You can back up {microshift-short} data manually at any time. Back up your data
1516
1617
.Procedure
1718

18-
. Manually create a backup by using the parent directory and specifying a name, such as `/var/lib/microshift-backups/<my_manual_backup>`, by running the following command:
19+
. Manually create a backup by using the parent directory and specifying a name, such as `/var/lib/microshift-backups/_<manual_backup>_`, by running the following command:
1920
+
20-
[source,terminal]
21+
[source,terminal,subs="+quotes"]
2122
----
22-
$ sudo microshift backup /var/lib/microshift-backups/<my_manual_backup>
23+
$ sudo microshift backup /var/lib/microshift-backups/_<manual_backup>_ <1>
2324
----
24-
Replace `<my_manual_backup>` with the backup name that you want to use.
25+
<1> Replace `_<manual_backup>_` with the backup name that you want to use.
2526
+
2627
.Example output
27-
+
2828
[source,terminal]
2929
----
3030
??? I1017 07:38:16.770506 5900 data_manager.go:92] "Copying data to backup directory" storage="/var/lib/microshift-backups" name="test" data="/var/lib/microshift"
@@ -35,11 +35,11 @@ Replace `<my_manual_backup>` with the backup name that you want to use.
3535

3636
. Optional: Manually create a backup in a specific parent directory with a custom name by running the following command:
3737
+
38-
[source,terminal]
38+
[source,terminal,subs="+quotes"]
3939
----
40-
$ sudo microshift backup /mnt/<other_backups_location>/<another_manual_backup>
40+
$ sudo microshift backup /mnt/_<other_backups_location>_/_<another_manual_backup>_
4141
----
42-
Replace `<other_backups_location>` with the directory you want to use and `<my_manual_backup>` with the backup name you want to use.
42+
Replace `_<other_backups_location>_` with the directory you want to use and `_<my_manual_backup>_` with the backup name you want to use.
4343

4444
.Verification
45-
* You can verify that the backup exists by viewing the data in the directory you chose. For example, `/var/lib/microshift-backups/<my_manual_backup>/` or `/mnt/<other_backups_location>/<another_manual_backup>`.
45+
* You can verify that the backup exists by viewing the data in the directory you chose. For example, `/var/lib/microshift-backups/_<manual_backup>_/` or `/mnt/_<other_backups_location>_/_<another_manual_backup>_`.
Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
//Module included in the following assemblies:
22
//
33
// * microshift_updating/microshift-update-options.adoc
4+
// * microshift_backup_and_restore/microshift-auto-recover-manual-backup.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="microshift-restoring-data-backups-manually_{context}"]
78
= Restoring {microshift-short} data backups manually
89

9-
You can restore {microshift-short} data from a backup manually. Backups can be restored after updates, or after other system events that remove or damage required data. Automated backups are in the `/var/lib/microshift-backups` directory by default. You can use this directory for manually backing up and restoring data by specifying it in each command. When you restore a backup, you must use the entire file path.
10+
You can restore {microshift-short} data from a backup manually. Backups can be restored after updates, or after other system events that remove or damage required data. When you restore a backup, you must use the entire file path.
1011

1112
[NOTE]
1213
====
13-
On an `rpm-ostree` system, {microshift-short} backs up and restores data automatically.
14+
On an `rpm-ostree` system, {microshift-short} backs up and restores data automatically. Automated backups are in the `/var/lib/microshift-backups` directory by default.
1415
====
1516

1617
.Prerequisites
1718

1819
* Root access to the host.
19-
* Full path of the data backup file.
20+
* You have the full path of the data backup file.
2021
* The {microshift-short} service is stopped.
2122
2223
.Procedure
2324

2425
. Manually restore {microshift-short} data by using the full file path of the backup you want to restore by running the following command:
2526
+
26-
[source,terminal]
27+
[source,terminal,subs="+quotes"]
2728
----
28-
$ sudo microshift restore /var/lib/microshift-backups/<my_manual_backup>
29+
$ sudo microshift restore /var/lib/microshift-backups/_<manual_backup>_ <1>
2930
----
30-
Replace `<my_manual_backup>` with the backup name that you used. Optional: You can also restore automatic `ostree` backups using the full file path.
31+
<1> Replace `_<manual_backup>_` with the backup name that you used. Optional: You can also restore automatic `ostree` backups using the full file path.
3132
+
3233
.Example output
33-
+
3434
[source,terminal]
3535
----
3636
??? I1017 07:39:52.055165 6007 data_manager.go:131] "Copying backup to data directory" storage="/var/lib/microshift-backups" name="test" data="/var/lib/microshift"
@@ -43,13 +43,18 @@ Replace `<my_manual_backup>` with the backup name that you used. Optional: You c
4343

4444
. Optional. Manually restore data from a customized directory by using the full file path of the backup. Run the following command:
4545
+
46-
[source,terminal]
46+
[source,terminal,subs="+quotes"]
4747
----
48-
$ sudo microshift restore /<mnt>/<other_backups_location>/<another_manual_backup>
48+
$ sudo microshift restore /mnt/_<other_backups_location>_/_<another_manual_backup>_ <1>
4949
----
50-
Replace `<other_backups_location>` with the directory you used and `<my_manual_backup>` with the backup name you used when creating the backup you are restoring.
50+
<1> Replace `_<other_backups_location>_` with the directory you used and `_<my_manual_backup>_` with the backup name you used when creating the backup you are restoring.
5151

5252
. Restart the host. Restarting the host enables all workloads and pods to restart.
5353

5454
.Verification
55-
* Use the `oc get pods -A` command to verify that the cluster is running, then check the restored data.
55+
56+
* Use the `oc get pods -A` command to verify that the cluster is running, then check the restored data.
57+
+
58+
--
59+
include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2]
60+
--

modules/microshift-service-stopping.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * microshift/microshift-install-rpm.adoc
44
// * microshift/microshift-update-rpms-ostree.adoc
5+
// * microshift_backup_and_restore/microshift-auto-recover-manual-backup.adoc
56

67
:_mod-docs-content-type: PROCEDURE
78
[id="stopping-microshift-service_{context}"]

0 commit comments

Comments
 (0)