Skip to content

Commit 58d51a1

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #100209 from ShaunaDiaz/OSDOCS-13908
OSDOCS-13908: modularized update options assembly MShift
2 parents babf53a + e882c8f commit 58d51a1

29 files changed

+199
-125
lines changed

‎microshift_troubleshooting/microshift-installing-troubleshooting.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To troubleshoot a failed {microshift-short} installation, you can run an sos rep
1010

1111
include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
1212

13-
[id="additional-resources_microshift-installing-troubleshooting_{context}"]
13+
[id="additional-resources_microshift-installing-troubleshooting"]
1414
[role="_additional-resources"]
1515
== Additional resources
1616
* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About {microshift-short} sos reports]

‎microshift_troubleshooting/microshift-troubleshoot-updates.adoc‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-troubleshoot-updates"]
3-
= Troubleshoot updates
3+
= Troubleshooting updates
4+
45
include::_attributes/attributes-microshift.adoc[]
56
:context: microshift-troubleshoot-updates
67

78
toc::[]
89

9-
To troubleshoot {microshift-short} updates, use the following guide.
10+
[role="_abstract"]
11+
To troubleshoot {microshift-short} updates, you can check update paths, review journal and greenboot health check logs, and use other techniques to help you solve update problems.
1012

1113
include::modules/microshift-updates-troubleshooting.adoc[leveloffset=+1]
1214

13-
//additional resources for troubleshooting module
15+
include::modules/microshift-check-journal-logs-updates.adoc[leveloffset=+1]
16+
17+
include::modules/microshift-greenboot-check-status.adoc[leveloffset=+1]
18+
19+
[id="additional-resources_microshift-troubleshoot-updates"]
1420
[role="_additional-resources"]
15-
.Additional resources
21+
== Additional resources
1622
* xref:../microshift_install_get_ready/microshift-greenboot.adoc#microshift-greenboot-systemd-journal-data_microshift-greenboot[Enabling `systemd` journal service data persistency]
1723
* xref:../microshift_troubleshooting/microshift-version.adoc#microshift-version[Checking the MicroShift version]
1824
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service]
1925
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service]
20-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing RHEL for Edge images]
21-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#rolling_back_rhel_for_edge_images[Rolling back RHEL for Edge images]
22-
23-
include::modules/microshift-check-journal-logs-updates.adoc[leveloffset=+1]
24-
25-
include::modules/microshift-greenboot-check-status.adoc[leveloffset=+1]
26+
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing RHEL for Edge images]
27+
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#rolling_back_rhel_for_edge_images[Rolling back RHEL for Edge images]

‎microshift_updating/microshift-list-update-contents.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-list-update-contents"]
33
= Listing RPM update package contents
4+
45
include::_attributes/attributes-microshift.adoc[]
56
:context: microshift-list-update-contents
67

78
toc::[]
89

9-
You can preview the contents of a {microshift-short} RPM package update before installing.
10+
[role="_abstract"]
11+
You can preview the contents of a {microshift-short} RPM package update before installing. This helps you make sure that the update you are planning is a supported configuration of {op-system-bundle}.
1012

1113
include::modules/microshift-get-rpm-release-info.adoc[leveloffset=+1]

‎microshift_updating/microshift-update-options.adoc‎

Lines changed: 16 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,37 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
include::_attributes/attributes-microshift.adoc[]
32
[id="microshift-update-options"]
4-
= Update options with {product-title} and {op-system-bundle}
3+
= Update options for Red Hat Device Edge
4+
5+
include::_attributes/attributes-microshift.adoc[]
56
:context: microshift-update-options
67

78
toc::[]
89

9-
Updates are supported on {product-title} beginning with the General Availability version 4.14.
10-
11-
[id="red-hat-device-edge-updates_{context}"]
12-
== {op-system-bundle} updates
13-
You can update {op-system-ostree-first} images or {op-system-base-full} with or without updating the {product-title} version if the version combination is supported. See the following table for details:
14-
15-
include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
16-
17-
include::snippets/microshift-unsupported-config-warn.adoc[leveloffset=+1]
18-
19-
[id="microshift-update-options-standalone-updates_{context}"]
20-
== Standalone {microshift-short} updates
21-
Consider the following when planning to update {microshift-short}:
22-
23-
* You can potentially update {microshift-short} without reinstalling your applications and Operators.
24-
* {op-system-base} or {op-system-ostree} updates are only required to update {microshift-short} if the existing operating system is not compatible with the new version of {microshift-short} that you want to use.
25-
* {microshift-short} operates as an in-place update and does not require removal of the previous version. Data backups beyond those required for the usual functioning of your applications are also not required.
26-
27-
[NOTE]
28-
====
29-
Only `rpm-ostree` updates include automatic rollbacks.
30-
====
31-
32-
[id="microshift-update-options-rpm-ostree-updates_{context}"]
33-
=== {op-system-ostree} updates
34-
35-
Using the {op-system-ostree} `rpm-ostree` update path allows for automated backup and system rollback in case any part of the update fails.
36-
37-
* You can update {microshift-short} on an `rpm-ostree` system such as {op-system-ostree} by building a new system image containing the new version of {microshift-short}.
38-
* The `rpm-ostree` image can be the same version or an updated version, but the versions of {op-system-ostree} and {microshift-short} must be compatible.
10+
[role="_abstract"]
11+
To update {op-system-bundle}, you can update both {product-title} and {op-system-full}, or each part by itself without updating the other. You must keep the parts in a supported configuration. Consider the following options when planning updates to your current deployments.
3912

