Skip to content

Commit 7e96c54

Browse files
MirzWeissMirzWeiss
committed
CNV-57758: Document virtualization with IBM fusion access for SAN
 # CNV-57758: Documented secret creation, still need verification step # CNV-57758: Added new module for creating the extension machineconfig file needed to add kernel-devel to worker nodes # CNV-57758: fixed formatting issue and added text at beginning of procedure # CNV-57758: vale nits # CNV-57758: mnore nits # CNV-57758: About section written # CNV-57758: About section written # CNV-57758: added registry prereq to operator installation procedure
1 parent 64a5b22 commit 7e96c54

15 files changed

+346
-1
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ endif::[]
119119
:CNVOperatorDisplayName: OpenShift Virtualization Operator
120120
:CNVSubscriptionSpecSource: redhat-operators
121121
:CNVSubscriptionSpecName: kubevirt-hyperconverged
122-
:IBMFusionSAN: IBM Fusion Access for SAN
122+
:IBMFusionFirst: IBM Fusion Access for SAN
123+
:FusionSAN: Fusion Access for SAN
123124
:delete: image:delete.png[title="Delete"]
124125
ifdef::openshift-origin[]
125126
:VirtProductName: OKD Virtualization

‎_topic_maps/_topic_map.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4700,6 +4700,13 @@ Topics:
47004700
File: virt-configuring-higher-vm-workload-density
47014701
- Name: Configuring certificate rotation
47024702
File: virt-configuring-certificate-rotation
4703+
- Name: Virtualization with IBM Fusion Access for SAN
4704+
Dir: fusion_access_SAN
4705+
Topics:
4706+
- Name: IBM Fusion Access for SAN overview
4707+
File: fusion-access-san-overview
4708+
- Name: Install and configure IBM Fusion Access for SAN
4709+
File: install-configure-fusion-access-san
47034710
- Name: Updating
47044711
Dir: updating
47054712
Topics:

‎modules/virt-about-fusion-access-san.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/about-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="about-fusion-access-san_{context}"]
7+
= About {IBMFusionFirst}
8+
9+
{IBMFusionFirst} is a solution that provides a scalable clustered file system for enterprise storage, primarily designed to offer access to consolidated, block-level data storage. It presents storage devices, such as disk arrays, to the operating system as if they were direct-attached storage.
10+
11+
This solution is particularly geared towards enterprise storage for Red Hat {VirtProductName} and leverages existing Storage Area Network (SAN) infrastructure. A SAN is a dedicated network of storage devices that is typically not accessible through the local area network (LAN).
12+
13+
[id="why-use-fusion-san_{context}"]
14+
== Why use {FusionSAN}?
15+
16+
Easy user experience:: {FusionSAN} features a wizard-driven user interface (UI) for installing and configuring storage clusters, file systems, and storage classes, to simplify the setup process.
17+
18+
Leverage existing infrastructure:: Organizations can leverage their existing SAN investments, including Fibre Channel (FC) and iSCSI technologies, as they transition to or expand with {VirtProductName}.
19+
20+
Scalability:: The storage cluster is designed to scale with {product-title} clusters and virtual machine (VM) workloads. It can support up to approximately 3000 VMs on 6 bare-metal hosts, with possibilities for further scaling by adding more file systems or using specific storage class parameters.
21+
22+
Consolidated and shared storage:: SANs enable multiple servers to access a large, shared data storage capacity. This architecture facilitates automatic data backup and continuous monitoring of the storage and backup processes.
23+
24+
High-speed data transfer:: By using a dedicated high-speed network for storage, {FusionSAN} overcomes the data transfer bottlenecks that can occur over a traditional LAN, especially for large volumes of data.
25+
26+
File-level access:: Although a SAN primarily operates at the block level, file systems built on top of SAN storage can provide file-level access through shared-disk file systems.
27+
28+
Centralized management:: The underlying SAN software manages servers, storage devices, and the network to ensure that data moves directly between storage devices with minimal server intervention. It also supports centralized management and configuration of SAN components like Logical Unit Numbers (LUNs).

