Skip to content

Commit 00651b2

Browse files
authored
Merge pull request #102312 from ShaunaDiaz/OSDOCS-15566
OSDOCS-15566: adds RHEL 10 notes to install docs
2 parents fa34446 + 2ea6db2 commit 00651b2

32 files changed

+218
-109
lines changed

microshift_install_kickstarts/microshift-rhel-kickstarts.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
include::_attributes/attributes-microshift.adoc[]
33
[id="microshift-rhel-kickstarts"]
44
= Using Kickstart files for installing {microshift-short} in {op-system-base}
5+
56
:context: microshift-rhel-kickstarts
67

78
toc::[]
89

10+
[role="_abstract"]
911
Use a Kickstart file that automates the installation of an {op-system-base} image with {microshift-short}.
1012

1113
include::modules/microshift-rhel-kickstarts-con.adoc[leveloffset=+1]

microshift_install_rpm/microshift-access-node.adoc

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

77
toc::[]
88

9+
[role="_abstract"]
910
Access a {microshift-short} node by using the {oc-first}.
1011

1112
include::modules/microshift-accessing.adoc[leveloffset=+1]

microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22
include::_attributes/attributes-microshift.adoc[]
33
[id="microshift-embed-in-rpm-ostree-for-offline-use"]
44
= Embedding in a {op-system-ostree} image for offline use
5+
56
:context: microshift-embed-rpm-ostree-offline-use
67

78
toc::[]
89

9-
Embedding {microshift-short} containers in an `rpm-ostree` commit means that you can run a node in air-gapped, disconnected, or offline environments. You can embed {product-title} containers in a {op-system-ostree-first} image so that container engines do not need to pull images over a network from a container registry. Workloads can start immediately without network connectivity.
10+
[role="_abstract"]
11+
You can embed {microshift-short} in a container by using {op-system-base-full} for fully offline deployments.
12+
13+
include::modules/microshift-about-offline-deployment-rhel-edge.adoc[leveloffset=+1]
1014

1115
include::modules/microshift-embed-microshift-image-offline-deploy.adoc[leveloffset=+1]
1216

microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,28 @@
22
include::_attributes/attributes-microshift.adoc[]
33
[id="microshift-embed-in-rpm-ostree"]
44
= Embedding in a {op-system-ostree} image using image builder
5+
56
:context: microshift-embed-in-rpm-ostree
67

78
toc::[]
89

9-
Use this guide to build a {op-system-base} image containing {microshift-short}.
10+
[role="_abstract"]
11+
You can build a {op-system-base} image containing {microshift-short}.
1012

1113
include::modules/microshift-preparing-for-image-building.adoc[leveloffset=+1]
1214

1315
include::modules/microshift-embed-ostree-enable-eus-repos.adoc[leveloffset=+1]
1416

1517
include::modules/microshift-adding-repos-to-image-builder.adoc[leveloffset=+1]
1618

17-
[role="_additional-resources"]
18-
.Additional resources
19-
20-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-image-builder-system-requirements_setting-up-image-builder[Image builder system requirements]
21-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/setting-up-image-builder_composing-installing-managing-rhel-for-edge-images#edge-installing-image-builder_setting-up-image-builder[Installing image builder]
22-
2319
include::modules/microshift-adding-service-to-blueprint.adoc[leveloffset=+1]
2420

2521
include::modules/microshift-adding-other-packages-to-blueprint.adoc[leveloffset=+1]
2622

27-
[role="_additional-resources"]
28-
.Additional resources
29-
* link:https://osbuild.org/docs/user-guide/blueprint-reference[Blueprint Reference]
30-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/composing-a-rhel-for-edge-image-using-image-builder-command-line_composing-installing-managing-rhel-for-edge-images[Creating a {op-system-ostree} Container blueprint using image builder CLI]
31-
* link:https://osbuild.org/docs/on-premises/commandline/building-ostree-images[Building OSTree image]
32-
* link:https://podman.io/docs/installation[Installing Podman]
33-
3423
include::modules/microshift-ca-adding-bundle.adoc[leveloffset=+1]
3524

3625
include::modules/microshift-ca-adding-bundle-ostree.adoc[leveloffset=+2]
3726

38-
[role="_additional-resources"]
39-
.Additional resources
40-
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
41-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/using-shared-system-certificates_securing-networks[Using Shared System Certificates ({op-system-base} 9)]
42-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#image-customizations_creating-system-images-with-composer-command-line-interface[Supported image customizations ({op-system-base} 9)]
43-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/creating-and-managing-ostree-image-updates_composing-installing-managing-rhel-for-edge-images[Creating and managing OSTree image updates]
44-
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an OSTree system]
45-
4627
include::modules/microshift-creating-ostree-iso.adoc[leveloffset=+1]
4728

