Delfin driver matrix support template #140
Conversation
|
@Shruthi-1MN Please update the PR description with appropriate details. |
There was a problem hiding this comment.
@Shruthi-1MN the Dell EMC and Huawei OceanStor driver details are empty. Please update the same.
content/guides/user-guides/delfin/driver-matrix-support/_index.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Model and Versions Supported | ||
|
|
||
| |Models | Firmware Versions | |
There was a problem hiding this comment.
Please populate the content for the Dell EMC Vmax driver support.
There was a problem hiding this comment.
NA, it is just a template
There was a problem hiding this comment.
This is not the template. this document will hold the values for Dell EMC VMAX driver.
There was a problem hiding this comment.
As per our discussion #144 has created to fill all the data
|
|
||
| ### Model and Versions Supported | ||
|
|
||
| |Models | Firmware Versions | |
There was a problem hiding this comment.
Please populate the content for the Huawei OceanStor driver support.
There was a problem hiding this comment.
This file should contain the values for Huawei Oceanstor driver.
There was a problem hiding this comment.
#144 has been created to add data
@NajmudheenCT You can check out the deploy preview. It is generated as part of the All checks. Click on the Details link. |
Thanks, this helps |
content/guides/user-guides/delfin/driver-matrix-support/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/_index.md
Outdated
Show resolved
Hide resolved
|
@Shruthi-1MN please avoid force pushing commits. It will overwrite previous comments and discussions. |
There was a problem hiding this comment.
@Shruthi-1MN
Please populate the values for the different driver support matrix tables.
If these are supposed to be placeholders, then raise issues for each table to be filled and these can be updated later.
|
|
||
| ### Model and Versions Supported | ||
|
|
||
| |Models | Firmware Versions | |
There was a problem hiding this comment.
This is not the template. this document will hold the values for Dell EMC VMAX driver.
content/guides/user-guides/delfin/driver-matrix-support/dell-emc-vmax/_index.md
Outdated
Show resolved
Hide resolved
content/guides/user-guides/delfin/driver-matrix-support/hp-3par-storeserv/_index.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Model and Versions Supported | ||
|
|
||
| |Models | Firmware Versions | |
There was a problem hiding this comment.
This file should contain the values for Huawei Oceanstor driver.
|
Few questions: |
@kumarashit @Shruthi-1MN |
It can be done but 2 level page navigation is needed
Ans:- b) and c) |
content/support-matrix/_index.md
Outdated
| @@ -0,0 +1,10 @@ | |||
| --- | |||
| title: Support Matrix | |||
| description: "All supported matrix data for SODA can be found here" | |||
There was a problem hiding this comment.
All supported matrix data for SODA?
This statement does not give the intended meaning.
There was a problem hiding this comment.
corrected the statements
| @@ -0,0 +1,10 @@ | |||
| --- | |||
| title: Dell Emc | |||
| <thead> | ||
| <tr> | ||
| <th>Models</th> | ||
| <th>Firmware Versions</th> |
There was a problem hiding this comment.
I think we can change 'Firmware version' to 'Management software /version' . Becuase we specify management software than firmware of the device.
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>VMAX 100K, VMAX 200K,VMAX 400K</td> |
There was a problem hiding this comment.
Include VMAX flash versions in the list VMAX 250F/VMAX 450F/VMAX 850F/VMAX 950F
| </tbody> | ||
| </table> | ||
|
|
||
| ### Access information to register storage |
There was a problem hiding this comment.
formatting is not coming proper in the UI
| <tbody> | ||
| <tr> | ||
| <td rowspan="4">REST</td> | ||
| <td>host</td> |
There was a problem hiding this comment.
Give details of fields in the Additional info section , like host= unisphere host IP , port = unisphere port etc
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>Unisphere</td> |
There was a problem hiding this comment.
Alert source is not unisphere, it is 'Solution enabler' check with @sushanthakumar for more details
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>native_storage_pool_id</td> |
There was a problem hiding this comment.
Give user readable filed name , like native_storage_pool_id can be named as 'storage pool id' follow this for all
| <td></td> | ||
| </tr> | ||
| <tr> <tr> | ||
| <td rowspan=18>Port</td> |
There was a problem hiding this comment.
Port, controller and disk information is not implemeted for VMAX. You need to check the driver implementaion file to see whether this interface is implemented for this driver
|
|
||
| ### Resource data matrix | ||
|
|
||
| <table> |
There was a problem hiding this comment.
Device leval attributes are missing
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>SYMAPI_AEVENT2_UID_EVT_RESTARTED</td> |
There was a problem hiding this comment.
This informations are wrong.. alert fileds means the fields available in delfin for VMAX alerts . you can probably mention the curresponding VMAX event field if applicable check with @sushanthakumar for more details
|
Ans for 1 and 2. As the main menu is Support Matrix under that sub menu is delfin, so on parent menu we can any other support data as well ex: feature support matric
It is within Delfin, felt better place let me know if you have better place to keep.
Not clear, i copied the same template across all the drivers
Added
Added
Added, filled as much as possible
Added wherever is needed
Will add whenever it is required
I have added introduction at the beginning of delfin index page |
content/support-matrix/_index.md
Outdated
| --- | ||
|
|
||
| This section provides information about the support matrix data for SODA. | ||
| Please find below delfin project which has different vendor storage devices supported data matrix. |
There was a problem hiding this comment.
No need to mention delfin here.. this is common page holds index of all project support matrix. delfin is just one of them
|
|
||
| ### Supported alert source registration information | ||
|
|
||
| <table> |
There was a problem hiding this comment.
Alert table format need changes.. Discuss with @sushanthakumar
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> | ||
| <td>It is measured in terms of Tera byte</td> |
| </tr> | ||
| <tr> | ||
| <td>Subscribed Capacity</td> | ||
| <td>Refers to capacity allocated to device/host</td> |
There was a problem hiding this comment.
Not allocated.. it is the total amount of capacity subscribed
| </tr> | ||
| <tr> | ||
| <td>Type</td> | ||
| <td>Logical Type. Ex:Common LUN, Thin LUN</td> |
| </tr> | ||
| <tr> | ||
| <td>Storage Pool Id</td> | ||
| <td>Unique id to represent which storage pool it belongs to</td> |
| tags: ["support matrix", "delfin", "drivers"] | ||
| --- | ||
|
|
||
| Find below steps to add new delfin driver support matrix |
There was a problem hiding this comment.
Give link to sample template in the begining
There was a problem hiding this comment.
Added sample template in same page as per our discussion
|
|
||
| ``` | ||
| 10. Raise a PR to the documentation repository(https://github.com/sodafoundation/documentation.git) | ||
| 11. Please find sample data filled [template](/support-matrix/delfin/add-driver-support/_index.files/template.odt) |
There was a problem hiding this comment.
Give template as a md file.. it should be opened when clicking the link..
|
|
||
| ``` | ||
| 10. Raise a PR to the documentation repository(https://github.com/sodafoundation/documentation.git) | ||
| 11. Please find sample data filled [template](/support-matrix/delfin/add-driver-support/_index.files/template.odt) |
There was a problem hiding this comment.
Some comments in the provided template file
- No mentions of vendor here .
- Treat it like support matrix for a 'Sample driver ' , where 'sample' is the vendor name
- alert source table format to be changed!
| Find below steps to add new delfin driver support matrix | ||
| 1. Clone the documentation repository (https://github.com/sodafoundation/documentation.git) | ||
| 2. Navigate to the folder structure content/support-matrix/delfin | ||
| 3. Create a new folder and follow the naming format `vendor`. For example `dell-emc`. |
There was a problem hiding this comment.
This line is not very clear. esp. "naming format vendor"
| ``` | ||
| --- | ||
| title: Storwize | ||
| description: "All supported matrix data for IBM Models can be found here" |
There was a problem hiding this comment.
This description seem incorrect. Here we are already talking about IBM Storwize model. Isn't it?
| disableToc: false | ||
| --- | ||
|
|
||
| All supported matrix data for IBM Models which are supported by Delfin Project of SODA can be found here |
There was a problem hiding this comment.
This is also unaligned statement
| Step 3, 4 and 5 are not required if there is already vendor folder name exists in documentation repository | ||
| {{% /notice %}} | ||
|
|
||
| 6. Under vendor folder name, create a new folder with `model` name. For example `VNX`. |
There was a problem hiding this comment.
nit: You started with IBM example for template so don't put VNX as example, rather put storwize
There was a problem hiding this comment.
changed with same driver name
| @@ -0,0 +1,10 @@ | |||
| --- | |||
There was a problem hiding this comment.
Why are we putting these template? Above file you have already provided the steps for creating matrix and given template. Let the driver writer/document owner create these files
There was a problem hiding this comment.
Later those will be filled. Issue has been raised for the same #144
| <tr> | ||
| <td rowspan="4">REST</td> | ||
| <td>Unisphere Host</td> | ||
| <td>Unishpere host name</td> |
There was a problem hiding this comment.
These additional information is not clear.
| </tr> | ||
| <tr> | ||
| <td>Storage Id</td> | ||
| <td>Id in the delfin system</td> |
There was a problem hiding this comment.
From additional info, it is not clear the difference between "ID" and "Storage Id"
There was a problem hiding this comment.
added proper description
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> | ||
| <td>It is measured in terms of Tera byte</td> |
There was a problem hiding this comment.
Is it correct to say "measured in terms of"?
| </tr> | ||
| <tr> | ||
| <td>Type</td> | ||
| <td>Logical Type. Ex:Common LUN, Thin LUN</td> |
| </tr> | ||
| <tr> | ||
| <td>wwn</td> | ||
| <td>World wide name is to identify network storage devices</td> |
There was a problem hiding this comment.
not a proper description
| </tr> | ||
| <tr> | ||
| <td>Raw Capacity</td> | ||
| <td>It is measured in terms of Giga byte</td> |
There was a problem hiding this comment.
what exactly is Raw capacity?
There was a problem hiding this comment.
Physical Capacity, added in the description
| <td>Device Location, is name-value pair having component type and component name</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> |
There was a problem hiding this comment.
What exactly is Total capacity? Capacity of all the Disks or capacity of something else
There was a problem hiding this comment.
System capacity
| </tr> | ||
| <tr> | ||
| <td>Occur time</td> | ||
| <td>Alert trap created time</td> |
There was a problem hiding this comment.
Time at which alert is generated from device. Specified in epoch format
There was a problem hiding this comment.
@Shruthi-1MN @NajmudheenCT
Some doubts about the supported drivers that we have added here.
All the tables are empty. Are we placing these here as the first step and asking someone else to fill them in?
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th>SNMP trap processing</th> |
There was a problem hiding this comment.
Why the <th> inside a row and why all the rows are spanned together?
There was a problem hiding this comment.
It's default table style rendering issue making rowspan, it is not allowing proper row header.
There was a problem hiding this comment.
Do we need a row header? We can just have a regular table as we have for the other information.
There was a problem hiding this comment.
@Shruthi-1MN
Instead of a <th> can you try using a regular <td> and put the content inside <strong>This is bold text</strong> For ex: This is bold text.
<table>
<tr>
<td><strong>Query Backend Alert</strong></td>
<td>Supported</td>
</tr>
</table>| Query Backend Alert | Supported |
| tags: ["support matrix", "delfin", "drivers", "dell emc"] | ||
| --- | ||
|
|
||
| ### Model and Management software versions supported |
There was a problem hiding this comment.
Question: Are we going to update this page with actual data? Except for the Model and Management software versions supported table the other tables all seem to be the same as the template. Are we leaving these to be filled by community members or driver authors?
There was a problem hiding this comment.
@Shruthi-1MN @NajmudheenCT
The individual driver support matrix files that are part of the PR are currently empty. How are we going ahead with this?
There was a problem hiding this comment.
Yes anvit. We can remove that. @Shruthi-1MN Please remove other indexes , keep only ( Add new driver, VMAX and Oceanstoe , sections)
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Resource</th> |
There was a problem hiding this comment.
Table format is wrong. we need to have resource|default interval| additional info as table header
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Resource</th> |
| </tr> | ||
| <tr> | ||
| <td>Used Capacity</td> | ||
| <td>SRP usable used capacity(TB)</td> |
There was a problem hiding this comment.
SRP is not a common ter.. just say 'Storage pool Used capacity' unit is bytes
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> | ||
| <td>SRP(Storage resource pool) usable total capacity(TB)</td> |
There was a problem hiding this comment.
Remove SRP , it is only a VMAX term , in template we can say 'Storage Pool'
| </tr> | ||
| <tr> | ||
| <td>Used Capacity</td> | ||
| <td>It is measured in TB</td> |
There was a problem hiding this comment.
Remove measured in TB , say ' Volume Used capacity'
| <td>Device Location, is name-value pair having component type and component name</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> |
| </tr> | ||
| <tr> | ||
| <td>Used Capacity</td> | ||
| <td>It is measured in TB</td> |
| </tr> | ||
| <tr> | ||
| <td>Free Capacity</td> | ||
| <td>It is measured in TB</td> |
| </tr> | ||
| <tr> | ||
| <td>Raw Capacity</td> | ||
| <td>Physical capacity(GB)</td> |
There was a problem hiding this comment.
Raw Capacity ( sum of all disks capacity)
| </tr> | ||
| <tr> | ||
| <td>Subscribed Capacity</td> | ||
| <td>Total amount of capacity subscribed(TB)</td> |
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Write Bandwidth</td> |
There was a problem hiding this comment.
These are not in resource column, Please follow the example I have given for other resource also..
There was a problem hiding this comment.
Added for other resources
| 10. Fill appropriate driver data to support matrix tables. | ||
| 11. Please find below sample driver support matrix data tables with sample data for reference to fill specific driver support matrix data. | ||
| 12. Raise a PR to the documentation repository | ||
| # Sample Driver Name |
There was a problem hiding this comment.
Give a heading here " Support matrix template "
There was a problem hiding this comment.
Update the header
|
LGTM |
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Read throughput</td> |
There was a problem hiding this comment.
Give only 2 or 3 metrics in each resource.. Give description for all.. Do not leave blank
There was a problem hiding this comment.
Some formatting issues and minor changes. @Shruthi-1MN I think this is finally ready.
| Delfin project aims to overcome a challenge to manage heterogeneous storage devices on a single platform. | ||
| Delfin has standardized common API services. | ||
|
|
||
| Support matrix of each storage drivers are group to their vendor name. |
There was a problem hiding this comment.
Support matrix of each storage drivers are group to their vendor name. -> Support matrix of storage drivers are grouped by their vendors
| Delfin has standardized common API services. | ||
|
|
||
| Support matrix of each storage drivers are group to their vendor name. | ||
| Each driver support matrix include below topics. |
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> |
There was a problem hiding this comment.
@Shruthi-1MN Table is empty. remove if not available or applicable.
There was a problem hiding this comment.
@NajmudheenCT has to confirm
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td rowspan=3></td> |
There was a problem hiding this comment.
Table is empty. Please remove if not available or applicable
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>Storage Management Software</td> |
There was a problem hiding this comment.
This does not seem correct. Please check the values @Shruthi-1MN @NajmudheenCT
There was a problem hiding this comment.
@Shruthi-1MN Under the Models column It says Storage Management Software. Shouldn't this be a list of Oceanstor models?
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th>SNMP trap processing</th> |
There was a problem hiding this comment.
@Shruthi-1MN
Instead of a <th> can you try using a regular <td> and put the content inside <strong>This is bold text</strong> For ex: This is bold text.
<table>
<tr>
<td><strong>Query Backend Alert</strong></td>
<td>Supported</td>
</tr>
</table>| Query Backend Alert | Supported |
| </tr> | ||
| <tr> | ||
| <td>Storage Id</td> | ||
| <td>Id generated by delfin to identify the storage device</td> |
| </tr> | ||
| <tr> | ||
| <td>Total Capacity</td> | ||
| <td>total pool capacity(bytes)</td> |
| </tr> | ||
| <tr> | ||
| <td>Free Capacity</td> | ||
| <td>Total-Used capacity(TB)</td> |
| </tr> | ||
| <tr> | ||
| <td>Storage Id</td> | ||
| <td>Id generated by delfin to identify the storage device</td> |
There was a problem hiding this comment.
Overall LGTM.
@Shruthi-1MN Please check one comment in the Oceanstor driver file.
There are a few comments on some of the empty tables. @NajmudheenCT Please do take a look.
|
@NajmudheenCT Please review and approve again as your earlier review was rejected due to new commits. |
@Shruthi-1MN Let us remove the emty tables , We can add perf-collection related info after this release. |
|
LGTM |
|
@kumarashit @skdwriting @Shruthi-1MN this PR depends on #142 for enabling HTML tags in the docs website. |
What type of PR is this?
What this PR does / why we need it:
Adding delfin driver support matrix template. Two sample templates Dell Emc and Huawei oceanStor are added. There is a generic template how to add new driver support matrix.
Which issue(s) this PR fixes:
Fixes #
Test Report Added?:
Test Report:
Added new folder structure along with the VMAX property details
Special notes for your reviewer:
Template details will be filled later.