‎modules/virt-creating-filesystem-fusion-access-san.adoc

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="creating-filesystem-fusion-access-san_{context}"]
7+
= Creating a file system with {FusionSAN}
8+
9+
You need to create a file system to represent your required storage.
10+
11+
The file system is based on the storage available in the worker nodes you selected when creating the storage cluster.
12+
13+
.Prerequisites
14+
15+
* You created a {FusionSAN} storage cluster.
16+
17+
.Procedure
18+
19+
. In the {product-title} web console, navigate to *Storage* -> *{FusionSAN}*.
20+
21+
. In the *File systems* tab, click *Create file system*.
22+
23+
. Enter a *Name* for the new file system.
24+
25+
. Select the LUNs that you want to use as the storage volumes for your file system.
26+
27+
. Click *Create file system*.
28+
+
29+
The *{FusionSAN}* page reloads, and the new file system appears in the *File systems* tab.
30+
31+
.Next steps
32+
33+
Repeat this procedure for each file system that you want to create.
34+
35+
.Verification
36+
37+
. Watch the *Status* of the file system in the *File systems* tab until it is marked as *Healthy*.
38+
+
39+
[NOTE]
40+
====
41+
This may take several minutes.
42+
====
43+
44+
. Click on the *StorageClass* for the file system.
45+
46+
. In the *YAML* tab, verify the following:
47+
+
48+
.. The value in the `name` field is the name of the file system you created.
49+
.. The value in the `provisioner` field is `spectrumscale.csi.ibm.com`.
50+
.. The value in the `volBackendFs` field matches the name of the file system you created.
51+
+
52+
[source,yaml,subs="attributes+"]
53+
----
54+
kind: StorageClass
55+
apiVersion: storage.k8s.io/v1
56+
metadata:
57+
name: filesystem1
58+
uid: eb410309-a043-a89b-9bb05483872a
59+
resourceVersion: '87746'
60+
creationTimestamp: '2025-05-14T12:30:08Z'
61+
managedFields:
62+
provisioner: spectrumscale.csi.ibm.com
63+
parameters:
64+
volBackendFs: filesystem1
65+
reclaimPolicy: Delete
66+
allowVolumeExpansion: true
67+
volumeBindingMode: Immediate
68+
----

‎modules/virt-creating-fusionaccess-cr.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="creating-fusionaccess-cr_{context}"]
7+
= Creating the FusionAccess CR
8+
9+
After installing the {FusionSAN} Operator and creating a Kubernetes pull secret, you must create the `FusionAccess` custome resource (CR).
10+
11+
Creating the `FusionAccess` CR triggers the installation of the correct version of IBM Storage Scale and detects worker nodes with shared LUNs.
12+
13+
.Prerequisites
14+
15+
* You have access to the cluster as a user with the `cluster-admin` role.
16+
* You installed the {FusionSAN} Operator.
17+
* You created a Kubernetes pull secret.
18+
19+
.Procedure
20+
21+
. In the {product-title} web console, navigate to *Operators* -> *Installed Operators*.
22+
23+
. Click on the {FusionSAN} Operator you installed.
24+
25+
. In the *Fusion Access for SAN* page, select the *Fusion Access* tab.
26+
27+
. Click *Create FusionAccess*.
28+
29+
. On the *Create FusionAccess* page, enter the object *Name*.
30+
31+
. Optional: You can choose to add *Labels* if they are relevant.
32+
33+
. Select the *IBM Storage Scale Version* from the drop-down list.
34+
+
35+
This version is the same version that was used to install the {FusionSAN} Operator.
36+
37+
. Click *Create*.
38+
39+
.Verification
40+
41+
* In the *Fusion Access for SAN* Operator page, in the *Fusion Access* tab, verify that the created `FusionAccess` CR appears with the status *Ready*.

‎modules/virt-creating-pull-secret-fusion-san.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+
// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="creating-pull-secret-fusion-san_{context}"]
7+
= Creating a Kubernetes pull secret
8+
9+
After installing the {FusionSAN} Operator, you must create a Kubernetes secret object to hold the IBM entitlement key for pulling the required container images from the IBM container registry.
10+
11+
.Prerequisites
12+
13+
* You installed the `oc` CLI.
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
* You installed the {FusionSAN} Operator and created the `ibm-fusion-access` namespace in the process.
16+
17+
.Procedure
18+
19+
. Log in to the https://myibm.ibm.com/products-services/containerlibrary[*IBM Container software library*] with your {FusionSAN} *IBMid* and *password*.
20+
21+
. In the *IBM Container software library*, get the entitlement key:
22+
23+
.. If you do not have an entitlement key yet, click *Get entitlement key* or *Add new key*, and then click *Copy*.
24+
25+
.. If you already have an entitlement key, click *Copy*.
26+
27+
. Save the entitlement key in a safe place.
28+
29+
. Create the secret object by running the `oc create` command:
30+
+
31+
[source,terminal]
32+
----
33+
$ oc create secret -n ibm-fusion-access generic fusion-pullsecret \
34+
--from-literal=ibm-entitlement-key=<ibm-entitlement-key> <1>
35+
----
36+
<1> This is the entitlement key you copied in step 2 from the *IBM Container software library*.
37+
38+
.Verification
39+
40+
. In the {product-title} web console, navigate to *Workloads* -> *Secrets*.
41+
42+
. Find the `fusion-pullsecret` in the list.

