diff --git a/content/support-matrix/_index.md b/content/support-matrix/_index.md new file mode 100644 index 00000000..f1a31e40 --- /dev/null +++ b/content/support-matrix/_index.md @@ -0,0 +1,11 @@ +--- +title: Support Matrix +description: "Support matrix data for SODA can be found here" +weight: 5 +disableToc: false +--- + +This section provides information about the support matrix data for SODA. + + +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/support-matrix/delfin/_index.md b/content/support-matrix/delfin/_index.md new file mode 100644 index 00000000..97f09506 --- /dev/null +++ b/content/support-matrix/delfin/_index.md @@ -0,0 +1,26 @@ +--- +title: Delfin +menuTitle: Delfin +description: "Support matrix data for drivers of Delfin project" +weight: 10 +disableToc: false +tags: ["support matrix", "delfin", "drivers"] +--- + +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 grouped by their vendor name. +Each driver support matrix includes below topics. + + +1. Model and management software versions supported:- List of storage models and required management software versions. +2. Access information to register storage: Table illustrates what all access protocol supported and parameters required to register the storage device. +3. Alert management information : Type of alert sourcing and clearing supported +4. Performance registration information: Table illustrates the resources, and their default interval supported for performance collection. +5. Resource data matrix: Table illustrates the resources supported along with their available attributes. +6. Alert data matrix : Table illustrates fields available in the alert data +7. Performance metric data: Table illustrates performance metrics supported for each resource. + + +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/support-matrix/delfin/add-driver-support/_index.md b/content/support-matrix/delfin/add-driver-support/_index.md new file mode 100644 index 00000000..883e2c4c --- /dev/null +++ b/content/support-matrix/delfin/add-driver-support/_index.md @@ -0,0 +1,441 @@ +--- +title: Add new driver support matrix +description: "Document to add new delfin driver support matrix" +weight: 20 +disableToc: false +tags: ["support matrix", "delfin", "drivers"] +--- + +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 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 + +``` +{{% notice note %}} +Please ensure you copy the entire frontmatter including both the `---` +{{% /notice %}} +{{% notice note %}} +Step 3, 4 and 5 are not required if there is already vendor folder name exists in the documentation repository +{{% /notice %}} +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"] +--- +``` +{{% notice note %}} +Please ensure you copy the entire frontmatter including both the `---` +{{% /notice %}} +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 + + + + + + + + + + + + + + +
ModelsManagement Software Versions
Sample model nameManagement software version
+ +### Access information to register storage device + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Access TypeAttributesAdditional information
RESTHostManagement software version host name
PortManagement software version port name
UsernameManagement software version Username
PasswordManagement software version Password
SSHHostManagement software version host name
PortManagement software version port name
UsernameManagement software version Username
PasswordManagement software version Password
+ +### Alert management information + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SNMP trap processingSpecify whether SNMP trap is supported or not supported
Query backend alertSpecify whether Query alert is supported or not supported
Clear backend alertSpecify whether Clear alert is supported or not supported
SNMP versions for trapSpecify SNMP supported version by driver
SNMP trap sourceAlert source name supported by driver
Query alert sourceQuery alert source name supported by driver
+ +### Performance registration information + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceDefault IntervalAdditional information
Storage NodeTrueStorage Node performance metrics are supported by driver and default interval performance metric collection enabled
Storage PoolTrueStorage Pool performance metrics are supported by driver and default interval performance metric collection enabled
VolumeTrueVolume performance metrics are supported by driver and default interval performance metric collection enabled
+ +### Resource data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceAttributeAdditional information
PoolIdDelfin system resource id for pool
NameName
Storage IdId generated by Delfin to identify the storage device
Storage Pool IdIt is actual storage pool(storage resource pool) name which is received from backend
Storage TypeType of storage. Ex: Block, file, hybrid
DescriptionDescription
StatusStatus of the pool. Ex: available
Total CapacityTotal pool capacity(bytes)
Used CapacityStorage pool used capacity(bytes)
Free CapacityTotal used capacity(TB)
VolumeIdDelfin system resource id for volume
NameVolume Name
Storage IdId generated by Delfin to identify the storage device
Volume IdActual volume id received from backend drivers
DescriptionDescription
TypeLogical Type. Ex:Thin or Thick
StatusStatus
WWNWWN
Total CapacityVolume total capacity(TB)
Used CapacityVolume used capacity
Free CapacityVolume free capacity
DeviceNameDevice Name
VendorVendor
DescriptionDevice Description
ModelDevice Model
Firmware versionFirmware version
StatusIt shows availability of device ex: offline, normal etc.
Serial NumberSerial number of the array/disk
LocationDevice Location, is name-value pair having component type and component name
Total CapacityTotal usable capacity of the array
Used CapacityTotal used capacity
Free CapacityTotal free capacity
Raw CapacityTotal raw capacity(sum of all disk capacity)
Subscribed CapacityTotal amount of capacity subscribed
+ +### Alert data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeAdditional information
Alert idIdentification of alarm.
Alert nameName of the alarm
SeveritySeverity of the alarm
CategoryCategory of the reported alarm notification. Ex: Fault, Event or Recovery
TypeBasic classification of the alarm. Ex:CommunicationsAlarm, EquipmentAlarm
Sequence numberUnique identification for the alert instance
Occur timeTime at which alert is generated from device. Specified in epoch format
DescriptionAlarm Description
Recovery adviceThis field does not contain any info. However description field may contain some recovery advice in some cases.
Resource typeResource type for alert which can be storage subsystem or some other subsystems
LocationDetailed info about tracing the alerting device such as array id, component name, component type
+ +### Performance metric data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceMetricAdditional information
Storage ArrayBandwidthTotal bandwidth in MB/s
Response timeTotal read and write response time in MB/s
ThroughputTotal disks throughput(MB/s)
Storage PoolTotal ThroughputTotal read and write throughput
IOPSTotal read and write IOPS
UtilizationTotal read and write utilization
VolumeResponse timeTotal read and write response time in MB/s
Cache hits ratioTotal read and write cache hit ratio
Cache hitsA count of the number of cache hits
\ No newline at end of file diff --git a/content/support-matrix/delfin/dell-emc/_index.md b/content/support-matrix/delfin/dell-emc/_index.md new file mode 100644 index 00000000..e6359fbb --- /dev/null +++ b/content/support-matrix/delfin/dell-emc/_index.md @@ -0,0 +1,10 @@ +--- +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 + +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/support-matrix/delfin/dell-emc/vmax/_index.md b/content/support-matrix/delfin/dell-emc/vmax/_index.md new file mode 100644 index 00000000..4fa33e21 --- /dev/null +++ b/content/support-matrix/delfin/dell-emc/vmax/_index.md @@ -0,0 +1,299 @@ +--- +title: VMAX +menuTitle: VMAX +description: "VMAX Support Matrix" +weight: 19 +disableToc: false +tags: ["support matrix", "delfin", "drivers", "dell emc"] +--- + +### Model and Management software versions supported + + + + + + + + + + + + + + +
ModelsManagement Software Versions
VMAX 250F, VMAX 450F, VMAX 850F, VMAX 950F, VMAX 100K, VMAX 200K,VMAX 400KUnisphere 9.0 or later
+ +### Access information to register storage device + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Access TypeAttributesAdditional information
RESTHostUnishpere host name
PortUnisphere port name
UsernameUsername
PasswordPassword
+ +### Alert management information + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SNMP trap processingSupported
Query backend alertSupported
Clear backend alertSupported
SNMP versions for trapV1
SNMP trap sourceSolution Enabler
Query alert sourceUnisphere
+ +### Resource data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceAttributeAdditional information
PoolIdDelfin system resource id for pool
NameName
Storage IdId generated by delfin to identify the storage device
Storage Pool IdIt is actual storage pool(storage resource pool) name which is received from backend
Storage TypeType of storage. Ex: Block, file, hybrid
DescriptionDescription
StatusStatus of the pool. Ex: available
Total CapacitySRP(Storage resource pool) usable total capacity(TB)
Used CapacitySRP usable used capacity(bytes)
Free CapacityTotal-Used capacity of SRP(bytes)
VolumeIdDelfin system resource id for volume
NameVolume Name
Storage IdId generated by delfin to identify the storage device
Volume IdActual volume id received from backend drivers
DescriptionDescription
TypeLogical Type. Ex:Thin or Thick
StatusStatus
WWNLUN WWN
Total CapacityVolume total capacity(bytes)
Used CapacityLUN used capacity(bytes)
Free CapacityLUN free capacity(bytes)
DeviceNameDevice Name
VendorVendor
DescriptionDevice Description
ModelDevice Model
Firmware versionFirmware version
StatusIt shows availability of device ex: offline, normal etc.
Serial NumberIt is VMAX array id
LocationDevice Location, is name-value pair having component type and component name
Total CapacitySystem capacity
Used CapacityTotal used capacity
Free CapacityTotal free capacity
Raw CapacityRaw capacity(sum of all disks capacity)
Subscribed CapacityTotal amount of capacity subscribed(bytes)
+ +### Alert data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeAdditional information
Alert idIdentification of alarm.
Alert nameName of the alarm
SeveritySeverity of the alarm
CategoryCategory of the reported alarm notification. Ex: Fault, Event or Recovery
TypeBasic classification of the alarm. Ex:CommunicationsAlarm, EquipmentAlarm
Sequence numberUnique identification for the alert instance
Occur timeTime at which alert is generated from device. Specified in epoch format
DescriptionAlarm Description
Recovery adviceThis field does not contain any info. However description field may contain some recovery advice in some cases.
Resource typeResource type for alert which can be storage subsystem or some other subsystems
LocationDetailed info about tracing the alerting device such as array id, component name, component type
\ No newline at end of file diff --git a/content/support-matrix/delfin/huawei/_index.md b/content/support-matrix/delfin/huawei/_index.md new file mode 100644 index 00000000..a99df89b --- /dev/null +++ b/content/support-matrix/delfin/huawei/_index.md @@ -0,0 +1,10 @@ +--- +title: Huawei +description: "Support matrix data for Huawei Models can be found here" +weight: 5 +disableToc: false +--- + +Support matrix data for Huawei Models can be found here + +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/support-matrix/delfin/huawei/oceanstor/_index.md b/content/support-matrix/delfin/huawei/oceanstor/_index.md new file mode 100644 index 00000000..9b56c383 --- /dev/null +++ b/content/support-matrix/delfin/huawei/oceanstor/_index.md @@ -0,0 +1,469 @@ +--- +title: OceanStor +menuTitle: OceanStor +description: "OceanStor Support Matrix" +weight: 20 +disableToc: false +tags: ["support matrix", "delfin", "drivers", "huawei"] +--- + +### Model and versions supported + + + + + + + + + + + + + + +
ModelsManagement Software Versions
Storage Management SoftwareOceanStor DeviceManager V100R002C20SPC100 or later
+ +### Access information to register storage device + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Access TypeAttributesAdditional information
RESTHostOceanStor device manager host name supported with ipv4/ipv6
PortOceanStor device manager port
UsernameOceanStor device manager username
PasswordOceanStor device manager password
+ +### Alert management information + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SNMP trap processingSupported
Query backend alertSupported
Clear backend alertSupported
SNMP versions for trapV1/V2/V3
SNMP trap sourceOceanStor Device
Query alert sourceOceanStor Device Manager
+ +### Resource data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceAttributeAdditional information
DeviceNameName of storage resource
VendorVendor
DescriptionDescription
ModelModel
StatusStatus
Serial NumberIt is serial number id
Firmware VersionFirmware Version
LocationDevice Location
Total CapacityStorage total capacity(bytes)
Used CapacityIt is measured in bytes
Free CapacityIt is measured in bytes
Raw CapacityMember disk capacity(bytes)
PoolNameName of the pool
Storage IdId in the delfin system for storage device
Storage pool idActual storage pool id received from backend
DescriptionDescription
StatusStatus of the pool. Ex: available
Storage TypeType of storage. Ex: Block, file, hybrid
Total CapacityUser total capacity(bytes)
Used CapacityUser consumed capacity(bytes)
Free CapacityUser free capacity(bytes)
VolumeIdIt represents system resource id
NameVolume Name
Storage IdIt is id in the delfin system for storage device
Volume IdActual volume id received from backend
Storage pool idOriginal pool id received from backend
DescriptionDescription
TypeLogical Type. Ex:Thick, Thin
StatusStatus
WWNWWN
Total CapacityAllocated total volume capacity(bytes)
Used CapacityUsed capacity from allocated capacity(bytes) +
Free CapacityNA. It is none
CompressedWhether to support compression
DeduplicatedDeduplication is supported
ControllerIdIt represents system resource id
NameVolume Name
Storage IdIt is id in the delfin system for storage device
Controller IdOceanstor controller id
StatusStatus
LocationController location
Software VersionSoftware Version
CPU InfoCPU processor information
Memory SizeMemory size measure in bytes
PortNameName
Storage IdIt is Id within delfin system for storage device
Port idActual port id received from backend
Location
Connection StatusStatus of port connection. Ex: disconnected
Health StatusPort health status
TypeType of port. Ex:fc, iscsi, fcoe, etc.
Logical typePort logical type. Ex:frontend, maintenance, service, management, etc.
SpeedSpeed of the ports
Max SpeedMaximum speed of the ports
Parent IdId of parent object(controller/host)
WWNWWN
mac address
ipv4
ipv4 mask
ipv6
ipv6 mask
DiskNameName of storage resource
Storage IdIt is storage id within delfin system
Disk idActual disk id received from backend
Serial numberSerial Number
ManufacturerManufacturer
ModelModel
FirmwareFirmware Version
SpeedSpeed of the disk(rpm)
CapacityTotal number of disk sectors multiply by disk sector size(bytes)
StatusStatus
Physical typeDisk physical type. Ex:sata, sas, ssd, etc.
Logical typeDisk logical type. Ex:frontend, maintenance, service, management, etc.
Health ScoreDisk health score
Disk group id
LocationLocation of the disk
+ +### Alert data matrix + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeAdditional information
Alert idIdentification of alarm
Alert nameName of the alert
SeveritySeverity of the alert
CategoryCategory of the reported alarm notification. Ex: Fault, Event, Recovery
TypeType of the alert generated such as CommunicationsAlarm, EquipmentAlarm etc.
Sequence numberSequence number for the alert, uniquely identifies a + given alert instance used for clearing the alert
Occur timeTime at which alert is generated from device. Specified in epoch format
DescriptionDescription
Recovery adviceSome suggestion for handling the given alert
Resource typeResource type of device/source generating alert.This is always set to "Storage"
LocationLocation of an alarm. Specified in name/value format
\ No newline at end of file