dell / PyU4V

PyU4V is a Python module that simplifies interaction with the Unisphere for PowerMax REST API. It wraps REST calls with simple APIs that abstracts the HTTP request and response handling.
Apache License 2.0
41 stars 37 forks source link

Schemas for the data model used in PyU4V #162

Closed arthurzenika closed 1 year ago

arthurzenika commented 1 year ago

It would be nice to have some graphical documentation of how the data model works in PyU4V and Dell's products it talks to.

Here is a draft documentation I made (plantUML rendered by mermaidjs) :

classDiagram
    class storage_group{
        StorageGroupId
        service_level
        slo_compliance
        type [Parent|Standalone|Child]
    }
    class masking_view{
        volumeId
    }
    class host{

    }
    masking_view --|> host
    masking_view --|> host_group
    host_group --|> host
    masking_view --|> port_group
    storage_group <|-- masking_view : maskingview
    storage_group <|-- storage_group: child_storage_group
    storage_group --|> storage
    storage --|> volume
    class storage{
        volumeId
        wwn
    }
    class volume{
        volumeId
        type
        emulation
        ssid
        allocated_percent
        cap_gb
        cap_mb
        cap_cyl
        status
        reserved
        pinned
        physical_name
        volume_identifier
        wwn
        encapsulated
        num_of_storage_groups
        num_of_front_end_paths
        pmaxname
        pmaxsymmetrixid
    }
    volume --|> storage_group: get_storage_group_from_volume(volumeId)

Do you think this could be useful to others ?

rawstorage commented 1 year ago

Hi Arthur, sorry for the late response on this one, this is definitely useful however might be difficult to keep up to date. I'll see if there is a way we can put a wiki on the Git or if we could include as part of the readthedocs.