Skip to content

Commit 8d7c1b9

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #75722 from ShaunaDiaz/OSDOCS-10281
OSDOCS-10281: MicroShift-adding optional services to blueprint
2 parents 32eef10 + 2d53875 commit 8d7c1b9

10 files changed

+98
-68
lines changed

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

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,33 @@ include::modules/microshift-adding-repos-to-image-builder.adoc[leveloffset=+1]
3131

3232
include::modules/microshift-adding-service-to-blueprint.adoc[leveloffset=+1]
3333

34-
include::modules/microshift-adding-olm-to-blueprint.adoc[leveloffset=+1]
34+
include::modules/microshift-adding-other-packages-to-blueprint.adoc[leveloffset=+1]
3535

3636
[role="_additional-resources"]
3737
.Additional resources
38-
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
39-
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc[Applying updates on an OSTree system]
38+
* link:https://osbuild.org/docs/user-guide/blueprint-reference[Blueprint Reference]
39+
* 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]
40+
* link:https://osbuild.org/docs/on-premises/commandline/building-ostree-images[Building OSTree image]
41+
* link:https://podman.io/docs/installation[Installing Podman]
4042

4143
include::modules/microshift-ca-adding-bundle.adoc[leveloffset=+1]
4244

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

4547
[role="_additional-resources"]
4648
.Additional resources
47-
4849
* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
4950
* 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)]
5051
* 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)]
52+
* 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]
53+
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc#microshift-update-rpms-ostree[Applying updates on an OSTree system]
5154

5255
include::modules/microshift-creating-ostree-iso.adoc[leveloffset=+1]
5356

5457
include::modules/microshift-add-blueprint-build-iso.adoc[leveloffset=+1]
5558

5659
include::modules/microshift-download-iso-prep-for-use.adoc[leveloffset=+1]
5760

58-
[role="_additional-resources"]
59-
.Additional resources
60-
61-
* 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]
62-
* 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]
63-
* link:https://osbuild.org/docs/on-premises/commandline/building-ostree-images[Building OSTree image]
64-
* link:https://osbuild.org/docs/user-guide/blueprint-reference[Blueprint Reference]
65-
* link:https://podman.io/docs/installation[Installing podman]
66-
6761
include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1]
6862

6963
[role="_additional-resources"]

‎microshift_install/microshift-install-rpm.adoc

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can install {microshift-short} from an RPM package on a machine with a suppo
1010

1111
include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]
1212

13-
[id="install-rpm-rhde-compatibility-table"]
13+
[id="microshift-install-rpm-rhde-compatibility-table"]
1414
== Compatibility table
1515

1616
Plan to pair a supported version of {op-system-ostree} with the {microshift-short} version you are using as described in the following compatibility table:
@@ -37,24 +37,42 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
3737

3838
include::modules/microshift-install-rpms.adoc[leveloffset=+1]
3939

40-
include::modules/microshift-install-rpms-olm.adoc[leveloffset=+1]
40+
[id="microshift-install-rpm-add-ons"]
41+
== Installing optional packages
4142

42-
//additional resources for install rpms modules
43+
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.
44+
45+
include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2]
46+
47+
//additional resources for installing OLM
4348
[role="_additional-resources"]
4449
.Additional resources
45-
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing MicroShift]
46-
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm-preparing_microshift-install-rpm[Preparing to install MicroShift from an RPM package]
4750
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
4851

49-
include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+1]
52+
include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+2]
53+
54+
//additional resources for installing GitOps
55+
[role="_additional-resources"]
56+
.Additional resources
57+
* xref:../microshift_running_apps/microshift-gitops.adoc#microshift-gitops[Automating application management with the GitOps controller]
58+
59+
include::modules/microshift-install-multus-rpm.adoc[leveloffset=+2]
60+
61+
//additional resources for installing Multus
62+
[role="_additional-resources"]
63+
.Additional resources
64+
* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
65+
66+
[id="microshift-starting-and-stopping"]
67+
== Starting and stopping {microshift-short}
5068

51-
include::modules/microshift-install-multus-rpm.adoc[leveloffset=+1]
69+
After installing all of the RPM packages you need, learn to start and stop the {microshift-short} service.
5270

