Skip to content

Commit c56357b

Browse files
authored
Merge pull request #90346 from ShaunaDiaz/OSDOCS-13301
OSDOCS-13301: updates install guides MicroShift 4.19
2 parents e8bf8f6 + ce033a8 commit c56357b

18 files changed

+129
-111
lines changed

microshift_configuring/microshift_low_latency/microshift-low-latency.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,6 @@ Complete the build process by starting with the following procedure to embed {mi
7373
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9/html/installing_rhel_9_for_real_time/assembly_installing-rhel-for-real-time_installing-rhel-9-for-real-time#post-installation-instructions_assembly_installing-rhel-for-real-time[Post installation instructions] (RHEL for Real Time documentation)
7474
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image]
7575

76-
* link:https://access.redhat.com/solutions/4096521[FAQ about {op-system-base} for Real Time (kernel-rt)]
77-
//Can likely remove KCS after 2024 as it may go out of date
78-
7976
include::modules/microshift-low-latency-prepare-workload.adoc[leveloffset=+1]
8077

8178
//additional resources for preparing the workload

microshift_install_get_ready/microshift-install-get-ready.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ When choosing an image-based installation, consider whether the installation tar
5656

5757
Familiarize yourself with the following {op-system-base} tools and concepts:
5858

59-
* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system.
60-
//xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for installting {microshift-short} in {op-system-base}]
59+
* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. For more information, see xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for installting {microshift-short} in {op-system-base}].
6160

6261
* {op-system-base} image builder is a tool for creating deployment-ready customized system images. {op-system-base} image builder uses a blueprint that you create to make the ISO. {op-system-base} image builder is best installed on a {op-system-base} VM and is built with the `composer-cli` tool. To set up these tools and review the workflow, see the following {op-system-base} documentation links:
6362
** link:https://docs.redhat.com/en/documentation/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#composer-command-line-interface_creating-system-images-with-composer-command-line-interface[Introducing the RHEL image builder command-line interface]
@@ -79,7 +78,7 @@ For most installation types, you must also take the following steps:
7978
* Be ready to configure {microshift-short} by adding parameters and values to the {microshift-short} YAML configuration file. See xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-configuring[Using the {microshift-short} configuration file] for more information.
8079

8180
* Decide whether you need to configure storage for the application and tasks you are using in your {microshift-short} cluster, or disable the {microshift-short} storage plug-in completely.
82-
** For more information about creating volume groups and persistent volumes on {op-system-base}, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
81+
** For more information about creating volume groups and persistent volumes on {op-system-base}, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
8382
** For more information about the {microshift-short} plug-in, see xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-plugin-overview[Dynamic storage using the LVMS plugin].
8483

8584
* Configure networking settings according to the access needs you plan for your {microshift-short} cluster and applications. Consider whether you want to use single or dual-stack networks, configure a firewall, or configure routes.
@@ -95,4 +94,3 @@ For most installation types, you must also take the following steps:
9594
[role="_additional-resources"]
9695
.Additional resources
9796
* xref:../microshift_install_rpm_ostree/microshift-deploy-with-mirror-registry.adoc#microshift-deployment-mirror[Mirroring container images for disconnected installations].
98-
//To learn about provisioning a VM, booting the ISO, and starting {microshift-short}, see xref TBD

microshift_install_rpm/microshift-install-rpm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
2323
* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
2424
* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Configuring MicroShift].
2525
* For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
26-
* For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups].
27-
* For more information about creating VGs and PVs, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
26+
* For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups].
27+
* For more information about creating VGs and PVs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
2828
2929
include::modules/microshift-install-rpms.adoc[leveloffset=+1]
3030

microshift_install_rpm_opt/microshift-install-optional-rpms.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,6 @@ You can install optional RPM packages with {microshift-short} to provide additio
1313

1414
When you install {microshift-short}, optional RPM packages can be added. Examples of optional RPMs include those designed to expand your network, add and manage operators, and manage applications. Use the following procedures to add the packages that you need.
1515

16-
include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2]
17-
18-
//additional resources for installing OLM
19-
[role="_additional-resources"]
20-
.Additional resources
21-
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
22-
2316
include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+2]
2417

2518
//additional resources for installing GitOps
@@ -34,3 +27,18 @@ include::modules/microshift-install-multus-rpm.adoc[leveloffset=+2]
3427
.Additional resources
3528
* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
3629

