Skip to content

Commit 390af48

Browse files
rivkaprivkap
authored
Docs release 1.3.0 (#58)
* update operator tag for go mod file * upgrade operator latest version * Create configuring.dita * separated out limitations * updated naming * updated link * sorted into folders * added basic files for ibm docs * added trademark info * added related publications * Create configuring.dita * separated out limitations * updated naming * updated link * sorted into folders * added no translate rules * updated link to matrix page * updated welcome name * updated linking * updated what's new title * adding what's new info per Alon * added installing info * updated to show that it is new support * reworded for general support - not display specific * added breadcrumbs to installation * placed matrix in toc * fixed matrix linking * updated installation instructions per RM * updated typo in link * Update docs_whatsnew.dita
1 parent 1379167 commit 390af48

8 files changed

Lines changed: 256 additions & 0 deletions

File tree

‎docs/configuring/configuring.dita‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA IBM Reference//EN" "ibm-reference.dtd">
3+
<reference id="configuring" xml:lang="en-us">
4+
<title>Configuring</title>
5+
<titlealts>
6+
<navtitle>Configuring</navtitle>
7+
<searchtitle>Configuring</searchtitle>
8+
</titlealts>
9+
<shortdesc><tm trademark="Red Hat" tmtype="reg">Red Hat</tm>
10+
<tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data Foundation (ODF) uses the <ph
11+
translate="no">ODF FlashSystem driver</ph> to integrate with your <tm trademark="IBM FlashSystem"
12+
tmtype="reg">IBM FlashSystem</tm> storage system. When using the <tm trademark="OpenShift"
13+
tmtype="reg">OpenShift</tm> Data Foundation with your storage system ensure that all configuration
14+
needs are met by following the <tm trademark="Red Hat" tmtype="reg">Red Hat</tm> ODF documentation
15+
set.</shortdesc>
16+
<refbody>
17+
<section>
18+
<p>The <ph translate="no">ODF FlashSystem driver</ph> enable IBM Spectrum Virtualize family products
19+
to be used with <tm trademark="Red Hat" tmtype="reg">Red Hat</tm>
20+
<tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data Foundation.</p>
21+
<p>For more information and documentation, see the following:<ul>
22+
<li>Support summary for enabled IBM Spectrum Virtualize family products and <tm trademark="Red Hat"
23+
tmtype="reg">Red Hat</tm>
24+
<tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data Foundation: <xref
25+
href="../landing/odf_flashsystem_driver_support_matrix.html" scope="peer" format="html">ODF
26+
FlashSystem driver support summary</xref>.</li>
27+
<li>User information and release notes documentation for the <tm trademark="Red Hat" tmtype="reg"
28+
>Red Hat</tm>
29+
<tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data Foundation: <xref
30+
href="https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation" format="html"
31+
scope="external"><tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data Foundation
32+
documentation</xref>.</li>
33+
<li>General information about the <tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data
34+
Foundation, a software-defined storage for containers: <xref
35+
href="https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation"
36+
format="html" scope="external"><tm trademark="OpenShift" tmtype="reg">OpenShift</tm> Data
37+
Foundation</xref>.</li>
38+
</ul></p>
39+
</section>
40+
<section id="odf_config">
41+
<title>Configuration considerations</title>
42+
<p>When creating block storage persistent volumes, be sure to select the storage class
43+
<cmdname>&lt;storage_class_name&gt;</cmdname> for best performance. The storage class allows a
44+
direct I/O path to the FlashSystem storage system.</p>
45+
</section>
46+
</refbody>
47+
</reference><?tm 1639394264348 22 Red Hat||OpenShift||IBM FlashSystem||IBM||Ceph ?>

‎docs/configuring/limitations.dita‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA IBM Reference//EN" "ibm-reference.dtd">
3+
<reference id="svc_odf_config" xml:lang="en-us" otherprops="50845">
4+
<title>Limitations</title>
5+
<titlealts>
6+
<navtitle>Limitations</navtitle>
7+
<searchtitle>Limitations</searchtitle>
8+
</titlealts>
9+
<shortdesc>Refer to these limitations before working with the <ph translate="no">ODF FlashSystem
10+
driver</ph>.</shortdesc>
11+
<refbody>
12+
<section id="limitations">The <ph translate="no">ODF FlashSystem driver</ph> contains the following limitations:<ul>
13+
<li>Only x86 architecture is supported.</li>
14+
<li>When creating a storage class from within the <tm trademark="Red Hat" tmtype="reg">Red Hat</tm>
15+
ODF user-interface, installation of <tm trademark="Ceph" tmtype="reg">Ceph</tm> RWO on FlashSystem
16+
storage systems is allowed. When working with FlashSystem storage systems, it is best to use a
17+
direct I/O path to the storage system. For more information, see <xref
18+
href="configuring.dita#configuring/odf_config"/>.</li>
19+
<li>The following individual reports are not currently generated:<ul>
20+
<li>Pool performance</li>
21+
<li>Volume performance</li>
22+
<li>Volume storage class capacity</li>
23+
</ul></li>
24+
<li>Reports are not generated for FlashSystem information and events.</li>
25+
</ul></section>
26+
</refbody>
27+
</reference><?tm 1639394264348 22 Red Hat||OpenShift||IBM FlashSystem||IBM||Ceph ?>

‎docs/docs_general/docs_welcome.dita‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="welcome" outputclass="kc_welcome" xml:lang="en-us">
4+
<title>ODF FlashSystem driver welcome</title>
5+
<prolog>
6+
<copyright>
7+
<copyryear year="2022"/>
8+
<copyrholder/><!--Add copyright year or years as the "year" attribute for copyryear. Copyright holder information is filled in automatically
9+
for IBM. Critdates are not currently used by the transform, but they are preserved in the metadata. -->
10+
</copyright>
11+
</prolog>
12+
</topic>

‎docs/docs_general/docs_whatsnew.dita‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//IBM//DTD DITA IBM Concept//EN" "ibm-concept.dtd">
3+
<?Pub Inc?><concept id="docs_whatsnew" xml:lang="en-us">
4+
<title>What's new</title>
5+
<shortdesc>This topic lists the dates and nature of updates to the published information of the <ph
6+
translate="no">ODF FlashSystem driver</ph>.</shortdesc>
7+
<conbody>
8+
<table>
9+
<tgroup cols="2">
10+
<colspec colname="col1" colwidth="29*" />
11+
<colspec colname="col2" colwidth="70*" />
12+
<thead>
13+
<row outputclass="xlight" valign="bottom">
14+
<entry align="left" colname="col1">Date</entry>
15+
<entry align="left" colname="col2">Nature of updates to the published information</entry>
16+
</row>
17+
</thead>
18+
<tbody>
19+
<row>
20+
<entry colname="col1">23 January 2023</entry>
21+
<entry colname="col2">
22+
<p>The version information was added in IBM Documentation as part of the initial <ph translate="no"
23+
>ODF FlashSystem driver</ph> 1.3.0 release.</p>
24+
<p><ph translate="no">ODF FlashSystem driver</ph> adds new support for the following:<ul>
25+
<li>Multiple FlashSystem storage systems, including health, capacity, and performance
26+
information.</li>
27+
<li>Storage calculations for FlashSystem child pools.</li>
28+
<li>External storage system calculations.</li>
29+
</ul></p>
30+
</entry>
31+
</row>
32+
</tbody>
33+
</tgroup>
34+
</table>
35+
</conbody>
36+
37+
</concept><?Pub *0000001199?><?tm 1670402701300 1 IBM ?>

‎docs/docs_general/relatedpubs.dita‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//IBM//DTD DITA IBM Topic//EN" "ibm-topic.dtd">
3+
<?Pub Sty _display FontColor="red"?><?Pub Inc?><topic id="vcplugin_ug_relatedpubs" xml:lang="en-us">
4+
<title>Related information and publications</title>
5+
<?Pub Caret -2?>
6+
<titlealts>
7+
<searchtitle>Related documentation</searchtitle>
8+
</titlealts>
9+
<body>
10+
<p>You can find additional information and publications related to the ODF FlashSystem driver at the
11+
following websites:<ul id="related_info">
12+
<li><xref href="https://www.ibm.com/docs/en/flashsystem-5x00" scope="external" format="html"><tm
13+
tmtype="reg" trademark="IBM">IBM</tm> FlashSystem 5200, 5000, 5100, <tm tmtype="reg"
14+
trademark="Storwize">Storwize</tm> V5100 and V5000E in <tm trademark="IBM" tmtype="reg">IBM</tm>
15+
Documentation</xref></li>
16+
<li><xref href="https://www.ibm.com/docs/en/flashsystem-7x00" scope="external" format="html"><tm
17+
tmtype="reg" trademark="IBM">IBM</tm> FlashSystem 7300, 7200 and <tm tmtype="reg"
18+
trademark="Storwize">Storwize</tm> V7000 in <tm trademark="IBM" tmtype="reg">IBM</tm>
19+
Documentation</xref></li>
20+
<li><xref format="html" href="https://www.ibm.com/docs/en/flashsystem-9x00" scope="external"><tm
21+
trademark="IBM FlashSystem" tmtype="reg">IBM FlashSystem</tm> 9500, 9200 and 9100 in <tm
22+
trademark="IBM" tmtype="reg">IBM</tm> Documentation</xref></li>
23+
<li><xref href="https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation"
24+
format="html" scope="external">Product Documentation for Red Hat OpenShift Data
25+
Foundation</xref></li>
26+
<li><xref href="https://www.ibm.com/docs/en/stg-block-csi-driver" format="html" scope="external">IBM
27+
block storage CSI driver documentation</xref></li>
28+
</ul></p>
29+
</body>
30+
</topic><?Pub *0000002156?><?tm 1670402701365 11 Storwize||IBM FlashSystem||IBM ?>

‎docs/docs_general/trademarks.dita‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA IBM Reference//EN"
3+
"ibm-reference.dtd">
4+
<?Pub Sty _display FontColor="red"?>
5+
<?Pub Inc?>
6+
<reference id="mlt_trademarks_1b1d3g" xml:lang="en-us">
7+
<title>Trademarks</title>
8+
<?Pub Caret -2?>
9+
<refbody>
10+
<!--
11+
Title: Do not change.
12+
Shortdesc: Not used here. Need to check with corporate about changing the template.
13+
Para 1: Do not change.
14+
Para 2: Add "Other IBM company attributions" and "Special non-IBM trademarks" as needed. URLs below.
15+
File name: You can Rename to product-specific file name. Ex. sonas_trademarks.dita
16+
Storage: Save your product-specific file in your team repository. Ex. CMVC or IDCMS
17+
Guidance: https://w3-03.ibm.com/chq/legal/lis.nsf/lawdoc/5A84050DEC58FE31852576850074BB32?OpenDocument#Trademark%20Guidelines
18+
19+
Notice the following informat regarding IC and PDF trademarks
20+
So in each deliverable (IC, PDF, KC), we should only list the special non-IBM trademarks that are actually used in that deliverable. For IC and KC, since the content is identical (just the delivery vehicle is different), it should be ok to use the same trademark file for both. But typically it would not be ok to use the same trademark file for IC and all PDF.
21+
22+
23+
-->
24+
<section>
25+
<!--Paragraph 1: Do not customize. IMPORTANT: Do NOT list the IBM trademarks in an attribution statement. -->
26+
<p><tm tmtype="reg" trademark="IBM">IBM</tm>, the <tm tmtype="reg" trademark="IBM">IBM</tm> logo,
27+
and <tm tmtype="reg" trademark="ibm.com">ibm.com</tm> are trademarks or registered trademarks of
28+
International Business Machines Corp., registered in many jurisdictions worldwide. Other product and
29+
service names might be trademarks of <tm tmtype="reg" trademark="IBM">IBM</tm> or other companies. A
30+
current list of <tm tmtype="reg" trademark="IBM">IBM</tm> trademarks is available on the web at
31+
Copyright and trademark information at <xref format="html"
32+
href="http://www.ibm.com/legal/copytrade.shtml" id="copytrade" scope="external"
33+
>www.ibm.com/legal/copytrade.shtml</xref>.</p>
34+
</section>
35+
<section>
36+
<!--Paragraph 2: Customize, as needed.
37+
1. List OTHER IBM COMPANY ATTRIBUTIONS. The statements are NOT listed here.
38+
Guidance: http://www.ibm.com/legal/us/en/copytrade.shtml#section_5
39+
2. List SPECIAL NON-IBM TRADEMARKS. All of the statements ARE listed here.
40+
a. Arrange the attribution statements in alphabetic order by COMPANY name.
41+
b. In each attribution statement, list ONLY the special non-IBM trademarks that the information actually uses.
42+
c. Delete the statements and the products your product does not list.-->
43+
<p><tm tmtype="tm" trademark="Adobe">Adobe</tm>, the <tm tmtype="tm" trademark="Adobe">Adobe</tm>
44+
logo, <tm tmtype="tm" trademark="PostScript">PostScript</tm>, and the <tm tmtype="tm"
45+
trademark="PostScript">PostScript</tm> logo are either registered trademarks or trademarks of <tm
46+
tmtype="tm" trademark="Adobe">Adobe</tm> Systems Incorporated in the United States, and/or other
47+
countries.</p>
48+
<!--<p><tm tmtype="tm" trademark="Intel">Intel</tm> and <tm tmtype="tm" trademark="Intel Xeon">Intel Xeon</tm> are trademarks or registered trademarks of <tm tmtype="tm" trademark="Intel">Intel</tm> Corporation or its subsidiaries in the United States and other countries.</p><p><tm tmtype="tm" trademark="Java">Java</tm> and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.</p><p><tm tmtype="tm" trademark="Linux">Linux</tm> and the <tm tmtype="tm" trademark="Linux">Linux</tm> logo is a registered trademark of Linus Torvalds in the United States, other countries, or both. </p><p><tm tmtype="tm" trademark="Microsoft">Microsoft</tm>, <tm tmtype="tm" trademark="Windows">Windows</tm>, and the <tm tmtype="tm" trademark="Windows">Windows</tm> logo are trademarks of <tm tmtype="tm" trademark="Microsoft">Microsoft</tm> Corporation in the United States, other countries, or both. </p><p><tm tmtype="tm" trademark="UNIX">UNIX</tm> is a registered trademark of The Open Group in the United States and other countries. </p>-->
49+
<p>Red Hat®, JBoss®, OpenShift®, Fedora®, Hibernate®, Ansible®, CloudForms®, RHCA®, RHCE®, RHCSA®,
50+
Ceph®, and Gluster® are trademarks or registered trademarks of Red Hat, Inc. or its subsidiaries in
51+
the United States and other countries. </p>
52+
<p>Other product and service names might be trademarks of <tm tmtype="reg" trademark="IBM">IBM</tm>
53+
or other companies.</p>
54+
</section>
55+
</refbody>
56+
<?tm 1383087296 23?>
57+
</reference>
58+
<?Pub *0000004409?>

‎docs/fs_odf.ditamap‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE map PUBLIC "-//IBM//DTD DITA IBM Map//EN" "ibm-map.dtd">
3+
<?Pub Sty _display FontColor="red"?><?Pub Inc?>
4+
<map xml:lang="en-us">
5+
<title>FS ODF IBM Docs ditamap</title>
6+
<topicmeta>
7+
<copyright>
8+
<copyryear year="2023"/>
9+
<copyrholder>IBM Corp.</copyrholder>
10+
</copyright>
11+
</topicmeta>
12+
<topicref href="docs_general/docs_welcome.dita"><?Pub Caret -1?></topicref>
13+
<topicref href="landing/odf_flashsystem_driver_support_matrix.html" scope="peer"
14+
navtitle="ODF FlashSystem driver support summary" format="html"/>
15+
<topicref href="docs_general/docs_whatsnew.dita"/>
16+
<topicref href="docs_general/trademarks.dita" navtitle="Trademarks"/>
17+
<topicref href="installing/installing.dita" navtitle="Downloading the driver"/>
18+
<topicref href="configuring/configuring.dita">
19+
<topicref href="configuring/limitations.dita"/>
20+
</topicref>
21+
<topicref href="docs_general/relatedpubs.dita"/>
22+
</map><?Pub *0000001378?><?tm 1670402701885 1 IBM Spectrum ?>

‎docs/installing/installing.dita‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="installing" xml:lang="en-us">
4+
<title>Installing the driver</title>
5+
<shortdesc>Download and install the <ph translate="no">ODF FlashSystem driver</ph> to manage your
6+
FlashSystem storage systems through Red Hat OpenShift Data Foundation.</shortdesc>
7+
<refbody>
8+
<section>
9+
<p><note type="important"><ph translate="no">ODF FlashSystem driver</ph> is not a standalone product
10+
and <b>must</b> be used together with Red Hat OpenShift Data Foundation and with Red Hat OpenShift
11+
Data Foundation already installed.</note>Install the <ph translate="no">ODF FlashSystem driver</ph>
12+
through the <xref href="https://catalog.redhat.com/software/search?type=Operator" format="html"
13+
scope="external">Red Hat OpenShift certified operator catalog</xref>.</p>
14+
<p>For more information, see <xref
15+
href="https://github.com/IBM/ibm-storage-odf-block-driver/releases/tag/v1.3.0" format="html"
16+
scope="external"/>.<note>For full installation information see, <menucascade><uicontrol>Deploying
17+
OpenShift Data Foundation in external mode</uicontrol><uicontrol>Deploy OpenShift Data Foundation
18+
using IBM FlashSystem </uicontrol></menucascade> within the <xref
19+
href="https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation" format="html"
20+
scope="external">Red Hat OpenShift Data Foundation Product Documentation</xref>.</note></p>
21+
</section>
22+
</refbody>
23+
</reference>

0 commit comments

Comments
 (0)