Skip to content

Commit c0f3566

Browse files
sr1kar99sr1kar99
committed
OCPBUGS-27913: Updated lvms installation procs
1 parent 471b0fa commit c0f3566

7 files changed

+136
-51
lines changed

‎modules/lvms-about-lvm-storage-installation.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Module included in the following assemblies:
2+
//
3+
// storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="lvms-about-lvm-storage-installation_{context}"]
7+
= Installing Logical Volume Manager Storage
8+
9+
You can install Logical Volume Manager (LVM) Storage on a bare metal or user-provisioned infrastructure cluster and configure it to dynamically provision storage for your workloads.
10+
11+
You can install {lvms} by using the {product-title} CLI (`oc`), {product-title} web console, or {rh-rhacm-first}.
12+
13+
[WARNING]
14+
====
15+
When using {lvms} on multi-node clusters, {lvms} only supports provisioning local storage. {lvms} does not support storage data replication mechanisms across nodes. You must ensure storage data replication through active or passive replication mechanisms to avoid a single point of failure.
16+
====
17+
18+
[id="lvms-deployment-requirements-for-sno-ran_{context}"]
19+
== Prerequisites to install LVM Storage
20+
21+
The prerequisites to install {lvms} are as follows:
22+
23+
* Before deploying {lvms}, ensure that every managed cluster has dedicated disks that are used to provision storage.
24+
25+
* Before deploying {lvms} in a private CI environment where you can reuse the storage devices that you configured in the previous {lvms} installation, ensure that you have wiped the disks that are not in use. If you do not wipe the disks before installing {lvms}, you cannot reuse the disks without manual intervention.
26+
+
27+
[NOTE]
28+
====
29+
You cannot wipe the disks that are in use.
30+
====
31+
32+
* If you want to install {lvms} by using {rh-rhacm-first}, ensure that you have installed {rh-rhacm} on an {product-title} cluster. See the _Installing LVM Storage using RHACM_ section.

‎modules/lvms-installing-logical-volume-manager-operator-disconnected-environment.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="lvms-installing-lvms-disconnected-env_{context}"]
77
= Installing {lvms} in a disconnected environment
88

9-
You can install {lvms} on {product-title} {product-version} in a disconnected environment. All sections referenced in this procedure are linked in _Additional resources_.
9+
You can install {lvms} on {product-title} in a disconnected environment. All sections referenced in this procedure are linked in _Additional resources_.
1010

1111
.Prerequisites
1212

@@ -16,7 +16,7 @@ You can install {lvms} on {product-title} {product-version} in a disconnected en
1616
1717
.Procedure
1818

19-
. Follow the steps in the _Creating the image set configuration_ procedure. To create an `ImageSetConfiguration` resource for {lvms}, you can use the following example YAML file:
19+
. Follow the steps in the _Creating the image set configuration_ procedure. To create an `ImageSetConfiguration` custom resource (CR) for {lvms}, you can use the following example `ImageSetConfiguration` CR configuration:
2020
+
2121
include::snippets/lvms-disconnected-ImageSetConfig.adoc[]
2222

‎modules/lvms-installing-logical-volume-manager-operator-using-cli.adoc

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

55
:_mod-docs-content-type: PROCEDURE
66
[id="install-lvms-operator-cli_{context}"]
7-
= Installing {lvms} with the CLI
7+
= Installing {lvms} by using the CLI
88

9-
As a cluster administrator, you can install {lvms-first} by using the CLI.
9+
As a cluster administrator, you can install {lvms} by using the OpenShift CLI.
1010

1111
.Prerequisites
1212

1313
* You have installed the OpenShift CLI (`oc`).
14-
15-
* You have logged in as a user with `cluster-admin` privileges.
14+
* You have logged in to {product-title} as a user with `cluster-admin` and Operator installation permissions.
1615
1716
.Procedure
1817