53-
include::modules/microshift-service-starting.adoc[leveloffset=+1]
71+
include::modules/microshift-service-starting.adoc[leveloffset=+2]
5472

55-
include::modules/microshift-service-stopping.adoc[leveloffset=+1]
73+
include::modules/microshift-service-stopping.adoc[leveloffset=+2]
5674

57-
include::modules/microshift-accessing.adoc[leveloffset=+1]
75+
include::modules/microshift-accessing.adoc[leveloffset=+2]
5876

5977
//additional resources for accessing module
6078
[role="_additional-resources"]

‎microshift_updating/microshift-update-rpms-ostree.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-update-rpms-ostree"]
3-
= About updating {product-title} RPMs on an OSTree system
3+
= Updating RPMs on an OSTree system
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-update-rpms-ostree
66

77
toc::[]
88

9-
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.
9+
Updating {microshift-short} on an `rpm-ostree` system such as {op-system-ostree-first} requires building a new {op-system-ostree} image containing the new version of {microshift-short} and any associated optional RPMs. After you have the `rpm-ostree` image with {microshift-short} embedded, direct your system to boot into that operating system image.
1010

1111
The procedures are the same for minor-version and patch updates. For example, use the same steps to upgrade from 4.14 to 4.16 or from 4.16.0 to 4.16.1.
1212

‎modules/microshift-accessing-cluster-remotely.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[id="accessing-microshift-cluster-remotely_{context}"]
99
= Accessing the {microshift-short} cluster remotely
1010

11-
Use the following procedure to access the {microshift-short} cluster from a remote workstation by using a `kubeconfig` file.
11+
Use the following procedure to access the {microshift-short} cluster from a remote location by using a `kubeconfig` file.
1212

1313
The `user@workstation` login is used to access the host machine remotely. The `<user>` value in the procedure is the name of the user that `user@workstation` logs in with to the {microshift-short} host.
1414

