Skip to content

Commit 2a81c9e

Browse files
bveredbvered
authored
Docs md transforms (#67)
* md transform * adding support matrix * reformatting of summary.md * updated support summary linking * format updates * changed DITA source files to MD
1 parent fa2fa61 commit 2a81c9e

9 files changed

Lines changed: 164 additions & 0 deletions

File tree

‎docs/SUMMARY.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Table of Contents
2+
3+
* [ODF FlashSystem driver welcome](docs_general/docs_welcome.md)
4+
* [ODF FlashSystem driver support summary](docs_general/odf_flashsystem_driver_support_matrix.md)
5+
* [What's new](docs_general/docs_whatsnew.md)
6+
* [Trademarks](docs_general/trademarks.md)
7+
* [Installing the driver](installing/installing.md)
8+
* [Configuring](configuring/configuring.md)
9+
* [Limitations](configuring/limitations.md)
10+
* [Related information and publications](docs_general/relatedpubs.md)

‎docs/configuring/configuring.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configuring
2+
3+
Red Hat® OpenShift® Data Foundation (ODF) uses the ODF FlashSystem driver to integrate with your IBM FlashSystem® storage system. When using the OpenShift Data Foundation with your storage system ensure that all configuration needs are met by following the Red Hat ODF documentation set.
4+
5+
The ODF FlashSystem driver enable IBM Spectrum Virtualize family products to be used with Red Hat OpenShift Data Foundation.
6+
7+
For more information and documentation, see the following:
8+
9+
- Support summary for enabled IBM Spectrum Virtualize family products and Red Hat OpenShift Data Foundation: [ODF FlashSystem driver support summary](../landing/odf_flashsystem_driver_support_matrix.html).
10+
- User information and release notes documentation for the Red Hat OpenShift Data Foundation: [OpenShift Data Foundation documentation](https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation).
11+
- General information about the OpenShift Data Foundation, a software-defined storage for containers: [OpenShift Data Foundation](https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation).
12+
13+
## Configuration considerations
14+
15+
When creating block storage persistent volumes, be sure to select the storage class <storage_class_name> for best performance. The storage class allows a direct I/O path to the FlashSystem storage system.
16+
17+

‎docs/configuring/limitations.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Limitations
2+
3+
Refer to these limitations before working with the ODF FlashSystem driver.
4+
5+
The ODF FlashSystem driver contains the following limitations:
6+
7+
- Only x86 architecture is supported.
8+
- When creating a storage class from within the Red Hat® ODF user-interface, installation of Ceph® RWO on FlashSystem storage systems is allowed. When working with FlashSystem storage systems, it is best to use a direct I/O path to the storage system. For more information, see [Configuration considerations](configuring.md#odf_config).
9+
- The following individual reports are not currently generated:
10+
- Pool performance
11+
- Volume performance
12+
- Volume storage class capacity
13+
- Reports are not generated for FlashSystem information and events.
14+

‎docs/docs_general/docs_welcome.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# ODF FlashSystem driver welcome
2+

‎docs/docs_general/docs_whatsnew.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# What's new
2+
3+
This topic lists the dates and nature of updates to the published information of the ODF FlashSystem driver.
4+
5+
|Date|Nature of updates to the published information|
6+
|----|----------------------------------------------|
7+
|23 January 2023|The version information was added in IBM Documentation as part of the initial ODF FlashSystem driver 1.3.0 release.<br><br>ODF FlashSystem driver adds new support for the following:<br>- Multiple FlashSystem storage systems, including health, capacity, and performance information.<br>- Storage calculations for FlashSystem child pools.<br>- External storage system calculations.|
8+

‎docs/docs_general/odf_flashsystem_driver_support_matrix.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# ODF FlashSystem driver support summary
2+
3+
ODF FlashSystem driver, together with Red Hat® OpenShift® Data Foundation \(ODF\), enables connecting and monitoring IBM FlashSystem® family storage systems running Spectrum Virtualize software.
4+
5+
The FlashSystem family storage systems supported for ODF FlashSystem driver include FlashSystem 5xxx, 7xxx, 9xxx.
6+
7+
**Note:**
8+
9+
- SAN Volume Controller (SVC) is not enabled at the time of this release.
10+
- FlashSystem 5015, FlashSystem 5035, and FlashSystem 5200 began in version 8.4.0.1.
11+
- FlashSystem 9200 began in version 8.4.0.3.
12+
- Microcode version 8.4.x includes version 8.4.0.x and higher for both LTS and Non-LTS releases. For more information, see [IBM Spectrum Virtualize FAQ for Continuous Development (CD) Release Model for software releases](https://www.ibm.com/support/pages/node/6409554).
13+
- FlashSystem 7300 and FlashSystem 9500 began in version 8.5.0.0.
14+
15+
16+
<table>
17+
<thead>
18+
<tr>
19+
<th colspan=1>Red Hat OpenShift Data Foundation (ODF) version</th>
20+
<th colspan=4>ODF FlashSystem driver version</th>
21+
</tr>
22+
</thead>
23+
<thead>
24+
<tr>
25+
<th></th>
26+
<th>1.0.0</th>
27+
<th>1.1.0</th>
28+
<th>1.2.0</th>
29+
<th>1.3.0</th>
30+
</thead>
31+
<tbody>
32+
<tr>
33+
<td>4.9</td>
34+
<td><ul>
35+
<li>8.3.1.6 or later</li>
36+
<li>8.4.x</li></ul></td>
37+
<td>Not supported</td>
38+
<td>Not supported</td>
39+
<td>Not supported</td>
40+
</tr>
41+
<tr>
42+
<td>4.10</td>
43+
<td>Not supported</td>
44+
<td><ul>
45+
<li>8.3.1.6 or later</li>
46+
<li>8.4.x</li>
47+
<li>8.5.0.x</li></ul></td>
48+
<td>Not supported</td>
49+
<td>Not supported</td>
50+
</tr>
51+
<tr>
52+
<td>4.11</td>
53+
<td>Not supported</td>
54+
<td>Not supported</td>
55+
<td><ul>
56+
<li>8.3.1.6 or later</li>
57+
<li>8.4.x</li>
58+
<li>8.5.0.x</li>
59+
<li>8.5.2.x</li>
60+
<li>8.5.3</li></ul></td>
61+
<td>Not supported</td>
62+
</tr>
63+
<tr>
64+
<td>4.12</td>
65+
<td>Not supported</td>
66+
<td>Not supported</td>
67+
<td>Not supported</td>
68+
<td><ul>
69+
<li>8.3.1.6 or later</li>
70+
<li>8.4.x</li>
71+
<li>8.5.0.x</li>
72+
<li>8.5.2.x</li>
73+
<li>8.5.3</li></ul></td>
74+
</tr>
75+
</tbody>
76+
</table>
77+
78+
79+
80+
**Note:** For more information about Red Hat OpenShift Data Foundation, a software-defined storage for containers, see the [OpenShift Data Foundation](https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation) page.
81+

‎docs/docs_general/relatedpubs.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Related information and publications
2+
3+
You can find additional information and publications related to the ODF FlashSystem driver at the following websites:
4+
5+
- [IBM FlashSystem 5200, 5000, 5100, Storwize® V5100 and V5000E in IBM Documentation](https://www.ibm.com/docs/en/flashsystem-5x00)
6+
- [IBM FlashSystem 7300, 7200 and Storwize V7000 in IBM Documentation](https://www.ibm.com/docs/en/flashsystem-7x00)
7+
- [IBM FlashSystem 9500, 9200 and 9100 in IBM Documentation](https://www.ibm.com/docs/en/flashsystem-9x00)
8+
- [Product Documentation for Red Hat OpenShift Data Foundation](https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation)
9+
- [IBM block storage CSI driver documentation](https://www.ibm.com/docs/en/stg-block-csi-driver)
10+

‎docs/docs_general/trademarks.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Trademarks
2+
3+
IBM®, the IBM logo, and ibm.com® are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at Copyright and trademark information at [www.ibm.com/legal/copytrade.shtml](http://www.ibm.com/legal/copytrade.shtml).
4+
5+
Adobe™, the Adobe logo, PostScript™, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
6+
7+
Red Hat®, JBoss®, OpenShift®, Fedora®, Hibernate®, Ansible®, CloudForms®, RHCA®, RHCE®, RHCSA®, Ceph®, and Gluster® are trademarks or registered trademarks of Red Hat, Inc. or its subsidiaries in the United States and other countries.
8+
9+
Other product and service names might be trademarks of IBM or other companies.
10+

‎docs/installing/installing.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Installing the driver
2+
3+
Download and install the ODF FlashSystem driver to manage your FlashSystem storage systems through Red Hat OpenShift Data Foundation.
4+
5+
**Important:** ODF FlashSystem driver is not a standalone product and **must** be used together with Red Hat OpenShift Data Foundation and with Red Hat OpenShift Data Foundation already installed.
6+
7+
Install the ODF FlashSystem driver through the [Red Hat OpenShift certified operator catalog](https://catalog.redhat.com/software/search?type=Operator).
8+
9+
For more information, see [https://github.com/IBM/ibm-storage-odf-block-driver/releases/tag/v1.3.0](https://github.com/IBM/ibm-storage-odf-block-driver/releases/tag/v1.3.0).
10+
11+
**Note:** For full installation information see, **Deploying OpenShift Data Foundation in external mode** > **Deploy OpenShift Data Foundation using IBM FlashSystem** within the [Red Hat OpenShift Data Foundation Product Documentation](https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation).
12+

0 commit comments

Comments
 (0)