19-
. Create a namespace for the {lvms} Operator.
20-
21-
.. Save the following YAML in the `lvms-namespace.yaml` file:
18+
. Create a YAML file with the configuration for creating a namespace:
2219
+
20+
.Example YAML configuration for creating a namespace
2321
[source,yaml]
2422
----
2523
apiVersion: v1
@@ -33,17 +31,16 @@ metadata:
3331
name: openshift-storage
3432
----
3533

36-
.. Create the `Namespace` CR:
34+
. Create the namespace by running the following command:
3735
+
3836
[source,terminal]
3937
----
40-
$ oc create -f lvms-namespace.yaml
41-
----
38+
$ oc create -f <file_name>
39+
----
4240

43-
. Create an Operator group for the {lvms} Operator.
44-
45-
.. Save the following YAML in the `lvms-operatorgroup.yaml` file:
41+
. Create an `OperatorGroup` CR YAML file:
4642
+
43+
.Example `OperatorGroup` CR
4744
[source,yaml]
4845
----
4946
apiVersion: operators.coreos.com/v1
@@ -56,17 +53,16 @@ spec:
5653
- openshift-storage
5754
----
5855

59-
.. Create the `OperatorGroup` CR:
56+
. Create the `OperatorGroup` CR by running the following command:
6057
+
6158
[source,terminal]
6259
----
63-
$ oc create -f lvms-operatorgroup.yaml
60+
$ oc create -f <file_name>
6461
----
6562

66-
. Subscribe to the {lvms} Operator.
67-
68-
.. Save the following YAML in the `lvms-sub.yaml` file:
63+
. Create a `Subscription` CR YAML file:
6964
+
65+
.Example `Subscription` CR
7066
[source,yaml]
7167
----
7268
apiVersion: operators.coreos.com/v1alpha1
@@ -81,14 +77,16 @@ spec:
8177
sourceNamespace: openshift-marketplace
8278
----
8379

84-
.. Create the `Subscription` CR:
80+
. Create the `Subscription` CR by running the following command:
8581
+
8682
[source,terminal]
8783
----
88-
$ oc create -f lvms-sub.yaml
84+
$ oc create -f <file_name>
8985
----
9086

91-
. To verify that the Operator is installed, enter the following command:
87+
.Verification
88+
89+
. To verify that {lvms} is installed, run the following command:
9290
+
9391
[source,terminal]
9492
----

‎modules/lvms-installing-logical-volume-manager-operator-using-openshift-web-console.adoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,35 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="lvms-installing-lvms-with-web-console_{context}"]
7-
= Installing {lvms} with the web console
7+
= Installing {lvms} by using the web console
88

9-
You can install {lvms-first} by using the Red Hat {product-title} OperatorHub.
9+
You can install {lvms} by using the {product-title} web console.
1010

1111
.Prerequisites
1212

1313
* You have access to the cluster.
14-
* You are using an account with the `cluster-admin` and Operator installation permissions.
14+
* You have access to {product-title} with `cluster-admin` and Operator installation permissions.
1515
1616
.Procedure
1717

18-
. Log in to the {product-title} Web Console.
18+
. Log in to the {product-title} web console.
1919
. Click *Operators -> OperatorHub*.
20-
. Scroll or type `LVM Storage` into the *Filter by keyword* box to find {lvms}.
21-
. Click *Install*.
22-
. Set the following options on the *Install Operator* page:
20+
. Click *LVM Storage* on the *OperatorHub* page.
21+
. Set the following options on the *Operator Installation* page:
2322
.. *Update Channel* as *stable-{product-version}*.
2423
.. *Installation Mode* as *A specific namespace on the cluster*.
2524
.. *Installed Namespace* as *Operator recommended namespace openshift-storage*.
2625
If the `openshift-storage` namespace does not exist, it is created during the operator installation.
27-
.. *Approval Strategy* as *Automatic* or *Manual*.
28-
+
29-
If you select *Automatic* updates, then the Operator Lifecycle Manager (OLM) automatically updates the running instance of your Operator without any intervention.
26+
.. *Update approval* as *Automatic* or *Manual*.
3027
+
31-
If you select *Manual* updates, then the OLM creates an update request.
32-
As a cluster administrator, you must then manually approve that update request to update the Operator to a newer version.
33-
28+
[NOTE]
29+
====
30+
If you select *Automatic* updates, the Operator Lifecycle Manager (OLM) automatically updates the running instance of {lvms} without any intervention.
31+
32+
If you select *Manual* updates, the OLM creates an update request.
33+
As a cluster administrator, you must manually approve the update request to update {lvms} to a newer version.
34+
====
35+
. Optional: Select the *Enable Operator recommended cluster monitoring on this Namespace* checkbox.
3436
. Click *Install*.
3537