@@ -40,10 +40,10 @@ The `user@workstation` login is used to access the host machine remotely. The `<
4040
----
4141
[user@workstation]$ ssh <user>@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config
4242
----
43-
43+
+
4444
[NOTE]
4545
====
46-
To generate `kubeconfig` files for this step, see the "Generating additional kubeconfig files for remote access" link in the additional resources section.
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].
4747
====
4848

4949
. As `user@workstation`, update the permissions on your `~/.kube/config` file by running the following command:

‎modules/microshift-accessing.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@
77
[id="accessing-microshift-cluster_{context}"]
88
= How to access the {microshift-short} cluster
99

10-
Use the procedures in this section to access the {microshift-short} cluster, either from the same machine running the {microshift-short} service or remotely from a workstation. You can use this access to observe and administrate workloads. When using these steps, choose the `kubeconfig` file that contains the host name or IP address you want to connect with and place it in the relevant directory. As listed in each procedure, you use the {OCP} CLI tool (`oc`) for cluster activities.
10+
Use the procedures in this section to access the {microshift-short} cluster by using the {oc-first}.
11+
12+
* You can access the cluster from either the same machine running the {microshift-short} service or from a remote location.
13+
* You can use this access to observe and administrate workloads.
14+
* When using the following steps, choose the `kubeconfig` file that contains the host name or IP address you want to connect to and place it in the relevant directory.

‎modules/microshift-adding-olm-to-blueprint.adoc

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎modules/microshift-adding-other-packages-to-blueprint.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift/microshift-update-rpms-ostree.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-adding-other-services-to-blueprint_{context}"]
7+
= Adding other packages to a blueprint
8+
9+
Add the references for optional RPM packages to your OSTree blueprint to enable them.
10+
11+
.Prerequisites
12+
13+
* You created an Image Builder blueprint file.
14+
15+
.Procedure
16+
17+
. Edit your OSTree blueprint by running the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ vi <microshift_blueprint.toml> <1>
22+
----
23+
<1> Replace _<microshift_blueprint.toml>_ with the name of the blueprint file used for the {microshift-short} service.
24+
25+
. Add the following example text to your blueprint:
26+
+
27+
[source,text]
28+
----
29+
[[packages]] <1>
30+
name = "<microshift-additional-package-name>" <2>
31+
version = "*"
32+
----
33+
<1> Include one stanza for each additional service that you want to add.
34+
<2> Replace _<microshift-additional-package-name>_ with the name the RPM for the service you want to include. For example, `microshift-olm`.
35+
36+
.Next steps
37+
. Add custom certificate authorities to the blueprint as needed.
38+
. After you are done adding to your blueprint, you can apply the manifests to an active cluster by building a new OSTree system and deploying it on the client:
39+
** Create the ISO.
40+
** Add the blueprint and build the ISO.
41+
** Download the ISO and prepare it for use.
42+
** Do any provisioning that is needed.

‎modules/microshift-install-multus-rpm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-installing-multus_{context}"]
7-
== Installing the multiple networks plugin
7+
= Installing the multiple networks plugin
88

99
Use this procedure to install the {microshift-short} Multus CNI plugin alongside a new {microshift-short} installation. The {microshift-short} Multus Container Network Interface (CNI) plugin is not installed by default. If you want to attach additional networks to a pod for high-performance network configurations, install the `microshift-multus` RPM package.
1010

‎modules/microshift-install-rpms-gitops.adoc

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

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-installing-rpms-for-gitops_{context}"]
7-
== Installing the GitOps Argo CD manifests from an RPM package
7+
= Installing the GitOps Argo CD manifests from an RPM package
88

9-
You can use a lightweight version of the OpenShift GitOps with {microshift-short} to help manage your applications. Install the necessary Argo CD manifests using an RPM package. This RPM package included the necessary manifests that runs core Argo CD.
9+
You can use a lightweight version of OpenShift GitOps with {microshift-short} to help manage your applications. Install the necessary Argo CD manifests using an RPM package. This RPM package included the necessary manifests that runs core Argo CD.
1010

1111
[IMPORTANT]
1212
====
13-
This process installs the basic GitOps functionalities, the Argo CD CLI is not currently available on {microshift-short}.
13+
This process installs the basic GitOps functionalities. The Argo CD CLI is not available on {microshift-short}.
1414
====
1515

1616
.Prerequisites
1717

1818
* You installed {microshift-short} version 4.14 or higher
19-
* Additional RAM storage of 250MB recommended
19+
* Additional RAM storage of 250MB recommended
2020
2121
.Procedure
2222

@@ -27,21 +27,21 @@ This process installs the basic GitOps functionalities, the Argo CD CLI is not c
2727
$ sudo subscription-manager repos --enable=gitops-1.12-for-rhel-9-$(uname -m)-rpms
2828
----
2929

30-
. Install the GitOps package by running the following command:
30+
. Install the GitOps package by running the following command:
3131
+
3232
[source,terminal]
3333
----
34-
$ sudo dnf install -y microshift-gitops
34+
$ sudo dnf install -y microshift-gitops
3535
----
3636

37-
. To deploy Argo CD pods, restart the {microshift-short} service by running the following command:
37+
. To deploy Argo CD pods, restart the {microshift-short} service by running the following command:
3838
+
3939
[source,terminal]
4040
----
4141
$ sudo systemctl restart microshift
4242
----
4343

44-
.Verification
44+
.Verification
4545

4646
* You can verify that your pods are running properly by running the following command:
4747
+
@@ -50,7 +50,7 @@ $ sudo systemctl restart microshift
5050
$ oc get pods -n openshift-gitops
5151
----
5252
+
53-
.Example output
53+
.Example output
5454
[source,terminal]
5555
----
5656
NAME READY STATUS RESTARTS AGE

‎modules/microshift-install-rpms-olm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-installing-with-olm-from-rpm-package_{context}"]
7-
== Installing the Operator Lifecycle Manager (OLM) from an RPM package
7+
= Installing the Operator Lifecycle Manager (OLM) from an RPM package
88

99
When you install {microshift-short}, the Operator Lifecycle Manager (OLM) package is not installed by default. You can install the OLM on your {microshift-short} instance using an RPM package.
1010

0 commit comments

Comments
 (0)