Add new driver support matrix

Find below steps to add new delfin driver support matrix

  1. Clone the documentation repository
  2. Navigate to the folder structure content/support-matrix/delfin
  3. Create a new folder with vendor name. For example dell-emc.
  4. Create a new file _index.md
  5. Add the frontmatter as follows to add new Vendor. Change the content as required.
---
title: Dell EMC
description: "Support matrix data for Dell EMC Models can be found here"
weight: 5
disableToc: false
---

Support matrix data for Dell EMC Models can be found here

Please ensure you copy the entire frontmatter including both the ---

Step 3, 4 and 5 are not required if there is already vendor folder name exists in the documentation repository


6. Under vendor folder name, create a new folder with model name. For example vnx.
7. Create a new file _index.md.
8. Add the frontmatter as follows. Change the content as required.

---
title: VNX
menuTitle: VNX 
description: "VNX Support Matrix"
weight: 20
disableToc: false
tags: ["support matrix", "delfin", "drivers", "dell emc"]
---

Please ensure you copy the entire frontmatter including both the ---


9. To add all the support matrix tables content, copy lines from 57 to 432 from the file content/support-matrix/delfin/add-driver-support/_index.md
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

Support matrix template

Model and management software versions supported

Models Management Software Versions
Sample model name Management software version

Access information to register storage device

Access Type Attributes Additional information
REST Host Management software version host name
Port Management software version port name
Username Management software version Username
Password Management software version Password
SSH Host Management software version host name
Port Management software version port name
Username Management software version Username
Password Management software version Password

Alert management information

SNMP trap processing Specify whether SNMP trap is supported or not supported
Query backend alert Specify whether Query alert is supported or not supported
Clear backend alert Specify whether Clear alert is supported or not supported
SNMP versions for trap Specify SNMP supported version by driver
SNMP trap source Alert source name supported by driver
Query alert source Query alert source name supported by driver

Performance registration information

Resource Default Interval Additional information
Storage Node True Storage Node performance metrics are supported by driver and default interval performance metric collection enabled
Storage Pool True Storage Pool performance metrics are supported by driver and default interval performance metric collection enabled
Volume True Volume performance metrics are supported by driver and default interval performance metric collection enabled

Resource data matrix

Resource Attribute Additional information
Pool Id Delfin system resource id for pool
Name Name
Storage Id Id generated by Delfin to identify the storage device
Storage Pool Id It is actual storage pool(storage resource pool) name which is received from backend
Storage Type Type of storage. Ex: Block, file, hybrid
Description Description
Status Status of the pool. Ex: available
Total Capacity Total pool capacity(bytes)
Used Capacity Storage pool used capacity(bytes)
Free Capacity Total used capacity(TB)
Volume Id Delfin system resource id for volume
Name Volume Name
Storage Id Id generated by Delfin to identify the storage device
Volume Id Actual volume id received from backend drivers
Description Description
Type Logical Type. Ex:Thin or Thick
Status Status
WWN WWN
Total Capacity Volume total capacity(TB)
Used Capacity Volume used capacity
Free Capacity Volume free capacity
Device Name Device Name
Vendor Vendor
Description Device Description
Model Device Model
Firmware version Firmware version
Status It shows availability of device ex: offline, normal etc.
Serial Number Serial number of the array/disk
Location Device Location, is name-value pair having component type and component name
Total Capacity Total usable capacity of the array
Used Capacity Total used capacity
Free Capacity Total free capacity
Raw Capacity Total raw capacity(sum of all disk capacity)
Subscribed Capacity Total amount of capacity subscribed

Alert data matrix

Attribute Additional information
Alert id Identification of alarm.
Alert name Name of the alarm
Severity Severity of the alarm
Category Category of the reported alarm notification. Ex: Fault, Event or Recovery
Type Basic classification of the alarm. Ex:CommunicationsAlarm, EquipmentAlarm
Sequence number Unique identification for the alert instance
Occur time Time at which alert is generated from device. Specified in epoch format
Description Alarm Description
Recovery advice This field does not contain any info. However description field may contain some recovery advice in some cases.
Resource type Resource type for alert which can be storage subsystem or some other subsystems
Location Detailed info about tracing the alerting device such as array id, component name, component type

Performance metric data

Resource Metric Additional information
Storage Array Bandwidth Total bandwidth in MB/s
Response time Total read and write response time in MB/s
Throughput Total disks throughput(MB/s)
Storage Pool Total Throughput Total read and write throughput
IOPS Total read and write IOPS
Utilization Total read and write utilization
Volume Response time Total read and write response time in MB/s
Cache hits ratio Total read and write cache hit ratio
Cache hits A count of the number of cache hits