4829
include::modules/microshift-add-blueprint-build-iso.adoc[leveloffset=+1]
@@ -51,24 +32,16 @@ include::modules/microshift-download-iso-prep-for-use.adoc[leveloffset=+1]
5132

5233
include::modules/microshift-embed-kickstart-in-iso.adoc[leveloffset=+2]
5334

35+
[id="additional-resources_microshift-embed-in-rpm-ostree"]
5436
[role="_additional-resources"]
55-
.Additional resources
37+
== Additional resources
5638

57-
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing RHEL for Edge images]
39+
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
40+
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an OSTree system]
5841
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing {microshift-short}]
59-
* link:https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console pull secret]
6042
* xref:../microshift_networking/microshift-firewall.adoc#microshift-firewall-req-settings_microshift-firewall[Required firewall settings]
6143
* xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for embedding {microshift-short} in {op-system-base} installation]
62-
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/creating-kickstart-files_rhel-installer[Creating Kickstart files]
63-
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/kickstart-script-file-format-reference_rhel-installer#kickstart-file-format_kickstart-script-file-format-reference[A.1. Kickstart file format]
64-
* link:https://access.redhat.com/solutions/60959[How to embed a Kickstart file into an ISO image]
44+
* link:https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console pull secret]
45+
* xref:../microshift_install_rpm/microshift-access-node.adoc#microshift-access-node[Accessing the {microshift-short} node with oc]
6546

6647
//Add modules about using the VM and getting the ISO up and running, then starting MicroShift...
67-
68-
include::modules/microshift-accessing.adoc[leveloffset=+1]
69-
70-
include::modules/microshift-accessing-node-locally.adoc[leveloffset=+2]
71-
72-
include::modules/microshift-accessing-node-open-firewall.adoc[leveloffset=+2]
73-
74-
include::modules/microshift-accessing-node-remotely.adoc[leveloffset=+2]

microshift_updating/microshift-update-rpms-manually.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@ include::_attributes/attributes-microshift.adoc[]
88
toc::[]
99

1010
[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.
11+
You can update {microshift-short} or {op-system-bundle} manually using RPMs.
1212

13-
[NOTE]
14-
====
15-
You can back up application data as needed and move the data copy to a secure location when using any update type.
16-
====
13+
include::modules/microshift-updates-rpms-con.adoc[leveloffset=+1]
1714

1815
include::modules/microshift-updating-rpms-z.adoc[leveloffset=+1]
1916

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 @@ include::_attributes/attributes-microshift.adoc[]
88
toc::[]
99

1010
[role="_abstract"]
11-
You can update {microshift-short} on {op-system-ostree-first} by embedding the new version of {microshift-short} on a new operating system image.
11+
You can update {microshift-short} on {op-system-ostree-first} {rhel-major} by embedding the new version of {microshift-short} on a new operating system image.
1212

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_running_applications/embed-microshift-offline-deploy.adoc
4+
// microshift_install_rpm_ostree/microshift-embed-rpm-ostree-offline-use.adoc
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="microshift-about-offline-deployment-rhel-edge_{context}"]
8+
= About offline deployments with {op-system-ostree}
9+
10+
[role="_abstract"]
11+
Embedding {microshift-short} containers in an `rpm-ostree` commit means that you can run a node in disconnected or offline environments.
12+
13+
You can embed {product-title} containers in a {op-system-ostree-first} image so that container engines do not need to pull images over a network from a container registry. Workloads can start immediately without network connectivity.

modules/microshift-about.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="con-about-microshift_{context}"]
77
= About {product-title}
88

9+
[role="_abstract"]
910
Working with resource-constrained field environments and hardware presents many challenges not experienced with cloud computing. {microshift-short} enables you to solve problems for edge devices by:
1011

1112
* Running the same Kubernetes workloads you run in the cloud, but at the edge.

modules/microshift-accessing-node-locally.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
[id="accessing-microshift-node-locally_{context}"]
99
= Accessing the {microshift-short} node locally
1010

11+
[role="_abstract"]
1112
Use the following procedure to access the {microshift-short} node locally by using a `kubeconfig` file.
1213

1314
.Prerequisites

modules/microshift-accessing-node-open-firewall.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
[id="microshift-accessing-node-open-firewall_{context}"]
99
= Opening the firewall for remote access to the {microshift-short} node
1010

11-
Use the following procedure to open the firewall so that a remote user can access the {microshift-short} service. You must complete this procedure before a workstation user can access the node remotely.
11+
[role="_abstract"]
12+
You must open the firewall before a workstation user can access the {microshift-short} node remotely.
1213

1314
For this procedure, `user@microshift` is the user on the {microshift-short} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
1415

@@ -32,4 +33,4 @@ For this procedure, `user@microshift` is the user on the {microshift-short} host
3233
+
3334
--
3435
include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2]
35-
--
36+
--

0 commit comments

Comments
 (0)