‎modules/virt-creating-storage-cluster-fusion-access-san.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="creating-storage-cluster-fusion-access-san_{context}"]
7+
= Creating a storage cluster with {FusionSAN}
8+
9+
Once you have installed the {FusionSAN} Operator, you can create a storage cluster with shared storage nodes.
10+
11+
The wizard for creating the storage cluster in the {product-title} web console provides easy-to-follow steps and lists the relevant worker nodes with shared disks.
12+
13+
.Prerequisites
14+
15+
* You have bare-metal worker nodes with visible and attached shared LUNs.
16+
+
17+
A shared LUN is a shared disk that is accessed by all workers simultaneously.
18+
* You installed the {FusionSAN} Operator.
19+
* You created the `FusionAccess` custom resource (CR) in the `ibm-fusion-access` namespace.
20+
21+
.Procedure
22+
23+
. In the {product-title} web console, navigate to *Storage* -> *{FusionSAN}*.
24+
25+
. Click *Create storage cluster*.
26+
27+
. Select the worker nodes that have shared LUNs.
28+
+
29+
[NOTE]
30+
====
31+
You can only select worker nodes with a minimum of 20 GB of RAM from the list.
32+
====
33+
34+
. Click *Create storage cluster*.
35+
+
36+
The page reloads, opening the {FusionSAN} page for the new storage cluster.

‎modules/virt-fusion-access-san-prereqs.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/about-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="fusion-access-san-prereqs_{context}"]
7+
= Prerequisites and Limitations for {FusionSAN}
8+
9+
== Prerequisites
10+
11+
Installing and configuring {FusionSAN} require the following prerequisites:
12+
13+
* Bare-metal worker nodes with attached SAN storage.
14+
* A working container registry enabled.
15+
* All worker nodes must connect to the same LUNs.
16+
+
17+
A shared LUN is a shared disk that is accessed by all worker nodes simultaneously.
18+
* A Kubernetes pull secret.
19+
20+
== Limitations
21+
22+
* Limitations for {FusionSAN} rely on the IBM Storage Scale container native limitations and can be found in the documentation for https://www.ibm.com/docs/en/scalecontainernative/5.2.3?topic=overview-limitations[IBM Storage Scale container native].
23+
* Hosted control planes (HCP) clusters are not supported.

‎modules/virt-installing-fusion-access-operator.adoc

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="installing-fusion-access-operator_{context}"]
7+
= Installing the {FusionSAN} Operator
8+
9+
Install the {FusionSAN} Operator from the *OperatorHub* in the {product-title} web console.
10+
11+
.Prerequisites
12+
13+
* You have access to the cluster as a user with the `cluster-admin` role.
14+
* You have a working container registry enabled.
15+
16+
.Procedure
17+
18+
. In the {product-title} web console, navigate to *Operators* -> *OperatorHub*.
19+
20+
. In the *Filter by keyword* field, type `Fusion Access for SAN`.
21+
22+
. Select the *{FusionSAN}* tile and click *Install*.
23+
24+
. On the *Install Operator* page, keep the default selections for *Update Channel*, *Version*, and *Installation mode*.
25+
26+
. Verify that *Operator recommended Namespace* is selected for *Installed Namespace*.
27+
+
28+
This installs the Operator in the `ibm-fusion-access` namespace. If this namespace does not yet exist, it is automatically created.
29+
+
30+
[WARNING]
31+
====
32+
If you install the {FusionSAN} Operator in a namespace other than `ibm-fusion-access`, {FusionSan} does not work.
33+
====
34+
35+
. Verify that the *Automatic* default is selected for *Update Approval*.
36+
+
37+
This enables automatic updates when a new z-stream release is available.
38+
39+
. Click *Install*.
40+
+
41+
This installs the Operator.
42+
43+
.Verification
44+
45+
. Navigate to *Operators* -> *Installed Operators*.
46+
47+
. Verify that the {FusionSAN} Operator is displayed.

‎virt/fusion_access_SAN/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/

0 commit comments

Comments
 (0)