images service doc

php-opencloud · Jan 19, 2024 · d22523e · d22523e
1 parent a14ea62
commit d22523e
Show file tree

Hide file tree

Showing 27 changed files with 215 additions and 132 deletions.
diff --git a/doc/services/images/v2/create.rst b/doc/services/images/v2/create.rst
@@ -0,0 +1,12 @@
+Create Service
+==============
+
+In order to work with the service you have to :doc:`setup the client </setup>` first.
+
+Service can be created via ``imagesV2()`` method of the ``OpenStack`` object.
+
+.. sample:: Image/v2/create.php
+
+A list of additional options can be passed to the method. For example, to change the region:
+
+.. sample:: Image/v2/create_with_region.php
diff --git a/doc/services/images/v2/images.rst b/doc/services/images/v2/images.rst
@@ -1,24 +1,47 @@
 Images
 ======
 
-Create image
-------------
+A collection of files for a specific operating system (OS) that you use to create or rebuild a server.
+OpenStack provides pre-built images. You can also create custom images, or snapshots, from servers
+that you have launched. Custom images can be used for data backups or as “gold” images for additional servers.
+
+.. osdoc:: https://docs.openstack.org/api-ref/image/v2/index.html#images
+
+.. |models| replace:: images
+
+.. include:: /common/service.rst
+
+Create
+------
 
 The only required attribute when creating a new image is ``name``.
 
 .. sample:: Images/v2/images/create.php
-.. refdoc:: OpenStack/Images/v2/Service.html#method_createImage
 
-List images
------------
+Read
+----
+
+.. sample:: Images/v2/images/read.php
+
+Update
+------
+
+.. sample:: Images/v2/images/update.php
+
+Delete
+------
+
+.. sample:: Images/v2/images/delete.php
+
+List
+----
 
 .. sample:: Images/v2/images/list.php
-.. refdoc:: OpenStack/Images/v2/Service.html#method_listImages
 
 .. include:: /common/generators.rst
 
 List images sorted
-------------------
+~~~~~~~~~~~~~~~~~~
 
 Possible values for sort_key are:
 
@@ -31,37 +54,17 @@ Possible values for sort_dir are:
 
 .. sample:: Images/v2/images/list_sorted.php
 
-Show image details
-------------------
-
-.. sample:: Images/v2/images/get.php
-.. refdoc:: OpenStack/Images/v2/Service.html#method_getImage
-
-Update image
-------------
-
-.. sample:: Images/v2/images/update.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_update
-
-Delete image
-------------
-
-.. sample:: Images/v2/images/delete.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_delete
-
-Reactivate image
-----------------
+Reactivate
+----------
 
 .. sample:: Images/v2/images/reactivate.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_reactivate
 
-Deactivate image
-----------------
+Deactivate
+----------
 
 If you try to download a deactivated image, a Forbidden error is returned.
 
 .. sample:: Images/v2/images/deactivate.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_deactivate
 
 Upload binary data
 ------------------
@@ -76,10 +79,8 @@ Before you can store binary image data, you must meet the following precondition
 The size of the data that you want to store must not exceed the size that the Image service allows.
 
 .. sample:: Images/v2/images/upload_binary_data.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_uploadData
 
 Download binary data
 --------------------
 
 .. sample:: Images/v2/images/download_binary_data.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_downloadData
diff --git a/doc/services/images/v2/index.rst b/doc/services/images/v2/index.rst
@@ -1,8 +1,14 @@
 Images v2
 =========
 
+OpenStack Image (Glance) API Version 2. The project provides a service where users can upload and discover
+data assets that are meant to be used with other services.
+
+.. osdoc:: https://docs.openstack.org/api-ref/image/v2/index.html
+
 .. toctree::
     :maxdepth: 3
 
+    create
     images
     members
diff --git a/doc/services/images/v2/members.rst b/doc/services/images/v2/members.rst
@@ -1,34 +1,37 @@
 Image Members
 =============
 
-Add member to image
--------------------
+Image member is a project which can access a given VM image within Image service.
 
-.. sample:: Images/v2/members/add.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_addMember
+.. osdoc:: https://docs.openstack.org/api-ref/image/v2/index.html#sharing
 
-List image members
-------------------
+.. |models| replace:: image members
 
-.. sample:: Images/v2/members/list.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_listMembers
+.. include:: /common/service.rst
 
-.. include:: /common/generators.rst
+Create
+------
 
