add volume collection (#94)

* add volume collection * add vc for update * [auto generated] Checking in generated offline HTML doc * patricia comments * [auto generated] Checking in generated offline HTML doc --------- Co-authored-by: Anuradha Bose <anuradha,[email protected]> Co-authored-by: AnuBose <[email protected]>
HewlettPackard · Sep 7, 2023 · af2bc4d · af2bc4d
1 parent 54cb850
commit af2bc4d
Show file tree

Hide file tree

Showing 28 changed files with 202 additions and 17 deletions.
diff --git a/v1/api/swagger/components/schemas/AddVolume.yaml b/v1/api/swagger/components/schemas/AddVolume.yaml
@@ -29,3 +29,9 @@ properties:
       The storage pool is one of those listed by the StoragePools array returned
       as part of the get /available-resources call that are available to create
       volumes of the specified flavor and location.
+  VolumeCollectionID:
+    type: string
+    format: uuid
+    description: >-
+      The  optional volume collection is one of those listed by the VolumeCollections 
+      array returned as part of the get /available-resources call 
diff --git a/v1/api/swagger/components/schemas/AvailableResources.yaml b/v1/api/swagger/components/schemas/AvailableResources.yaml
@@ -10,6 +10,7 @@ required:
   - StorageInventory
   - SSHKeys
   - StoragePools
+  - VolumeCollections
 properties:
   Images:
     type: array
@@ -67,3 +68,8 @@ properties:
     description: Array listing the available storage pools
     items:
       $ref: ./StoragePool.yaml
+  VolumeCollections:
+    type: array
+    description: Array listing the available volume collections
+    items:
+      $ref: ./VolumeCollection.yaml
diff --git a/v1/api/swagger/components/schemas/NewVolume.yaml b/v1/api/swagger/components/schemas/NewVolume.yaml
@@ -53,3 +53,9 @@ properties:
       The storage pool is one of those listed by the StoragePools array returned
       as part of the get /available-resources call that are available to create
       volumes of the specified flavor and location.
+  VolumeCollectionID:
+    type: string
+    format: uuid
+    description: >-
+      The  optional volume collection is one of those listed by the VolumeCollections 
+      array returned as part of the get /available-resources call 
diff --git a/v1/api/swagger/components/schemas/UpdateVolume.yaml b/v1/api/swagger/components/schemas/UpdateVolume.yaml
@@ -11,6 +11,11 @@ allOf:
         example: 10485760
         minimum: 0
         description: The size of the volume in KiB
+      VolumeCollectionID:
+        type: string
+        format: uuid
+        example: 90be909e-4609-40f5-9630-f24910dc8591
+        description: The volume collection the volume is a part of
       Labels:
         type: object
         additionalProperties:

diff --git a/v1/api/swagger/components/schemas/Volume.yaml b/v1/api/swagger/components/schemas/Volume.yaml
@@ -46,6 +46,12 @@ allOf:
           of those listed by the LocationInfo array returned as part of the get
           /available-resources call. Any volumes must be in the same location as
           their attached Host.
+      VolumeCollectionID:
+        type: string
+        format: uuid
+        description: >-
+          The optional volume collection ID matching an entry in the VolumeCollections array
+          returned as part of the get /available-resources call
       State:
         $ref: ./VolumeState.yaml
       SubState:

diff --git a/v1/api/swagger/components/schemas/VolumeCollection.yaml b/v1/api/swagger/components/schemas/VolumeCollection.yaml
@@ -0,0 +1,19 @@
+---
+type: object
+description: Volume collection within a data center location
+required:
+  - ID
+  - Name
+  - Description
+properties:
+  ID:
+    type: string
+    format: uuid
+    description: The ID of the volume collection resource that can be used while
+      creating a volume
+  Name:
+    type: string
+    description: The name of the volume collection resource
+  Description:
+    type: string
+    description: The description of the volume collection resource
diff --git a/v1/api/swagger/components/schemas/VolumeInfo.yaml b/v1/api/swagger/components/schemas/VolumeInfo.yaml
@@ -9,6 +9,7 @@ required:
   - Capacity
   - Shareable
   - LocationID
+  - VolumeCollectionID
   - DiscoveryIP
   - TargetIQN
   - State
@@ -47,6 +48,10 @@ properties:
     type: string
     format: uuid
     description: The location ID of the data center where the volume exists
+  VolumeCollectionID:
+    type: string
+    format: uuid
+    description: The ID of volume collection of which this volume is a member
   DiscoveryIP:
     type: string
     description: The discovery IP for the iSCSI volume

diff --git a/v1/html/index.html b/v1/html/index.html
diff --git a/v1/pkg/client/README.md b/v1/pkg/client/README.md
@@ -215,6 +215,7 @@ Class | Method | HTTP request | Description
  - [VolumeAttachHostUuid](docs/VolumeAttachHostUuid.md)
  - [VolumeAttachment](docs/VolumeAttachment.md)
  - [VolumeAttachmentAllOf](docs/VolumeAttachmentAllOf.md)
+ - [VolumeCollection](docs/VolumeCollection.md)
  - [VolumeFlavor](docs/VolumeFlavor.md)
  - [VolumeFlavorsInfo](docs/VolumeFlavorsInfo.md)
  - [VolumeInfo](docs/VolumeInfo.md)

diff --git a/v1/pkg/client/api/openapi.yaml b/v1/pkg/client/api/openapi.yaml
@@ -2909,12 +2909,14 @@ components:
           Description: Description of New Volume
           FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Capacity: 10
+          VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Name: NewVolumeName
         - Shareable: true
           Description: Description of New Volume
           FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Capacity: 10
+          VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Name: NewVolumeName
         ServiceNetsProviderMAC:
@@ -3087,25 +3089,27 @@ components:
           Name: Private
         Volumes:
         - TargetIQN: TargetIQN
+          Description: Description
+          LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          Name: MyVolume
           Shareable: true
           DiscoveryIP: DiscoveryIP
-          Description: Description
           FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Capacity: 0
-          LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-          Name: MyVolume
         - TargetIQN: TargetIQN
+          Description: Description
+          LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          Name: MyVolume
           Shareable: true
           DiscoveryIP: DiscoveryIP
-          Description: Description
           FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Capacity: 0
-          LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-          Name: MyVolume
         MachineSizes:
         - Details:
             Banner2: Banner2 value
@@ -3190,6 +3194,13 @@ components:
           Capacity: 1
           LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        VolumeCollections:
+        - Description: Description
+          ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          Name: Name
+        - Description: Description
+          ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          Name: Name
         SSHKeys:
         - ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           Key: |
@@ -3262,6 +3273,11 @@ components:
           items:
             $ref: '#/components/schemas/StoragePool'
           type: array
+        VolumeCollections:
+          description: Array listing the available volume collections
+          items:
+            $ref: '#/components/schemas/VolumeCollection'
+          type: array
       required:
       - Images
       - Locations
@@ -3271,6 +3287,7 @@ components:
       - SSHKeys
       - StorageInventory
       - StoragePools
+      - VolumeCollections
       - VolumeFlavors
       - Volumes
       type: object
@@ -3285,6 +3302,7 @@ components:
         FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         Capacity: 10
         LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         Labels:
           serviceType: BMaaS
           region: us-west-2
@@ -3335,6 +3353,12 @@ components:
             to create volumes of the specified flavor and location.
           format: uuid
           type: string
+        VolumeCollectionID:
+          description: 'The  optional volume collection is one of those listed by
+            the VolumeCollections  array returned as part of the get /available-resources
+            call '
+          format: uuid
+          type: string
       required:
       - Capacity
       - FlavorID
@@ -4231,6 +4255,7 @@ components:
         Description: Description of New Volume
         FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         Capacity: 10
+        VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         Name: NewVolumeName
       properties:
@@ -4261,6 +4286,12 @@ components:
             to create volumes of the specified flavor and location.
           format: uuid
           type: string
+        VolumeCollectionID:
+          description: 'The  optional volume collection is one of those listed by
+            the VolumeCollections  array returned as part of the get /available-resources
+            call '
+          format: uuid
+          type: string
       type: object
     UpdateHostISCSIConfig:
       nullable: true
@@ -4482,15 +4513,16 @@ components:
       description: Description of the details about a pre-existing volume
       example:
         TargetIQN: TargetIQN
+        Description: Description
+        LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        Name: MyVolume
         Shareable: true
         DiscoveryIP: DiscoveryIP
-        Description: Description
         FlavorID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         Capacity: 0
-        LocationID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        VolumeCollectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         StoragePoolID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-        Name: MyVolume
       properties:
         ID:
           description: |
@@ -4524,6 +4556,10 @@ components:
           description: The location ID of the data center where the volume exists
           format: uuid
           type: string
+        VolumeCollectionID:
+          description: The ID of volume collection of which this volume is a member
+          format: uuid
+          type: string
         DiscoveryIP:
           description: The discovery IP for the iSCSI volume
           type: string
@@ -4547,6 +4583,7 @@ components:
       - Status
       - StoragePoolID
       - TargetIQN
+      - VolumeCollectionID
       type: object
     MachineInventory:
       description: An entry describing the number of machines of a particular machine
@@ -4664,6 +4701,29 @@ components:
       - ID
       - Name
       type: object
+    VolumeCollection:
+      description: Volume collection within a data center location
+      example:
+        Description: Description
+        ID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        Name: Name
+      properties:
+        ID:
+          description: The ID of the volume collection resource that can be used while
+            creating a volume
+          format: uuid
+          type: string
+        Name:
+          description: The name of the volume collection resource
+          type: string
+        Description:
+          description: The description of the volume collection resource
+          type: string
+      required:
+      - Description
+      - ID
+      - Name
+      type: object
     VolumeState:
       description: Current volume state expressed as a string enum value (new, allocating,
         allocated, visible, deleting, deleted, failed)
@@ -6378,6 +6438,12 @@ components:
             as their attached Host.
           format: uuid
           type: string
+        VolumeCollectionID:
+          description: The optional volume collection ID matching an entry in the
+            VolumeCollections array returned as part of the get /available-resources
+            call
+          format: uuid
+          type: string
         State:
           $ref: '#/components/schemas/VolumeState'
         SubState:
@@ -6414,6 +6480,11 @@ components:
           format: int64
           minimum: 0
           type: integer
+        VolumeCollectionID:
+          description: The volume collection the volume is a part of
+          example: 90be909e-4609-40f5-9630-f24910dc8591
+          format: uuid
+          type: string
         Labels:
           additionalProperties:
             type: string

diff --git a/v1/pkg/client/docs/AddVolume.md b/v1/pkg/client/docs/AddVolume.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **Capacity** | **int64** | The size of the volume in GiB | [optional] 
 **Shareable** | **bool** | Indicates if the volume can be attached to multiple hosts | [optional] 
 **StoragePoolID** | **string** | The storage pool is one of those listed by the StoragePools array returned as part of the get /available-resources call that are available to create volumes of the specified flavor and location. | [optional] 
+**VolumeCollectionID** | **string** | The  optional volume collection is one of those listed by the VolumeCollections  array returned as part of the get /available-resources call  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/v1/pkg/client/docs/AvailableResources.md b/v1/pkg/client/docs/AvailableResources.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **StorageInventory** | [**[]StorageInventory**](StorageInventory.md) | Array providing information on the amount of available storage of each flavor in each location | 
 **SSHKeys** | [**[]SshKeyEntry**](SSHKeyEntry.md) | Array listing pre-defined SSH keys that could be referenced when creating a Host | 
 **StoragePools** | [**[]StoragePool**](StoragePool.md) | Array listing the available storage pools | 
+**VolumeCollections** | [**[]VolumeCollection**](VolumeCollection.md) | Array listing the available volume collections | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/v1/pkg/client/docs/NewVolume.md b/v1/pkg/client/docs/NewVolume.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **LocationID** | **string** | The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host. | 
 **Labels** | **map[string]string** | The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role. | [optional] 
 **StoragePoolID** | **string** | The storage pool is one of those listed by the StoragePools array returned as part of the get /available-resources call that are available to create volumes of the specified flavor and location. | [optional] 
+**VolumeCollectionID** | **string** | The  optional volume collection is one of those listed by the VolumeCollections  array returned as part of the get /available-resources call  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/v1/pkg/client/docs/UpdateVolume.md b/v1/pkg/client/docs/UpdateVolume.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **ETag** | **string** | Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated.  Client must send this value unchanged for any update operation. | 
 **Name** | **string** | Common name for the resource instance. Must be 128 or fewer printable characters | 
 **Capacity** | **int64** | The size of the volume in KiB | 
+**VolumeCollectionID** | **string** | The volume collection the volume is a part of | [optional] 
 **Labels** | **map[string]string** | The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/v1/pkg/client/docs/UpdateVolumeAllOf.md b/v1/pkg/client/docs/UpdateVolumeAllOf.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Capacity** | **int64** | The size of the volume in KiB | 
+**VolumeCollectionID** | **string** | The volume collection the volume is a part of | [optional] 
 **Labels** | **map[string]string** | The map of service/user specified label name to label value for this volume. Setting service labels is restricted by role. At minimum, this field should be set to the values specified during create. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/v1/pkg/client/docs/Volume.md b/v1/pkg/client/docs/Volume.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **Capacity** | **int64** | The size of the volume in KiB | 
 **Shareable** | **bool** | Indicates if the volume can be attached to multiple hosts | 
 **LocationID** | **string** | The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host. | 
+**VolumeCollectionID** | **string** | The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call | [optional] 
 **State** | [**VolumeState**](VolumeState.md) |  | 
 **SubState** | [**VolumeSubState**](VolumeSubState.md) |  | 
 **Status** | [**VolumeStatus**](VolumeStatus.md) |  | 

diff --git a/v1/pkg/client/docs/VolumeAllOf.md b/v1/pkg/client/docs/VolumeAllOf.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **Capacity** | **int64** | The size of the volume in KiB | 
 **Shareable** | **bool** | Indicates if the volume can be attached to multiple hosts | 
 **LocationID** | **string** | The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host. | 
+**VolumeCollectionID** | **string** | The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call | [optional] 
 **State** | [**VolumeState**](VolumeState.md) |  | 
 **SubState** | [**VolumeSubState**](VolumeSubState.md) |  | 
 **Status** | [**VolumeStatus**](VolumeStatus.md) |  | 

diff --git a/v1/pkg/client/docs/VolumeCollection.md b/v1/pkg/client/docs/VolumeCollection.md
@@ -0,0 +1,13 @@
+# VolumeCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ID** | **string** | The ID of the volume collection resource that can be used while creating a volume | 
+**Name** | **string** | The name of the volume collection resource | 
+**Description** | **string** | The description of the volume collection resource | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+