30+
include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2]
31+
32+
//additional resources for installing OLM
33+
[role="_additional-resources"]
34+
.Additional resources
35+
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
36+
37+
38+
//include::modules/microshift-install-rhoai.adoc[leveloffset=+2]
39+
40+
//additional resources for installing RHOAI
41+
//[role="_additional-resources"]
42+
//.Additional resources
43+
//* xref:../microshift_ai/microshift-ai.adoc#microshift-ai[Using Red{nbsp}Hat OpenShift AI with {microshift-short}]
44+
//should be an attribute for rhoai by the time this merges

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ include::modules/microshift-embed-kickstart-in-iso.adoc[leveloffset=+2]
5858
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing {microshift-short}]
5959
* link:https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console pull secret]
6060
* xref:../microshift_networking/microshift-firewall.adoc#microshift-firewall-req-settings_microshift-firewall[Required firewall settings]
61-
//* xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for embedding {microshift-short} in {op-system-base} installation]
61+
* xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for embedding {microshift-short} in {op-system-base} installation]
6262
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/creating-kickstart-files_rhel-installer[Creating Kickstart files]
6363
* 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]
6464
* link:https://access.redhat.com/solutions/60959[How to embed a Kickstart file into an ISO image]

modules/microshift-accessing-cluster-locally.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Use the following procedure to access the {microshift-short} cluster locally by
1212

1313
.Prerequisites
1414

15-
* You have installed the `oc` binary.
15+
* You installed {oc-first}.
1616
1717
.Procedure
1818

@@ -41,7 +41,6 @@ $ chmod go-r ~/.kube/config
4141

4242
* Verify that {microshift-short} is running by entering the following command:
4343
+
44-
[source,terminal]
45-
----
46-
$ oc get all -A
47-
----
44+
--
45+
include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2]
46+
--

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For this procedure, `user@microshift` is the user on the {microshift-short} host
1414

1515
.Prerequisites
1616

17-
* You have installed the `oc` binary.
17+
* You installed {oc-first}.
1818
1919
* Your account has cluster administration privileges.
2020
@@ -31,7 +31,6 @@ For this procedure, `user@microshift` is the user on the {microshift-short} host
3131

3232
* As `user@microshift`, verify that {microshift-short} is running by entering the following command:
3333
+
34-
[source,terminal]
35-
----
36-
[user@microshift]$ oc get all -A
37-
----
34+
--
35+
include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2]
36+
--