-Show member details
--------------------
+.. sample:: Images/v2/members/create.php
 
-.. sample:: Images/v2/members/get.php
-.. refdoc:: OpenStack/Images/v2/Models/Image.html#method_getMember
+Read
+----
 
-Remove member from image
-------------------------
+.. sample:: Images/v2/members/read.php
+
+Delete
+------
 
 .. sample:: Images/v2/members/delete.php
-.. refdoc:: OpenStack/Images/v2/Models/Member.html#method_delete
 
-Update status of image member
------------------------------
+List
+----
+
+.. sample:: Images/v2/members/list.php
+
+.. include:: /common/generators.rst
+
+Update Status
+-------------
 
 .. sample:: Images/v2/members/update_status.php
-.. refdoc:: OpenStack/Images/v2/Models/Member.html#method_updateStatus
diff --git a/samples/Compute/v2/create.php b/samples/Compute/v2/create.php
@@ -11,4 +11,4 @@
     ],
 ]);
 
-$service = $openstack->computeV2();
+$compute = $openstack->computeV2();
diff --git a/samples/Compute/v2/create_with_region.php b/samples/Compute/v2/create_with_region.php
@@ -10,4 +10,4 @@
     ],
 ]);
 
-$identity = $openstack->computeV2(['region' => '{region}']);
+$compute = $openstack->computeV2(['region' => '{region}']);
diff --git a/samples/Images/v2/create.php b/samples/Images/v2/create.php
@@ -0,0 +1,14 @@
+<?php
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
+]);
+
+$service = $openstack->imagesV2();
diff --git a/samples/Images/v2/create_with_region.php b/samples/Images/v2/create_with_region.php
@@ -0,0 +1,13 @@
+<?php
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+]);
+
+$service = $openstack->imagesV2(['region' => '{region}']);
diff --git a/samples/Images/v2/images/create.php b/samples/Images/v2/images/create.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();

diff --git a/samples/Images/v2/images/deactivate.php b/samples/Images/v2/images/deactivate.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();

diff --git a/samples/Images/v2/images/delete.php b/samples/Images/v2/images/delete.php
@@ -5,10 +5,13 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
-$openstack->imagesV2()
-    ->getImage('{imageId}')
-    ->delete();
+$service = $openstack->imagesV2();
+
+$image = $service->getImage('{imageId}');
+$image->delete();
diff --git a/samples/Images/v2/images/download_binary_data.php b/samples/Images/v2/images/download_binary_data.php
@@ -5,13 +5,14 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();
 
 $image  = $service->getImage('{imageId}');
 
-/** @var \GuzzleHttp\Psr7\Stream $stream */
 $stream = $image->downloadData();
diff --git a/samples/Images/v2/images/list.php b/samples/Images/v2/images/list.php
@@ -5,12 +5,15 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
-$images = $openstack->imagesV2()
-                    ->listImages();
+$service = $openstack->imagesV2();
+
+$images = $service->listImages();
 
 foreach ($images as $image) {
     /** @var \OpenStack\Images\v2\Models\Image $image */

diff --git a/samples/Images/v2/images/list_sorted.php b/samples/Images/v2/images/list_sorted.php
@@ -5,11 +5,15 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
-$images = $openstack->imagesV2()->listImages(['sortKey' => '{sortKey}', 'sortDir' => '{sortDir}']);
+$service = $openstack->imagesV2();
+
+$images = $service->listImages(['sortKey' => '{sortKey}', 'sortDir' => '{sortDir}']);
 
 foreach ($images as $image) {
     /** @var \OpenStack\Images\v2\Models\Image $image */

diff --git a/samples/Images/v2/images/reactivate.php b/samples/Images/v2/images/reactivate.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();

diff --git a/samples/Images/v2/images/get.php → samples/Images/v2/images/read.php b/samples/Images/v2/images/get.php → samples/Images/v2/images/read.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();

diff --git a/samples/Images/v2/images/update.php b/samples/Images/v2/images/update.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();

diff --git a/samples/Images/v2/images/upload_binary_data.php b/samples/Images/v2/images/upload_binary_data.php
@@ -5,8 +5,10 @@
 $openstack = new OpenStack\OpenStack([
     'authUrl' => '{authUrl}',
     'region'  => '{region}',
-    'user'    => ['id' => '{userId}', 'password' => '{password}'],
-    'scope'   => ['project' => ['id' => '{projectId}']]
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}',
+    ],
 ]);
 
 $service = $openstack->imagesV2();