3638
.Verification steps

‎modules/lvms-limitations-to-configure-size-of-devices.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Module included in the following assemblies:
2+
//
3+
// storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="limitations-to-configure-size-of-devices_{context}"]
7+
= Limitations to configure the size of the devices to be used in LVM Storage
8+
9+
The limitations to configure the size of the devices that you can use to provision storage using {lvms} are as follows:
10+
11+
* The total storage size that you can provision is limited by the size of the underlying Logical Volume Manager (LVM) thin pool and the over-provisioning factor.
12+
* The size of the logical volume depends on the size of the Physical Extent (PE) and the Logical Extent (LE).
13+
** You can define the size of PE and LE during the physical and logical device creation.
14+
** The default PE and LE size is 4 MB.
15+
** If the size of the PE is increased, the maximum size of the LVM is determined by the kernel limits and your disk space.
16+
17+
.Size limits for different architectures using the default PE and LE size
18+
[cols="1,1,1,1,1", width="100%", options="header"]
19+
|====
20+
|Architecture
21+
|RHEL 6
22+
|RHEL 7
23+
|RHEL 8
24+
|RHEL 9
25+
26+
|32-bit
27+
|16 TB
28+
|-
29+
|-
30+
|-
31+
32+
|64-bit
33+
34+
|8 EB ^[1]^
35+
36+
100 TB ^[2]^
37+
|8 EB ^[1]^
38+
39+
500 TB ^[2]^
40+
|8 EB
41+
|8 EB
42+
43+
|====
44+
[.small]
45+
--
46+
1. Theoretical size.
47+
2. Tested size.
48+
--

‎snippets/lvms-disconnected-ImageSetConfig.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_mod-docs-content-type: SNIPPET
2-
.Example ImageSetConfiguration file for {lvms}
2+
.Example `ImageSetConfiguration` CR for {lvms}
33
[source,yaml,subs="attributes+"]
44
----
55
kind: ImageSetConfiguration
@@ -25,12 +25,12 @@ mirror:
2525
- name: registry.redhat.io/ubi9/ubi:latest <9>
2626
helm: {}
2727
----
28-
<1> Add `archiveSize` to set the maximum size, in GiB, of each file within the image set.
29-
<2> Set the back-end location to save the image set metadata to. This location can be a registry or local directory. It is required to specify `storageConfig` values, unless you are using the Technology Preview OCI feature.
30-
<3> Set the registry URL for the storage backend.
31-
<4> Set the channel to retrieve the {product-title} images from.
32-
<5> Add `graph: true` to generate the OpenShift Update Service (OSUS) graph image to allow for an improved cluster update experience when using the web console. For more information, see _About the OpenShift Update Service_.
33-
<6> Set the Operator catalog to retrieve the {product-title} images from.
34-
<7> Specify only certain Operator packages to include in the image set. Remove this field to retrieve all packages in the catalog.
35-
<8> Specify only certain channels of the Operator packages to include in the image set. You must always include the default channel for the Operator package even if you do not use the bundles in that channel. You can find the default channel by running the following command: `oc mirror list operators --catalog=<catalog_name> --package=<package_name>`.
36-
<9> Specify any additional images to include in image set.
28+
<1> Set the the maximum size (in GiB) of each file within the image set.
29+
<2> Specify the location in which you want to save the image set. This location can be a registry or a local directory. You must configure the `storageConfig` field unless you are using the Technology Preview OCI feature.
30+
<3> Specify the storage URL for the image stream when using a registry. For more information, see _Why use imagestreams_.
31+
<4> Specify the channel from which you want to retrieve the {product-title} images.
32+
<5> Set this field to `true` to generate the OpenShift Update Service (OSUS) graph image. For more information, see _About the OpenShift Update Service_.
33+
<6> Specify the Operator catalog from which you want to retrieve the {product-title} images.
34+
<7> Specify the Operator packages to include in the image set. If this field is empty, all packages in the catalog are retrieved.
35+
<8> Specify the channels of the Operator packages to include in the image set. You must include the default channel for the Operator package even if you do not use the bundles in that channel. You can find the default channel by running the following command: `$ oc mirror list operators --catalog=<catalog_name> --package=<package_name>`.
36+
<9> Specify any additional images to include in the image set.