modules/microshift-accessing-cluster-remotely.adoc

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,41 @@ The `user@workstation` login is used to access the host machine remotely. The `<
1414

1515
.Prerequisites
1616

17-
* You have installed the `oc` binary.
17+
* You installed {oc-first}.
1818
1919
* The `user@microshift` has opened the firewall from the local host.
2020
2121
.Procedure
2222

2323
. As `user@workstation`, create a `~/.kube/` folder if your {op-system-base-full} machine does not have one by running the following command:
2424
+
25-
[source,terminal,subs="attributes+"]
25+
[source,terminal]
2626
----
2727
[user@workstation]$ mkdir -p ~/.kube/
2828
----
2929

3030
. As `user@workstation`, set a variable for the hostname of your {microshift-short} host by running the following command:
3131
+
32-
[source,terminal,subs="attributes+"]
32+
[source,terminal,subs="+quotes"]
3333
----
34-
[user@workstation]$ MICROSHIFT_MACHINE=<name or IP address of {microshift-short} machine>
34+
[user@workstation]$ MICROSHIFT_MACHINE=_<microshift_hostname>_ # <1>
3535
----
36+
<1> Replace the value, _<{microshift-short}_hostname>_, with the either the name or the IP address of the host running {microshift}.
3637

3738
. As `user@workstation`, copy the generated `kubeconfig` file that contains the host name or IP address you want to connect with from the {op-system-base} machine running {microshift-short} to your local machine by running the following command:
3839
+
39-
[source,terminal]
40+
[source,terminal,subs="+quotes"]
4041
----
41-
[user@workstation]$ ssh <user>@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config
42+
[user@workstation]$ ssh _<user>_@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config # <1>
4243
----
44+
<1> Replace _<user>_ with your SSH login credentials.
4345
+
46+
--
4447
[NOTE]
4548
====
46-
To generate the `kubeconfig` files for this step, see link:https://access.redhat.com/documentation/en-us/red_hat_build_of_microshift/{product-version}/html/configuring/microshift-kubeconfig#generating-additional-kubeconfig-files_microshift-kubeconfig[Generating additional kubeconfig files for remote access].
49+
To generate the `kubeconfig` files for this step, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{product-version}/html/configuring/microshift-kubeconfig#generating-additional-kubeconfig-files_microshift-kubeconfig[Generating additional kubeconfig files for remote access].
4750
====
51+
--
4852

4953
. As `user@workstation`, update the permissions on your `~/.kube/config` file by running the following command:
5054
+
@@ -57,7 +61,6 @@ $ chmod go-r ~/.kube/config
5761

5862
* As `user@workstation`, verify that {microshift-short} is running by entering the following command:
5963
+
60-
[source,terminal]
61-
----
62-
[user@workstation]$ oc get all -A
63-
----
64+
--
65+
include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2]
66+
--

modules/microshift-embed-ostree-enable-eus-repos.adoc

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,50 +25,50 @@ include::snippets/microshift-unsupported-config-warn.adoc[leveloffset=+1]
2525
$ sudo mkdir -p /etc/osbuild-composer/repositories
2626
----
2727

28-
. Copy the `/usr/share/osbuild-composer/repositories/rhel-9.4.json` file into the `/etc/osbuild-composer/repositories` directory by running the following command:
28+
. Copy the `/usr/share/osbuild-composer/repositories/rhel-{op-system-version}.json` file into the `/etc/osbuild-composer/repositories` directory by running the following command:
2929
+
30-
[source,terminal]
30+
[source,terminal,subs="attributes+"]
3131
----
32-
$ sudo cp /usr/share/osbuild-composer/repositories/rhel-9.4.json /etc/osbuild-composer/repositories/rhel-9.4.json
32+
$ sudo cp /usr/share/osbuild-composer/repositories/rhel-{op-system-version}.json /etc/osbuild-composer/repositories/rhel-{op-system-version}.json
3333
----
3434

35-
. Update the `baseos` source by modifying the `/etc/osbuild-composer/repositories/rhel-9.4.json` file with the following values:
35+
. Update the `baseos` source by modifying the `/etc/osbuild-composer/repositories/rhel-{op-system-version}.json` file with the following values:
3636
+
37-
[source,terminal]
37+
[source,terminal,subs="attributes+"]
3838
----
3939
# ...
40-
"baseurl": "https://cdn.redhat.com/content/eus/rhel<9>/<9.4>//baseos/os", # <1>
40+
"baseurl": "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}//baseos/os", # <1>
4141
# ...
4242
----
43-
<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
43+
<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
4444

45-
. Optional. Apply the `baseos` update by running the following command:
45+
. Optional: Apply the `baseos` update by running the following command:
4646
+
47-
[source,terminal]
47+
[source,terminal,subs="attributes+"]
4848
----
49-
$ sudo sed -i "s,dist/rhel<9>/<9.4>/$(uname -m)/baseos/,eus/rhel<9>/<9.4>/$(uname -m)/baseos/,g" \
50-
/etc/osbuild-composer/repositories/rhel-<9.4>.json # <1>
49+
$ sudo sed -i "s,dist/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/baseos/,eus/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/baseos/,g" \
50+
/etc/osbuild-composer/repositories/rhel-{op-system-version}.json # <1>
5151
----
52-
<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
52+
<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
5353

5454
. Update the `appstream` source by modifying the `/etc/osbuild-composer/repositories/rhel-<major.minor>.json` file with the following values:
5555
+
56-
[source,terminal]
56+
[source,terminal,subs="attributes+"]
5757
----
5858
# ...
59-
"baseurl": "https://cdn.redhat.com/content/eus/rhel<9>/<9.4>//appstream/os", # <1>
59+
"baseurl": "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}//appstream/os", # <1>
6060
# ...
6161
----
62-
<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
62+
<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
6363

6464
. Optional. Apply the `appstream` update by running the following command:
6565
+
66-
[source,terminal]
66+
[source,terminal,subs="attributes+"]
6767
----
68-
$ sudo sed -i "s,dist/rhel<9>/<9.4>/$(uname -m)/appstream/,eus/rhel<9>/<9.4>/$(uname -m)/appstream/,g" \
69-
/etc/osbuild-composer/repositories/rhel-<9.4>.json # <1>
68+
$ sudo sed -i "s,dist/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/appstream/,eus/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/appstream/,g" \
69+
/etc/osbuild-composer/repositories/rhel-{op-system-version}.json # <1>
7070
----
71-
<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
71+
<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the _<major.minor>_ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using.
7272

7373
.Verification
7474

@@ -82,9 +82,9 @@ $ sudo composer-cli sources info baseos | grep 'url ='
8282
----
8383
.Example output
8484
+
85-
[source,text]
85+
[source,text,subs="attributes+"]
8686
----
87-
url = "https://cdn.redhat.com/content/eus/rhel9/9.4/x86_64/baseos/os"
87+
url = "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}/x86_64/baseos/os"
8888
----
8989

9090
. Verify the `appstream` source by running the following command:
@@ -95,7 +95,7 @@ $ sudo composer-cli sources info appstream | grep 'url ='
9595
----
9696
.Example output
9797
+
98-
[source,text]
98+
[source,text,subs="attributes+"]
9999
----
100-
url = "https://cdn.redhat.com/content/eus/rhel9/9.4/x86_64/appstream/os"
100+
url = "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}/x86_64/appstream/os"
101101
----

0 commit comments

Comments
 (0)