40-
The following features are available in the {op-system-ostree} update path:
13+
include::modules/microshift-rhde-updates.adoc[leveloffset=+1]
4114

42-
* The system automatically rolls back to a previous healthy system state if the update fails.
43-
* Applications do not need to be reinstalled.
44-
* Operators do not need to be reinstalled.
45-
* You can update an application without updating {microshift-short} using this update type.
46-
* The image you build can contain other updates as needed.
15+
include::modules/microshift-standalone-updates.adoc[leveloffset=+1]
4716

48-
To begin a {microshift-short} update by embedding in a {op-system-ostree} image, use the procedures in the following documentation:
17+
include::modules/microshift-rpm-ostree-updates.adoc[leveloffset=+2]
4918

50-
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an OSTree system]
51-
52-
To understand more about greenboot, see the following documentation:
53-
54-
* xref:../microshift_install_get_ready/microshift-greenboot.adoc#microshift-greenboot[The greenboot health check]
55-
* xref:../microshift_running_apps/microshift-greenboot-workload-health-checks.adoc#microshift-greenboot-workload-health-checks[Greenboot workload health checks]
56-
57-
[id="microshift-update-options-manual-rpm-updates_{context}"]
58-
=== Manual RPM updates
59-
You can update {microshift-short} manually on a non-OSTree system such as {op-system-base-full} by updating the RPMs.
60-
61-
* To complete this update type, use the subscription manager to enable the repository that contains the new RPMs.
62-
* Use manual processes to ensure system health and complete additional system backups.
63-
* To begin a manual RPM update, use the procedures in the following documentation:
64-
65-
* xref:../microshift_updating/microshift-update-rpms-manually.adoc#microshift-update-rpms-manually[About updating MicroShift RPMs manually]
19+
include::modules/microshift-manual-rpm-updates.adoc[leveloffset=+2]
6620

6721
include::modules/microshift-updates-rhde-config-rhel-repos.adoc[leveloffset=+3]
6822

69-
[id="microshift-update-options-standalone-rhel-updates_{context}"]
70-
== Standalone {op-system-ostree} updates
71-
You can update {op-system-ostree} or {op-system-base} without updating {microshift-short}, on the condition that the two versions are compatible. Check compatibilities before beginning an update. Use the {op-system-ostree} documentation specific to your update path.
23+
include::modules/microshift-standalone-rhel-updates.adoc[leveloffset=+1]
7224

73-
//additional resources for updating RHEL alone
74-
[role="_additional-resources"]
75-
.Additional resources
76-
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing RHEL for Edge images]
77-
78-
[id="microshift-update-options-simultaneous-microshift-rhel-updates_{context}"]
79-
== Simultaneous {microshift-short} and operating system updates
80-
You can update {op-system-ostree} or {op-system-base} and update {microshift-short} at the same time, on the condition that the versions are compatible. Use the following workflow:
81-
82-
. Check for compatibility before beginning an update.
83-
. Use the {op-system-ostree} and {op-system-base} documentation specific to your update path to plan and update the operating system.
84-
. Enable the correct {microshift-short} repository to ensure alignment between your {op-system-base} and {microshift-short} versions.
85-
. Use the {microshift-short} update type specific to your update path.
25+
include::modules/microshift-simultaneous-microshift-rhel-updates.adoc[leveloffset=+1]
8626

87-
[id="microshift-update-options-edge-to-image_{context}"]
88-
== Migrating {microshift-short} from {op-system-ostree} to {op-system-image}
27+
include::modules/microshift-migrate-rhel-edge-to-image-mode.adoc[leveloffset=+1]
8928

90-
Starting with {microshift-short} 4.19, you can migrate your {microshift-short} node from {op-system-ostree} to {op-system-image} if the versions are compatible. Check compatibilities before beginning a migration. See the {op-system-base} documentation for instructions to migrate your image-based {op-system-base} system.
91-
//RHEL docs are coming soon
92-
93-
//additional resources for updating RHEL and MicroShift
29+
[id="additional-resources_microshift-update-options"]
9430
[role="_additional-resources"]
95-
.Additional resources
31+
== Additional resources
32+
9633
* link:https://access.redhat.com/articles/rhel-eus#c5[How to Access EUS]
9734
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/index[Composing a customized RHEL system image]
98-
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an {op-system-ostree} system]
99-
* xref:../microshift_updating/microshift-update-rpms-manually.adoc#microshift-update-rpms-manually[Applying updates manually with RPMs]
10035
* xref:../microshift_install_get_ready/microshift-greenboot.adoc#microshift-greenboot[The greenboot system health check]
10136
* xref:../microshift_running_apps/microshift-greenboot-workload-health-checks.adoc#microshift-greenboot-workload-health-checks[Greenboot workload health checks]
102-
//* xref:../microshift_updating/microshift-update-rhel-edge-to-image-mode.adoc#microshift-update-rhel-edge-to-image[Migrating {microshift-short} from {op-system-ostree} to {op-system-image}]
37+