‎storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="persistent-storage-using-lvms"]
3-
= Persistent storage using logical volume manager storage
3+
= Persistent storage using Logical Volume Manager Storage
44
include::_attributes/common-attributes.adoc[]
55
:context: logical-volume-manager-storage
66

77
toc::[]
88

9-
{lvms-first} uses the TopoLVM CSI driver to dynamically provision local storage on the clusters.
9+
Logical Volume Manager Storage uses the TopoLVM CSI driver to dynamically provision local storage on the {product-title} clusters.
1010

1111
{lvms} creates thin-provisioned volumes using Logical Volume Manager and provides dynamic provisioning of block storage on a limited resources cluster.
1212

13+
You can create volume groups, persistent volume claims (PVCs), volume snapshots, and volume clones by using {lvms}.
14+
1315
//deploying/requirements with RHACM
14-
include::modules/deploying-lvms-on-sno-cluster.adoc[leveloffset=+1]
16+
include::modules/lvms-about-lvm-storage-installation.adoc[leveloffset=+1]
1517

1618
[role="_additional-resources"]
1719
.Additional resources
@@ -39,13 +41,16 @@ include::modules/lvms-installing-logical-volume-manager-operator-disconnected-en
3941
4042
* xref:../../../openshift_images/image-configuration.adoc#images-configuration-registry-mirror_image-configuration[Configuring image registry repository mirroring]
4143
44+
* xref:../../../openshift_images/image-streams-manage.adoc#images-imagestream-use_image-configuration[Why use imagestreams]
45+
4246
include::modules/lvms-installing-logical-volume-manager-operator-using-rhacm.adoc[leveloffset=+2]
4347

4448
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html/install/installing#installing-while-connected-online[Red Hat Advanced Cluster Management for Kubernetes: Installing while connected online]
4549
4650
* xref:../../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#about-lvmcluster_logical-volume-manager-storage[About the LVMCluster custom resource]
4751
48-
// Creating an LVMCluster custom resource
52+
// Limitations to configure the size of the devices to be used in LVM Storage
53+
include::modules/lvms-limitations-to-configure-size-of-devices.adoc[leveloffset=+1]
4954

5055
include::modules/lvms-about-lvmcluster-cr.adoc[leveloffset=+1]
5156

@@ -115,7 +120,7 @@ include::modules/lvms-scaling-storage-of-single-node-openshift-cluster-using-rha
115120
[role="_additional-resources"]
116121
.Additional resources
117122

118-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html/install/installing#installing-while-connected-online[Red Hat Advanced Cluster Management for Kubernetes: Installing while connected online]
123+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.6/html/install/installing#installing-while-connected-online[Red Hat Advanced Cluster Management for Kubernetes: Installing while connected online]
119124
120125
* xref:../../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#about-lvmcluster_logical-volume-manager-storage[About the `LVMCluster` custom resource]
121126

0 commit comments

Comments
 (0)