Compute instance: attach/detach volume, list volume attachments

Author: haphan

samples/compute/v2/servers/attach_detach_volume_attachment.php

@@ -0,0 +1,28 @@
+<?php
+
+use OpenStack\BlockStorage\v2\Models\VolumeAttachment;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroupRule;
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+$compute = $openstack->computeV2(['region' => '{region}']);
+
+$server = $compute->getServer(['id' => 'uuid']);
+
+/**@var VolumeAttachment $volumeAttachment*/
+$volumeAttachment = $server->attachVolume('{volume_uuid}');
+
+
+//Must detach by volumeAttachment id
+$server->detachVolume($volumeAttachment->id);

samples/compute/v2/servers/list_volume_attachments.php

@@ -0,0 +1,27 @@
+<?php
+
+use OpenStack\BlockStorage\v2\Models\VolumeAttachment;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
+use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroupRule;
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+$compute = $openstack->computeV2(['region' => '{region}']);
+
+$server = $compute->getServer(['id' => 'uuid']);
+
+foreach($server->listVolumeAttachments() as $volumeAttachment)
+{
+    /**@var VolumeAttachment $volumeAttachment*/
+    print_r($volumeAttachment);
+}

src/BlockStorage/v2/Models/VolumeAttachment.php

@@ -0,0 +1,28 @@
+<?php declare (strict_types=1);
+namespace OpenStack\BlockStorage\v2\Models;
+
+use OpenCloud\Common\Resource\OperatorResource;
+
+/**
+ * @property \OpenStack\BlockStorage\v2\Api $api
+ */
+class VolumeAttachment extends OperatorResource
+{
+    /** @var string */
+    public $id;
+
+    /** @var int */
+    public $device;
+
+    /** @var string */
+    public $serverId;
+
+    /** @var string */
+    public $volumeId;
+
+    protected $resourceKey = 'volumeAttachment';
+    protected $resourcesKey = 'volumeAttachments';
+
+    protected $aliases = [
+    ];
+}

src/Compute/v2/Api.php

@@ -510,4 +510,41 @@ public function listSecurityGroupByServer(): array
         ];
     }
 
+    public function listVolumeAttachments(): array
+    {
+        return [
+            'method' => 'GET',
+            'path' => 'servers/{id}/os-volume_attachments',
+            'jsonKey' => 'volumeAttachments',
+            'params' => [
+                'id' => $this->params->urlId('server')
+            ]
+        ];
+    }
+
+    public function attachVolume(): array
+    {
+        return [
+            'method' => 'POST',
+            'path' => 'servers/{id}/os-volume_attachments',
+            'jsonKey' => 'volumeAttachment',
+            'params' => [
+                'id' => $this->params->urlId('server'),
+                'volumeId' => $this->params->volumeId()
+            ]
+        ];
+    }
+
+    public function detachVolume(): array
+    {
+        return [
+            'method' => 'DELETE',
+            'path' => 'servers/{id}/os-volume_attachments/{attachmentId}',
+            'params' => [
+                'id' => $this->params->urlId('server'),
+                'attachmentId' => $this->params->attachmentId()
+            ]
+        ];
+    }
+
 }

src/Compute/v2/Models/Server.php

@@ -10,6 +10,8 @@
 use OpenCloud\Common\Resource\Updateable;
 use OpenCloud\Common\Resource\OperatorResource;
 use OpenCloud\Common\Transport\Utils;
+use OpenStack\BlockStorage\v2\Models\Volume;
+use OpenStack\BlockStorage\v2\Models\VolumeAttachment;
 use OpenStack\Compute\v2\Enum;
 use OpenStack\Networking\v2\Extensions\SecurityGroups\Models\SecurityGroup;
 use Psr\Http\Message\ResponseInterface;
@@ -338,4 +340,32 @@ public function listSecurityGroups()
     {
         return $this->model(SecurityGroup::class)->enumerate($this->api->listSecurityGroupByServer(), ['id' => $this->id]);
     }
+
+
+    /**
+     * Returns Generator for SecurityGroups
+     *
+     * @return \Generator
+     */
+    public function listVolumeAttachments()
+    {
+        return $this->model(VolumeAttachment::class)->enumerate($this->api->listVolumeAttachments(),['id' => $this->id]);
+    }
+
+    /**
+     * @param $volumeId
+     *
+     * @return VolumeAttachment
+     */
+    public function attachVolume($volumeId)
+    {
+        $response =  $this->execute($this->api->attachVolume(), ['id' => $this->id, 'volumeId' => $volumeId]);
+
+        return $this->model(VolumeAttachment::class)->populateFromResponse($response);
+    }
+
+    public function detachVolume($attachmentId)
+    {
+        return $this->execute($this->api->detachVolume(), ['id' => $this->id, 'attachmentId' => $attachmentId]);
+    }
 }

src/Compute/v2/Params.php

@@ -429,4 +429,21 @@ public function flavorSwap(): array
         ];
     }
 
+    public function volumeId(): array
+    {
+        return [
+            'type'     => self::STRING_TYPE,
+            'location' => self::JSON,
+        ];
+    }
+
+    public function attachmentId(): array
+    {
+        return [
+            'type'     => self::STRING_TYPE,
+            'location' => self::URL,
+            'required' => true,
+        ];
+    }
+
 }