add OpenStack creation

k0ka · Jan 30, 2024 · Jan 17, 2024 · Jan 17, 2024 · Jan 17, 2024 · Jan 17, 2024
commit 807a13b0e2d44af97ca8befa104384a261de59aa
diff --git a/doc/quick-start.rst b/doc/quick-start.rst
@@ -18,6 +18,9 @@ You must install this library through Composer:
 
 If you do not have Composer installed, please read the `Composer installation instructions`_.
 
+Include the autoloader
+----------------------
+
 Once you have installed the SDK as a dependency of your project, you will need to load Composer’s autoloader
 (which registers all the required namespaces). To do this, place the following line of PHP code at the top of your
 application’s PHP files:
@@ -29,4 +32,42 @@ application’s PHP files:
 This assumes your application's PHP files are located in the same folder as ``vendor/``. If your files are located
 elsewhere, please supply the path to vendor/autoload.php in the require statement above.
 
+Creating a client
+-----------------
+
+To create a client, you will need to provide the following information:
+* The identity service URL (``authUrl``)
+* The region in which you want to operate (``region``)
+* The credentials of the user you want to authenticate (``user``), (``tokenId``), (``cachedToken``)
+    or (``application_credential``)
+
+Only the ``authUrl`` is mandatory to create a client. But you will have to provide the ``region`` and ``user``
+to each service you create. So it is recommended to provide them when creating the client.
+
+There are different ways to provide the authentication credentials. See the `Token generation`_ section for
+the full list of options. Here is an example of how to create a client with a user id and password:
+
+.. code-block:: php
+    $openstack = new OpenStack\OpenStack([
+        'authUrl' => '{authUrl}',
+        'region'  => '{region}',
+        'user'    => [
+            'id'       => '{userId}',
+            'password' => '{password}'
+        ],
+    ]);
+
+Here is an example of how to create a client with application credentials:
+
+.. code-block:: php
+    $openstack = new OpenStack\OpenStack([
+        'authUrl' => '{authUrl}',
+        'region'  => '{region}',
+        'application_credential' => [
+            'id'     => '{applicationCredentialId}',
+            'secret' => '{secret}'
+        ]
+    ]);
+
 .. _Composer installation instructions: https://getcomposer.org/doc/00-intro.md
+.. _Token generation: /services/identity/v3/tokens
diff --git a/doc/services/identity/v3/index.rst b/doc/services/identity/v3/index.rst
@@ -1,6 +1,20 @@
 Identity v3
 ===========
 
+Creating the service
+--------------------
+
+Service can be created via `identityV3` method of `OpenStack` object:
+.. code-block:: php
+    $service = $openstack->identityV3();
+
+A list of additional options can be passed to the method. For example, to change the region:
+.. code-block:: php
+    $service = $openstack->identityV3(['region' => '{region}']);
+
+Service methods
+---------------
+
 .. toctree::
   :maxdepth: 3