Skip to content

Commit c17604e

Browse files
amolnar-rhamolnar-rh
committed
TELCODOCS-1077: Add LVM Storage in far edge content
1 parent 50a4600 commit c17604e

File tree

6 files changed

+187
-0
lines changed

6 files changed

+187
-0
lines changed

‎modules/ztp-lvms-installing-lvms-cli.adoc

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
// Module included in the following assemblies:
2+
//
3+
// scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="ztp-lvms-installing-using-cli_{context}"]
7+
= Installing {lvms} by using the CLI
8+
9+
You can use the OpenShift CLI (`oc`) to install {lvms}.
10+
11+
.Prerequisites
12+
13+
* Install the OpenShift CLI (`oc`).
14+
* Install the latest version of the {rh-rhacm} Operator.
15+
* Log in as a user with `cluster-admin` privileges.
16+
17+
.Procedure
18+
19+
. Create the `openshift-storage` namespace by running the following command:
20+
+
21+
[source,terminal]
22+
----
23+
$ oc create ns openshift-storage
24+
----
25+
26+
. Create an `OperatorGroup` CR.
27+
28+
.. Define the `OperatorGroup` CR and save the YAML file, for example, `lmvs-operatorgroup.yaml`:
29+
+
30+
.Example OperatorGroup CR
31+
[source,yaml]
32+
----
33+
apiVersion: operators.coreos.com/v1
34+
kind: OperatorGroup
35+
metadata:
36+
name: lvms-operator-operatorgroup
37+
namespace: openshift-storage
38+
annotations:
39+
ran.openshift.io/ztp-deploy-wave: "2"
40+
spec:
41+
targetNamespaces:
42+
- openshift-storage
43+
----
44+
45+
.. Create the `OperatorGroup` CR by running the following command:
46+
+
47+
[source,terminal]
48+
----
49+
$ oc create -f lmvs-operatorgroup.yaml
50+
----
51+
52+
. Create a `Subscription` CR.
53+
54+
.. Define the `Subscription` CR and save the YAML file, for example, `lvms-subscription.yaml`:
55+
+
56+
.Example Subscription CR
57+
[source,yaml,subs="attributes+"]
58+
----
59+
apiVersion: operators.coreos.com/v1alpha1
60+
kind: Subscription
61+
metadata:
62+
name: lvms-operator
63+
namespace: openshift-storage
64+
annotations:
65+
ran.openshift.io/ztp-deploy-wave: "2"
66+
spec:
67+
channel: "stable-{product-version}"
68+
name: lvms-operator
69+
source: redhat-operators
70+
sourceNamespace: openshift-marketplace
71+
installPlanApproval: Manual
72+
----
73+
74+
.. Create the `Subscription` CR by running the following command:
75+
+
76+
[source,terminal]
77+
----
78+
$ oc create -f lvms-subscription.yaml
79+
----
80+
81+
.Verification
82+
83+
. Verify that the installation succeeded by inspecting the CSV resource:
84+
+
85+
[source,terminal]
86+
----
87+
$ oc get csv -n openshift-storage
88+
----
89+
+
90+
.Example output
91+
[source,terminal,subs="attributes+"]
92+
----
93+
NAME DISPLAY VERSION REPLACES PHASE
94+
lvms-operator.{product-version}.x LVM Storage {product-version}x Succeeded
95+
----
96+
97+
. Verify that {lvms} is up and running:
98+
+
99+
[source,terminal]
100+
----
101+
$ oc get deploy -n openshift-storage
102+
----
103+
+
104+
.Example output
105+
[source,terminal]
106+
----
107+
NAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE
108+
openshift-storage lvms-operator 1/1 1 1 14s
109+
----

‎modules/ztp-lvms-installing-lvms-web-console.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="ztp-lvms-installing-using-web-console_{context}"]
7+
= Installing {lvms} by using the web console
8+
9+
You can use the {product-title} web console to install {lvms-first}.
10+
11+
.Prerequisites
12+
13+
* Install the latest version of the {rh-rhacm} Operator.
14+
* Log in as a user with `cluster-admin` privileges.
15+
16+
.Procedure
17+
18+
. In the {product-title} web console, navigate to *Operators* -> *OperatorHub*.
19+
. Search for the *{lvms}* from the list of available Operators, and then click *Install*.
20+
. Keep the default selection of *Installation mode* (*"All namespaces on the cluster (default)"*) and *Installed Namespace* (*"openshift-operators"*) to ensure that the Operator is installed properly.
21+
. Click *Install*.
22+
23+
.Verification
24+
25+
. To confirm that the installation is successful:
26+
27+
.. Navigate to the *Operators* -> *Installed Operators* page.
28+
.. Check that the Operator is installed in the `All Namespaces` namespace and its status is `Succeeded`.
29+
30+
. If the Operator is not installed successfully:
31+
32+
.. Navigate to the *Operators* -> *Installed Operators* page and inspect the `Status` column for any errors or failures.
33+
.. Navigate to the *Workloads* -> *Pods* page and check the logs in any containers in the `local-storage-operator` pod that are reporting issues.

‎modules/ztp-sno-du-configuring-lvms.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="lvms-configuring-lvms-on-sno_{context}"]
7+
= {lvms}
8+
9+
You can dynamically provision local storage on {sno} clusters with {lvms-first}.
10+
The following YAML example configures the storage of the node to be available to {product-title} applications.
11+
12+
include::snippets/ztp-storage-lvms.adoc[]

‎scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,13 @@ include::modules/ztp-checking-the-managed-cluster-status.adoc[leveloffset=+1]
4242

4343
include::modules/ztp-troubleshooting-the-managed-cluster.adoc[leveloffset=+1]
4444

45+
include::modules/ztp-lvms-installing-lvms-web-console.adoc[leveloffset=+1]
46+
47+
[role="_additional-resources"]
48+
.Additional resources
49+
50+
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#lvms-preface-sno-ran_logical-volume-manager-storage[Deploying LVM Storage on single-node OpenShift clusters]
51+
52+
include::modules/ztp-lvms-installing-lvms-cli.adoc[leveloffset=+1]
53+
4554
include::modules/ztp-installation-crs.adoc[leveloffset=+1]

‎scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ include::modules/ztp-sno-du-removing-the-console-operator.adoc[leveloffset=+2]
8080

8181
include::modules/ztp-sno-du-reducing-resource-usage-with-cluster-monitoring.adoc[leveloffset=+2]
8282

83+
include::modules/ztp-sno-du-configuring-lvms.adoc[leveloffset=+2]
84+
8385
include::modules/ztp-sno-du-disabling-network-diagnostics.adoc[leveloffset=+2]
8486

8587
[role="_additional-resources"]

‎snippets/ztp-storage-lvms.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:_content-type: SNIPPET
2+
.Recommended LVMCluster configuration
3+
[source,yaml]
4+
----
5+
apiVersion: lvm.topolvm.io/v1alpha1
6+
kind: LVMCluster
7+
metadata:
8+
name: odf-lvmcluster
9+
namespace: openshift-storage
10+
spec:
11+
storage:
12+
deviceClasses:
13+
- name: vg1
14+
deviceSelector: <1>
15+
paths:
16+
- /usr/disk/by-path/pci-0000:11:00.0-nvme-1
17+
thinPoolConfig:
18+
name: thin-pool-1
19+
overprovisionRatio: 10
20+
sizePercent: 90
21+
----
22+
<1> If no disks are specified in the `deviceSelector.paths` field, the {lvms} uses all the unused disks in the specified thin pool.

0 commit comments

Comments
 (0)