Skip to content

Commit 64d2856

Browse files
committed
OSDOCS-5821: making corrections to install from RHEL team review
1 parent db796c6 commit 64d2856

6 files changed

+24
-11
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ include::modules/microshift-adding-repos-to-image-builder.adoc[leveloffset=+1]
1818
* 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].
1919
* 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].
2020
21-
include::modules/microshift-adding-service-to-blueprint.adoc[leveloffset=+2]
21+
include::modules/microshift-adding-service-to-blueprint.adoc[leveloffset=+1]
2222

2323
[role="_additional-resources"]
2424
.Additional resources
2525

26-
* For further customizations such as adding users, firewall rules, or kernel arguments to a blueprint, refer to 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#image-customizations_composing-a-rhel-for-edge-image-using-image-builder-command-line[supported image customizations].
26+
* For more details on creating a blueprint, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/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#proc_creating-a-rhel-for-edge-container-image-blueprint-using-image-builder-cli_composing-a-rhel-for-edge-image-using-image-builder-command-line[creating a RHEL for Edge Container blueprint using image builder CLI].
27+
* For further customizations such as adding users, firewall rules, or kernel arguments to a blueprint, read 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#image-customizations_composing-a-rhel-for-edge-image-using-image-builder-command-line[supported image customizations].
28+
* For more about the composer cli, read https://www.osbuild.org/guides/user-guide/building-an-image-from-cli.html?highlight=push%20bluepring#blueprints-management-using-composer-cli[blueprint management using composer cli].
2729
2830
//include::modules/microshift-adding-containers-to-blueprint.adoc[leveloffset=+2]
2931
include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1]

modules/microshift-adding-repos-to-image-builder.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Use the following procedure to add the {product-title} repositories to Image Bui
1919
+
2020
[source,terminal,subs="attributes+"]
2121
----
22-
$ sudo subscription-manager repos
23-
--enable rhocp-{ocp-version}-for-{rhel-major}-$(uname -i)-rpms
22+
$ sudo subscription-manager repos \
23+
--enable rhocp-{ocp-version}-for-{rhel-major}-$(uname -i)-rpms \
2424
--enable fast-datapath-for-{rhel-major}-$(uname -i)-rpms
2525
----

modules/microshift-adding-service-to-blueprint.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: CONCEPT
66
[id="adding-{product-title}-service_{context}"]
7-
= Adding the {product-title} service
7+
= Example Image Builder blueprint with {product-title}
88

9-
Add the {product-title} RPM package to a blueprint and enable the {product-title} service to build an {op-system-ostree} image with {product-title}.
9+
Adding the {product-title} RPM package to an Image Builder blueprint enables the build of a {op-system-ostree} image with {product-title} embedded.
1010

1111
.Image Builder blueprint example
1212

modules/microshift-configuration.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,15 @@ etcd:
2626
.Verification
2727

2828
. After modifying the `memoryLimitMB` value in `/etc/microshift/config.yaml`, restart {product-title} by running the following command:
29+
+
30+
[source, terminal]
2931
----
3032
$ sudo systemctl restart microshift
3133
----
3234

3335
. Verify the new `memoryLimitMB` value is in use by running the following command:
36+
+
37+
[source, terminal]
3438
----
35-
$ systemctl status microshift
39+
$ systemctl show --property=MemoryHigh microshift-etcd.scope
3640
----

modules/microshift-install-rpms.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ $ sudo dnf install -y microshift
3838
$ sudo dnf install -y microshift-greenboot
3939
----
4040

41-
. Download your installation pull secret from the Red Hat Hybrid Cloud Console to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by {product-title}.
41+
. Download your installation pull secret from the https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console] to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by {product-title}.
4242

4343
. To copy the pull secret to the `/etc/crio` folder of your {op-system} machine, run the following command:
4444
+

modules/microshift-provisioning-ostree.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,26 @@
44

55
:_content-type: PROCEDURE
66
[id="provisioning-a-machine_{context}"]
7-
= Provisioning for {product-title}
7+
= Provisioning a machine for {product-title}
88

99
Provision a machine with your {op-system-ostree} image by using the procedures from the {op-system-ostree} documentation.
1010

1111
To use {product-title}, you must provision the system so that it meets the following requirements:
1212

1313
* The machine you are provisioning must meet the system requirements for installing {product-title}.
1414
* The file system must have a logical volume manager (LVM) volume group (VG) with sufficient capacity for the persistent volumes (PVs) of your workload.
15-
* A pull secret from the Red Hat Hybrid Cloud Console must be present as `/etc/crio/openshift-pull-secret` and have root user-only read/write permissions.
15+
* A pull secret from the https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console] must be present as `/etc/crio/openshift-pull-secret` and have root user-only read/write permissions.
1616
* The firewall must be configured with {product-title}'s required firewall settings.
1717
1818
[NOTE]
1919
====
20-
If you are using a Kickstart such as the {op-system-ostree} Installer (iso) image, you can update your Kickstart file to meet the above requirements.
20+
If you are using a Kickstart such as the {op-system-ostree} Installer (ISO) image, you can update your Kickstart file to meet the provisioning requirements.
2121
====
2222
2323
.Prerequisites
2424
2525
. You have created an {op-system-ostree} Installer (ISO) image containing your {op-system-ostree} commit with {product-title}.
26+
.. This requirement includes the steps of composing an RFE Container image, creating the RFE Installer blueprint, starting the RFE container, and composing the RFE Installer image.
2627
. Create a Kickstart file or use an existing one. In the Kickstart file, you must include:
2728
.. Detailed instructions about how to create a user.
2829
.. How to fetch and deploy the {op-system-ostree} image.
@@ -49,6 +50,8 @@ For more information, see "Additional resources."
4950
# └─sda2 8:2 0 19G 0 part
5051
# └─rhel-root 253:0 0 10G 0 lvm /sysroot
5152
#
53+
ostreesetup --nogpg --osname=rhel --remote=edge
54+
--url=file:///run/install/repo/ostree/repo --ref=rhel/<RHEL VERSION NUMBER>/x86_64/edge
5255
zerombr
5356
clearpart --all --initlabel
5457
part /boot/efi --fstype=efi --size=200
@@ -58,6 +61,10 @@ part /boot --fstype=xfs --asprimary --size=800
5861
part pv.01 --grow
5962
volgroup rhel pv.01
6063
logvol / --vgname=rhel --fstype=xfs --size=10000 --name=root
64+
# To add users, use a line such as the following
65+
user --name=user \
66+
--password=$6$HFVVV521NB4kOKVG$0.hM652uIOBNsC45kvFpMuRVkfNGHToMdQ6PDTU8DcEF30Gz/3DUwW153Gc9EvNMkH50qYfBO5os/FJsXTLLt. \
67+
--iscrypted --groups=wheel
6168
----
6269
6370
. In the `%post` section of the Kickstart file, add your pull secret and the mandatory firewall rules.

0 commit comments

Comments
 (0)