‎microshift_updating/microshift-update-rhel-edge-to-image-mode.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
[id="microshift-update-rhel-edge-to-image-mode"]
33
include::_attributes/attributes-microshift.adoc[]
44
= Migrating {microshift-short} from {op-system-ostree} to {op-system-image}
5+
56
:context: microshift-update-rhel-edge-to-image
67

78
toc::[]
89

10+
[role="_abstract"]
911
To migrate {microshift-short} from {op-system-ostree-first}, embed {microshift-short} on a new {op-system-image} image.
1012

1113
include::modules/microshift-update-edge-to-image.adoc[leveloffset=+1]
1214

13-
include::modules/microshift-updates-edge-to-image-uid-drift.adoc[leveloffset=+1]
15+
include::modules/microshift-updates-edge-to-image-uid-drift.adoc[leveloffset=+2]

‎microshift_updating/microshift-update-rpms-manually.adoc‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-update-rpms-manually"]
3-
= About updating RPMs manually
3+
= Updating RPMs manually
4+
45
include::_attributes/attributes-microshift.adoc[]
56
:context: microshift-update-rpms-manually
67

78
toc::[]
89

9-
Updating {product-title} for non-image-based {op-system-base-full} systems requires updating the RPMs. For patch releases, such as 4.20.1 to 4.20.2, simply update the RPMs. For minor-version release updates, add the step of enabling the update repository using your subscription manager.
10+
[role="_abstract"]
11+
Updating {product-title} for non-image-based {op-system-base-full} systems requires updating the RPMs. For patch releases, such as {product-version}.1 to {product-version}.2, simply update the RPMs. For minor-version release updates, add the step of enabling the update repository by using your subscription manager.
1012

1113
[NOTE]
1214
====
@@ -17,7 +19,8 @@ include::modules/microshift-updating-rpms-z.adoc[leveloffset=+1]
1719

1820
include::modules/microshift-updating-rpms-y.adoc[leveloffset=+1]
1921

20-
//additional resources for backup and restore
22+
[id="additional-resources_microshift-update-rpms-manually"]
2123
[role="_additional-resources"]
22-
.Additional resources
23-
* xref:../microshift_backup_and_restore/microshift-backup-and-restore.adoc#microshift-backup-and-restore[Backup and restore]
24+
== Additional resources
25+
26+
* xref:../microshift_backup_and_restore/microshift-backup-and-restore.adoc#microshift-backup-and-restore[Backup and restore]

‎microshift_updating/microshift-update-rpms-ostree.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-update-rpms-ostree"]
33
= Updating RPMs on a RHEL for Edge system
4+
45
include::_attributes/attributes-microshift.adoc[]
56
:context: microshift-update-rpms-ostree
67

78
toc::[]
89

10+
[role="_abstract"]
911
You can update {microshift-short} on {op-system-ostree-first} by embedding the new version of {microshift-short} on a new operating system image.
1012

1113
include::modules/microshift-updates-rpms-ostree-con.adoc[leveloffset=+1]

‎microshift_welcome/index.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ In addition to standard Kubernetes APIs, {microshift-short} includes a small sub
4949

5050
include::modules/microshift-k8s-apis.adoc[leveloffset=+1]
5151

52+
[id="additional-resources_microshift-welcome-index"]
5253
[role="_additional-resources"]
53-
.Additional resources
54+
== Additional resources
5455
* xref:../microshift_rest_api/index.adoc#api-index[API index]
5556
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}]

‎modules/microshift-check-journal-logs-updates.adoc‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,8 @@
66
[id="microshift-check-journal-logs-updates_{context}"]
77
= Checking journal logs after updates
88

9-
In some cases, {microshift-short} might fail to update. In these events, it is helpful to understand failure types and how to troubleshoot them. The journal logs can assist in diagnosing update failures.
10-
11-
[NOTE]
12-
====
13-
The default configuration of the `systemd` journal service stores data in a volatile directory. To persist system logs across system starts and restarts, enable log persistence and set limits on the maximum journal data size.
14-
====
9+
[role="_abstract"]
10+
Journal logs can assist in diagnosing {microshift-short} update failures. The default configuration of the `systemd` journal service stores data in a volatile directory. To persist system logs across system starts and restarts, enable log persistence and set limits on the maximum journal data size.
1511

1612
.Procedure
1713

‎modules/microshift-get-rpm-release-info.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="microshift-get-rpm-release-info_{context}"]
77
= Listing the contents of the {microshift-short} RPM release package
88

9+
[role="_abstract"]
910
To see the images included with a {microshift-short} release, you can list the contents of the `microshift-release-info` RPM by downloading and unpacking the RPM.
1011

1112
.Prerequisites

0 commit comments

Comments
 (0)