storpool 3.0.1

note that this documents version 16.01 of the StorPool API

fix a typo in the VolumeBalancerVolumeStatus class name

document a lot of classes and fields

add volumesSpace() and the VolumeSpace type

add the volumesToRelocate member of the VolumeRelocatorStatus type

add the VolumeTemplateSpaceEstInternal, VolumeTemplateSpaceEst, and VolumeTemplateSpaceEstEntry types for the new phys and stored members of the VolumeTemplateStatusDesc type

retry the query to the StorPool API if a transient error is returned; add the transientRetries and transientSleep parameters to the Api() constructor

move the ssd member from the UpDiskSummary to the DiskSummaryBase type

add the optional info member to the ApiOk type

add the beaconStatus, clusterStatus, and joined members to the PeerDesc type

add diskScrubStart(), diskScrubPause(), and diskScrubContinue() and several scrubbing-related members to the DownDiskSummary and UpDiskSummary types

add the noFlush and noTrim members to the UpDiskSummary type

add diskRetrim()

add the startTime member and the uptime() method to the Service type

document the float property type

remove volumeRelocatorOn() and volumeRelocatorOff(); this functionality will be exposed in a better way later

add volumesReassignWait() and its VolumesReassignWaitDesc type; volumesReassign() is now deprecated

add the capacityPlaceAll and capacityPlaceTail template properties

add volumeBalancerGroups() and the VolumeBalancerSlot and VolumeBalancerAllocationGroup types

replace UpDiskTarget’s objectsToRecover attribute with a toRecover attribute for the target’s storedSize and onDiskSize members; accordingly, bump the storpool module’s version to 2.0.0 for a backwards-incompatible change

add the _asdict() method to JsonObject to fix the breakage in newer versions of simplejson when they try to look for this method using getattr(), triggering an unknown attribute JsonObject exception

add some omitted documentation titles for some rarely-used internal relocator/balancer commands

mark the disk wbc and aggregateScore properties as internal

add the missing documentation for the AttachmentDesc.volume attribute

fix a typo in a DiskWbcStats member name: ios -> iops

remove an unused internal Python object attribute

only check the defined attributes in JsonObject, ignore any additional members received in a JSON message

add snapshotsSpace() for the snapshot reverse space estimation

reflect the fact that volumeStatus() may also return an anonymous snapshot, thus the name may also be a SnapshotName

drop the “name” attribute of VolumeSummaryBase since it is always overridden in its child classes (either a volume or a snapshot name)

fix the return types of snapshotInfo() and snapshotDescribe()

add the “autoName”, “bound”, “deleted”, and “transient” snapshot flags

add the “noFua” and “isWbc” disk flags, the “wbc” write-back cache info, and the “aggregateScore” aggregation info

flesh out the volume balancer and relocator support

fix the return type of volumeCreate() and snapshotCreate() - a new type, ApiOkVolumeCreate, that extends ApiOk to add the optinal “autoName” autogenerated snapshot name

note that this documents version 15.02 of the StorPool API

fix a bug in a very rarely used initialization mode of JsonObject

add a “section” parameter to the SPConfig constructor to be able to fetch information about another host in the cluster

add the get() method with a default value to SPConfig objects

add the SnapshotUpdateDesc type, since snapshotUpdate() only accepts a subset of volumeUpdate()’s parameters

add the volumeTemplateStatus(), diskIgnore(), volumeAbandonDisk() and snapshotAbandonDisk() commands

add the “bind” parameter to volumeUpdate() and snapshotUpdate()

add the “baseOn” parameter to volumeCreate()

add some internal templateId attributes; they are returned by the StorPool management service, but they should not really be used by consumers

fix the validation of snapshot names to accept the anonymous snapshots that may be returned by the various “list snapshots” commands

properly return information about missing/down disks in disksList() and serverDisksList() - introduce a separate type for them

make the objects returned by the API calls iterable - “for i in obj” is now similar to a dictionary’s iteritems() method

make volumeCreate()’s “size” parameter optional, since the size may be defined in a volume template

rename Disk.ok to Disk.up

fix typo: CientID => ClientID

clean-up/fix peer ID types

mark a bunch of attributes as internal

use js.dumps and not str when printing values in the documentation

generate better json for optional and internal values in the documentation

export changes to ClusterStatus due to AoE and mgmt failover

add AoE commands

add the optional “propagate” parameter to volumeTemplateUpdate()

extend the validation regular expressions for the names of volumes and snapshots to support the special notation for system volumes and snapshots currently being deleted

fix the ActiveRequestDesc “name” parameter to also support snapshot names

add the “snapshot” flag to the volumeStatus() result to signify that this entry represents a snapshot and not a volume

update the API documentation

fix a HTTPConnection usage bug

fix the author e-mail address in setup.py

fix the README file’s Markdown format

relicense under the Apache 2.0 License

switch the README file to Markdown format

remove a leftover OpenStack reference from the README file

first public release