Skip to content

Commit 22b7835

Browse files
authored
Merge pull request #69960 from ShaunaDiaz/OSDOCS-9284
OSDOCS-9284: adds RHEL 9.3 to MicroShift 4.15 docs
2 parents b52e0b8 + 83f461c commit 22b7835

7 files changed

+42
-26
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Topics:
7272
File: microshift-about-updates
7373
- Name: Update options
7474
File: microshift-update-options
75-
- Name: Updates with rom-ostree systems
75+
- Name: Updates with rpm-ostree systems
7676
File: microshift-update-rpms-ostree
7777
- Name: Manual updates with RPMs
7878
File: microshift-update-rpms-manually

microshift_updating/microshift-about-updates.adoc

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

77
toc::[]
88

9-
Upgrades are supported on {product-title} beginning with the General Availability version 4.14. Supported upgrades include those from one minor version to the next in sequence, for example, from 4.14 to 4.15. Patch updates are also supported from z-stream to z-stream, for example 4.14.1 to 4.14.2.
9+
Updates are supported on {product-title} beginning with the General Availability version 4.14. Supported updates include those from one minor version to the next in sequence, for example, from 4.14 to 4.15. Patch updates are also supported from z-stream to z-stream, for example 4.14.1 to 4.14.2.
1010

1111
[id="microshift-about-updates-understanding-microshift-updates_{context}"]
1212
== Understanding {microshift-short} updates
@@ -32,11 +32,4 @@ include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
3232
=== Manual RPM updates
3333
You can use the manual RPM update path to replace your existing version of {microshift-short}. The versions of {op-system} and {microshift-short} must be compatible. Ensuring system health and completing additional system backups are manual processes.
3434

35-
[id="microshift-about-updates-checking-version-update-path_{context}"]
36-
== Checking version update path
37-
Before attempting an update of either {op-system-bundle} component, determine which versions of {microshift-short} and {op-system-ostree} or {op-system} you have installed. Plan for the versions of each that you intend to use.
38-
39-
*{product-title} update paths*
40-
41-
* Generally Available Version 4.14 to 4.14.z on {op-system-ostree} 9.2
42-
* Generally Available Version 4.14 to 4.14.z on {op-system} 9.2
35+
include::snippets/microshift-update-paths-snip.adoc[leveloffset=+2]

microshift_updating/microshift-update-options.adoc

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

77
toc::[]
88

9-
You can update {op-system-ostree-first} or {op-system-base-full} with or without updating {product-title} as long as the two versions are compatible. See the following table for details:
9+
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:
1010

1111
include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
1212

13-
*{product-title} update paths*
14-
15-
* Generally Available Version 4.14.0 to 4.14.z on {op-system-ostree} 9.2
16-
* Generally Available Version 4.14.0 to 4.14.z on {op-system} 9.2
13+
include::snippets/microshift-update-paths-snip.adoc[leveloffset=+1]
1714

1815
[IMPORTANT]
1916
====
20-
Updates of {microshift-short} from one minor version to the next must be in sequence. For example, you cannot update from 4.14 to 4.16. You must update 4.14 to 4.15.
17+
Updates of {microshift-short} from one minor version to the next must be in sequence. For example, you cannot update from 4.14 to 4.16. You must update 4.14 to 4.15 and so on.
2118
====
2219

2320
[id="microshift-update-options-standalone-updates_{context}"]
2421
== Standalone {microshift-short} updates
2522

26-
You can update {microshift-short} without reinstalling the applications you created. {op-system} or {op-system-ostree} updates are also not required to update {microshift-short}, as long as the existing operating system is compatible with the new version of {microshift-short} that you want to use.
23+
You can update {microshift-short} without reinstalling your applications. {op-system} or {op-system-ostree} updates are also not required to update {microshift-short}, as long as the existing operating system is compatible with the new version of {microshift-short} that you want to use.
2724

28-
{product-title} 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.
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.
2926

