use cinder/block-storage instead of cinderv3/volumev3

k0ka · k0ka · commit 113b829b602a · 2025-06-02T16:36:38.000+02:00
diff --git a/doc/services/block-storage/v3/index.rst b/doc/services/block-storage/v3/index.rst
@@ -4,6 +4,13 @@ Block Storage v3
 OpenStack Block Storage API v3 (Cinder). Cinder is the OpenStack Block Storage service for providing volumes
 to Nova virtual machines, Ironic bare metal hosts, containers and more.
 
+.. note::
+
+    By default we are creating Cinder service with ``cinderv3`` name and ``volumev3`` type.
+    This is left for backward compatibility and would be changed on the next major release of OpenStack SDK.
+    It's made to be compatible with the old OpenStack installations where the 2nd version of Cinder was also installed.
+    Check your service name and type. New installations would use ``cinder`` name and ``block-storage`` type.
+
 .. osdoc:: https://docs.openstack.org/api-ref/block-storage/v3/
 
 .. toctree::
diff --git a/samples/BlockStorage/v3/snapshots/create.php b/samples/BlockStorage/v3/snapshots/create.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->createSnapshot([
     'volumeId'    => '{volumeId}',
diff --git a/samples/BlockStorage/v3/snapshots/delete.php b/samples/BlockStorage/v3/snapshots/delete.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->getSnapshot('{snapshotId}');
 $snapshot->delete();
diff --git a/samples/BlockStorage/v3/snapshots/get.php b/samples/BlockStorage/v3/snapshots/get.php
@@ -9,6 +9,6 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->getSnapshot('{snapshotId}');
diff --git a/samples/BlockStorage/v3/snapshots/get_metadata.php b/samples/BlockStorage/v3/snapshots/get_metadata.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $metadata = $service->getSnapshot('{snapshotId}')
                     ->getMetadata();
diff --git a/samples/BlockStorage/v3/snapshots/list.php b/samples/BlockStorage/v3/snapshots/list.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshots = $service->listSnapshots();
 
diff --git a/samples/BlockStorage/v3/snapshots/list_detail.php b/samples/BlockStorage/v3/snapshots/list_detail.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshots = $service->listSnapshots(true);
 
diff --git a/samples/BlockStorage/v3/snapshots/list_sorted.php b/samples/BlockStorage/v3/snapshots/list_sorted.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshots = $service->listSnapshots(false, ['sortKey' => '{sortKey}', 'sortDir' => '{sortDir}']);
 
diff --git a/samples/BlockStorage/v3/snapshots/merge_metadata.php b/samples/BlockStorage/v3/snapshots/merge_metadata.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->getSnapshot('{snapshotId}');
 
diff --git a/samples/BlockStorage/v3/snapshots/reset_metadata.php b/samples/BlockStorage/v3/snapshots/reset_metadata.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->getSnapshot('{snapshotId}');
 
diff --git a/samples/BlockStorage/v3/snapshots/update.php b/samples/BlockStorage/v3/snapshots/update.php
@@ -9,7 +9,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $snapshot = $service->getSnapshot('{snapshotId}');
 
diff --git a/samples/BlockStorage/v3/volume_types/create.php b/samples/BlockStorage/v3/volume_types/create.php
@@ -11,7 +11,7 @@
     ,
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumeType = $service->createVolumeType([
     'name' => '{name}',
diff --git a/samples/BlockStorage/v3/volume_types/delete.php b/samples/BlockStorage/v3/volume_types/delete.php
@@ -11,7 +11,7 @@
     ,
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumeType = $service->getVolumeType('{volumeTypeId}');
 $volumeType->delete();
diff --git a/samples/BlockStorage/v3/volume_types/list.php b/samples/BlockStorage/v3/volume_types/list.php
@@ -11,7 +11,7 @@
     ,
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumeTypes = $service->listVolumeTypes();
 
diff --git a/samples/BlockStorage/v3/volume_types/read.php b/samples/BlockStorage/v3/volume_types/read.php
@@ -11,7 +11,7 @@
     ,
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumeType = $service->getVolumeType('{volumeTypeId}');
 $volumeType->retrieve();
diff --git a/samples/BlockStorage/v3/volume_types/update.php b/samples/BlockStorage/v3/volume_types/update.php
@@ -11,7 +11,7 @@
     ,
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumeType = $service->getVolumeType('{volumeTypeId}');
 $volumeType->name = '{newName}';
diff --git a/samples/BlockStorage/v3/volumes/create.php b/samples/BlockStorage/v3/volumes/create.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->createVolume([
     'description' => '{description}',
diff --git a/samples/BlockStorage/v3/volumes/create_from_image.php b/samples/BlockStorage/v3/volumes/create_from_image.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->createVolume([
     'description' => '{description}',
diff --git a/samples/BlockStorage/v3/volumes/create_from_snapshot.php b/samples/BlockStorage/v3/volumes/create_from_snapshot.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->createVolume([
     'description' => '{description}',
diff --git a/samples/BlockStorage/v3/volumes/create_from_volume.php b/samples/BlockStorage/v3/volumes/create_from_volume.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->createVolume([
     'description'    => '{description}',
diff --git a/samples/BlockStorage/v3/volumes/delete.php b/samples/BlockStorage/v3/volumes/delete.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->getVolume('{volumeId}');
 $volume->delete();
diff --git a/samples/BlockStorage/v3/volumes/list.php b/samples/BlockStorage/v3/volumes/list.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volumes = $service->listVolumes();
 
diff --git a/samples/BlockStorage/v3/volumes/list_detail.php b/samples/BlockStorage/v3/volumes/list_detail.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 foreach ($service->listVolumes(true) as $volume) {
     /** @var $volume \OpenStack\BlockStorage\v2\Models\Volume */
diff --git a/samples/BlockStorage/v3/volumes/read.php b/samples/BlockStorage/v3/volumes/read.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->getVolume('{volumeId}');
 $volume->retrieve();
diff --git a/samples/BlockStorage/v3/volumes/update.php b/samples/BlockStorage/v3/volumes/update.php
@@ -11,7 +11,7 @@
     ],
 ]);
 
-$service = $openstack->blockStorageV3();
+$service = $openstack->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
 
 $volume = $service->getVolume('{volumeId}');
 
diff --git a/tests/sample/TestCase.php b/tests/sample/TestCase.php
@@ -48,7 +48,7 @@ protected function getCachedService(string $serviceType): AbstractService
                 $service = $this->getOpenStack()->blockStorageV2();
                 break;
             case \OpenStack\BlockStorage\v3\Service::class:
-                $service = $this->getOpenStack()->blockStorageV3();
+                $service = $this->getOpenStack()->blockStorageV3(['catalogName' => 'cinder', 'catalogType' => 'block-storage']);
                 break;
             case \OpenStack\Compute\v2\Service::class:
                 $service = $this->getOpenStack()->computeV2();
