Skip to content

Commit 7490118

Browse files
committed
OSDOCS-6720: Adding upgrade book to MicroShift
1 parent 3728911 commit 7490118

File tree

6 files changed

+59
-0
lines changed

6 files changed

+59
-0
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,13 @@ Topics:
5858
- Name: Greenboot health check
5959
File: microshift-greenboot
6060
---
61+
Name: Updating clusters
62+
Dir: microshift_updating
63+
Distros: microshift
64+
Topics:
65+
- Name: About MicroShift updates
66+
File: microshift-about-updates
67+
---
6168
Name: Support
6269
Dir: microshift_support
6370
Distros: microshift

microshift_updating/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes

microshift_updating/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_content-type: ASSEMBLY
2+
[id="microshift-about-updates"]
3+
= About {product-title} updates
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: microshift-about-updates
6+
7+
toc::[]
8+
9+
You can update a {product-title} cluster by using the OpenShift CLI (`oc`).
10+
// This PR is for the book build. Note that the OCP structure consists of a landing page of xrefs to other major sections within the book. MicroShift likely does not require that depth of structure, so starting simply with one page.
11+
12+
[id="microshift-about-updates-understanding-microshift-updates"]
13+
== Understanding {product-title} updates
14+
{product-title} updates are available as either RPMs or by embedding the {product-title} image in an RPM OSTree blueprint.
15+
You can update an {product-title} cluster by using the OpenShift CLI (`oc`).
16+
//Platform administrators can view new update options by looking at the output of the `oc adm upgrade` command.
17+
//An update begins when...
18+
19+
[NOTE]
20+
====
21+
Operators previously installed must be reinstalled using manifests.
22+
====
23+
24+
[id="microshift-about-updates-rpm-updates"]
25+
=== RPM updates
26+
Using the RPM update method replaces your existing version. No rollback is possible with this update type.
27+
//we can call a module here or xref out; not sure the best method for our use case until we have the content
28+
29+
[id="microshift-about-updates-rpm-ostree-updates"]
30+
=== RPM OSTree updates
31+
Using the RPM OSTree update path allows for system rollback.
32+
//we can call a module here or xref out; not sure the best method for our use case until we have the content
33+
34+
[id="microshift-about-updates-checking-version-update-compatibility"]
35+
== Checking version update compatibility
36+
Before attempting an update, determine which version of {product-title} you have installed. Only the following update paths are supported:
37+
38+
* Version 4.13 to 4.14
39+
//replace with matrix including RHEL versions?
40+
//place xref here to version-check assembly
41+
42+
[id="microshift-about-updates-update-disconnected-environment"]
43+
== Updating a cluster in a disconnected environment
44+
//sample topic only
45+
46+
[id="microshift-about-updates-troubleshooting-updates"]
47+
== Troubleshooting updates
48+
//sample topic only

microshift_updating/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules

microshift_updating/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

0 commit comments

Comments
 (0)