3027
[id="microshift-update-options-rpm-ostree-updates_{context}"]
3128
=== RPM-OSTree updates
@@ -64,12 +61,13 @@ You can update {op-system-ostree} or {op-system} without updating {microshift-sh
6461

6562
[id="microshift-update-options-simultaneous-microshift-rhel-updates_{context}"]
6663
== Simultaneous {microshift-short} and operating system updates
67-
You can update {op-system-ostree} or {op-system} and update {microshift-short} at the same time, on the condition that the versions are compatible. Check for compatibility before beginning an update. First use the {op-system-ostree} documentation specific to your update path to plan and update the operating system. Then use the {microshift-short} update type specific to your update path.
64+
You can update {op-system-ostree} or {op-system} and update {microshift-short} at the same time, on the condition that the versions are compatible. Check for compatibility before beginning an update. First use the {op-system-ostree} and {op-system} documentation specific to your update path to plan and update the operating system. Then use the {microshift-short} update type specific to your update path.
6865

6966
//additional resources for updating RHEL and MicroShift
7067
[role="_additional-resources"]
7168
.Additional resources
7269
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[Managing RHEL for Edge images]
70+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/index[Composing a customized RHEL system image]
7371
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an OSTree system]
7472
* xref:../microshift_updating/microshift-update-rpms-manually.adoc#microshift-update-rpms-manually[Applying updates manually with RPMs]
7573
* xref:../microshift_install/microshift-greenboot.adoc#microshift-greenboot[The Greenboot system health check]

microshift_updating/microshift-update-rpms-manually.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
Updating {product-title} for non-OSTree systems such as {op-system-base-full} requires downloading then updating the RPMs. For patch releases, such as 4.14.1 to 4.14.2, download and update the RPMs. For minor-version release updates, add the step of enabling the update repository using your subscription manager.
9+
Updating {product-title} for non-OSTree systems such as {op-system-base-full} requires downloading then updating the RPMs. For patch releases, such as 4.15.1 to 4.15.2, download and update the RPMs. For minor-version release updates, add the step of enabling the update repository using your subscription manager.
1010

1111
[IMPORTANT]
1212
====
@@ -19,6 +19,7 @@ include::modules/microshift-updating-rpms-z.adoc[leveloffset=+1]
1919

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

22-
//[role="_additional-resources"]
23-
//.Additional resources
24-
//TODO: cross reference to backup and restore when merged
22+
//additional resources for backup and restore
23+
[role="_additional-resources"]
24+
.Additional resources
25+
* 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88

99
Updating {product-title} on an `rpm-ostree` system such as {op-system-ostree-first} requires building a new operating system image containing the new version of {product-title}. After you have the `rpm-ostree` image with {product-title} embedded, direct your system to boot into that operating system image.
1010

11-
The procedures are the same for patches and minor-version updates. For example, use the same steps to upgrade from 4.14.0 to 4.14.1 or from 4.14 to 4.15.
11+
The procedures are the same for minor-version and patch updates. For example, use the same steps to upgrade from 4.14 to 4.15 or from 4.15.0 to 4.15.1.
1212

1313
include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
1414

snippets/microshift-rhde-compatibility-table-snip.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,17 @@ The two products of {op-system-bundle} work together as a single solution for de
1111

1212
[cols="4",%autowidth]
1313
|===
14-
^|*{op-system-ostree} Version*
14+
^|*{op-system-ostree} Version(s)*
1515
^|*{microshift-short} Version*
1616
^|*{microshift-short} Release Status*
1717
^|*{microshift-short} Supported Updates*
1818

19-
^|9.2
19+
^|9.2, 9.3
20+
^|4.15
21+
^|Generally Available
22+
^|4.15.0→4.15.z and 4.15→future minor version
23+
24+
^|9.2, 9.3
2025
^|4.14
2126
^|Generally Available
2227
^|4.14.0→4.14.z and 4.14→4.15
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
//Snippet included in the following assemblies:
2+
//
3+
//* microshift_updating/microshift-about-updates.adoc
4+
//* microshift_updating/microshift-update-options.adoc
5+
6+
:_mod-docs-content-type: SNIPPET
7+
8+
[id="microshift-about-updates-checking-version-update-path_{context}"]
9+
= Checking version update path
10+
11+
Before attempting an update of either {op-system-bundle} component, determine which versions of {microshift-short} and {op-system-ostree} or {op-system} are installed. Plan for the versions of each that you intend to use.
12+
13+
*{product-title} update paths*
14+
15+
* Generally Available Version 4.14 to 4.14.z or 4.15 on {op-system-ostree} 9.2 or 9.3
16+
* Generally Available Version 4.14 to 4.14.z or 4.15 on {op-system} 9.2 or 9.3
17+
18+
* Generally Available Version 4.15 to 4.15.z on {op-system-ostree} 9.2 or 9.3
19+
* Generally Available Version 4.15 to 4.15.z on {op-system} 9.2 or 9.3

0 commit comments

Comments
 (0)