Skip to content

Commit 72b7496

Browse files
authored
Merge pull request #204 from php-opencloud/identity-v2
Added docs and example to work with identity v2.0
2 parents 40f7ec9 + 8cdf33e commit 72b7496

File tree

10 files changed

+89
-31
lines changed

10 files changed

+89
-31
lines changed

doc/_exts/samples.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@ def run(self):
3232
def visit_download_reference(self, node):
3333
self.context.append('<a href="javascript:void(0);" class="toggle btn">Show auth code</a>')
3434

35+
def depart_download_reference(self, node):
36+
self.body.append(self.context.pop())
37+
3538
def setup(app):
36-
app.add_node(download_reference, html=(visit_download_reference, HTMLTranslator.depart_download_reference))
39+
app.add_node(download_reference, html=(visit_download_reference, depart_download_reference))
3740
app.add_directive('sample', Sample)
3841
return {'version': '0.1'}

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
2424
primary_domain = 'php'
2525

26-
extensions = ['sphinxcontrib.phpdomain', 'samples', 'refdoc']
26+
extensions = ['samples', 'refdoc', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinxcontrib.phpdomain']
2727
source_suffix = '.rst'
2828
master_doc = 'index'
2929
project = u'php-opencloud'
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Authentication
2+
==============
3+
4+
Identity v2.0
5+
-------------
6+
7+
We recommend users to use identity v3 when possible.
8+
9+
RackSpace cloud and OVH cloud, however, are still using Keystone v2.0. This following code will work for such providers.
10+
11+
12+
.. sample:: identity/v2/authentication.php

doc/services/identity/v2/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Identity v2
2+
===========
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
authentication

doc/services/networking/v2/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ Networking v2
66

77
networks
88
subnets
9-
ports
9+
ports
10+
loadbalancers
11+
loadbalancer-pools
12+
loadbalancer-listeners
13+
loadbalancer-healthmonitors
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
LoadBalancer HealthMonitors
2-
=====
2+
===========================
33

44
Create HealthMonitor
5-
-----------
5+
--------------------
66

77
.. sample:: networking/v2/lbaas/healthmonitors/create.php
88
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerHealthMonitor
99

1010
Get HealthMonitor
11-
-----------
11+
-----------------
1212

1313
.. sample:: networking/v2/lbaas/healthmonitors/get.php
1414
.. refdoc:: OpenStack/Networking/v2/Service.html#method_getLoadBalancerHealthMonitor
1515

1616
List HealthMonitors
17-
-----------
17+
-------------------
1818

1919
.. sample:: networking/v2/lbaas/healthmonitors/list.php
2020
.. refdoc:: OpenStack/Networking/v2/Service.html#method_listLoadBalancerHealthMonitors
2121

2222
Update HealthMonitor
23-
-----------
23+
--------------------
2424

2525
.. sample:: networking/v2/lbaas/healthmonitors/update.php
2626
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerHealthMonitor.html#method_update
2727

2828
Delete HealthMonitor
29-
-----------
29+
--------------------
3030

3131
.. sample:: networking/v2/lbaas/healthmonitors/delete.php
3232
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerHealthMonitor.html#method_delete
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
LoadBalancer Listeners
2-
=====
2+
======================
33

44
Create Listener
5-
-----------
5+
---------------
66

77
.. sample:: networking/v2/lbaas/listeners/create.php
88
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerListener
99

1010
Get Listener
11-
-----------
11+
------------
1212

1313
.. sample:: networking/v2/lbaas/listeners/get.php
1414
.. refdoc:: OpenStack/Networking/v2/Service.html#method_getLoadBalancerListener
1515

1616
List Listeners
17-
-----------
17+
--------------
1818

1919
.. sample:: networking/v2/lbaas/listeners/list.php
2020
.. refdoc:: OpenStack/Networking/v2/Service.html#method_listLoadBalancerListeners
2121

2222
Update Listener
23-
-----------
23+
---------------
2424

2525
.. sample:: networking/v2/lbaas/listeners/update.php
2626
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerListener.html#method_update
2727

2828
Delete Listener
29-
-----------
29+
---------------
3030

3131
.. sample:: networking/v2/lbaas/listeners/delete.php
3232
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerListener.html#method_delete

doc/services/networking/v2/loadbalancer-pools.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
LoadBalancer Pools
2-
=====
2+
==================
33

44
Create Pool
55
-----------
@@ -8,13 +8,13 @@ Create Pool
88
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerPool
99

1010
Get Pool
11-
-----------
11+
--------
1212

1313
.. sample:: networking/v2/lbaas/pools/get.php
1414
.. refdoc:: OpenStack/Networking/v2/Service.html#method_getLoadBalancerPool
1515

1616
List Pools
17-
-----------
17+
----------
1818

1919
.. sample:: networking/v2/lbaas/pools/list.php
2020
.. refdoc:: OpenStack/Networking/v2/Service.html#method_listLoadBalancerPools
@@ -32,25 +32,25 @@ Delete Pool
3232
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_delete
3333

3434
Add Member
35-
-----------
35+
----------
3636

3737
.. sample:: networking/v2/lbaas/pools/add-member.php
3838
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_addMember
3939

4040
Get Member
41-
-----------
41+
----------
4242

4343
.. sample:: networking/v2/lbaas/pools/get-member.php
4444
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_getMember
4545

4646
Delete Member
47-
-----------
47+
-------------
4848

4949
.. sample:: networking/v2/lbaas/pools/delete-member.php
5050
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_deleteMember
5151

5252
Add Health Monitor
53-
-----------
53+
------------------
5454

5555
.. sample:: networking/v2/lbaas/pools/add-healthmonitor.php
5656
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_addHealthMonitor
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
11
LoadBalancers
2-
=====
2+
=============
33

44
Create LoadBalancer
5-
-----------
5+
-------------------
66

77
.. sample:: networking/v2/lbaas/loadbalancers/create.php
88
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancer
99

1010
Get LoadBalancer
11-
-----------
11+
----------------
1212

1313
.. sample:: networking/v2/lbaas/loadbalancers/get.php
1414
.. refdoc:: OpenStack/Networking/v2/Service.html#method_getLoadBalancer
1515

1616
List LoadBalancers
17-
-----------
17+
------------------
1818

1919
.. sample:: networking/v2/lbaas/loadbalancers/list.php
2020
.. refdoc:: OpenStack/Networking/v2/Service.html#method_listLoadBalancers
2121

2222
Update LoadBalancer
23-
-----------
23+
-------------------
2424

2525
.. sample:: networking/v2/lbaas/loadbalancers/update.php
2626
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_update
2727

2828
Delete LoadBalancer
29-
-----------
29+
-------------------
3030

3131
.. sample:: networking/v2/lbaas/loadbalancers/delete.php
3232
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_delete
3333

3434
Add Listener to LoadBalancer
35-
-----------
35+
----------------------------
3636
.. sample:: networking/v2/lbaas/loadbalancers/add_listener.php
3737
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_addListener
3838

3939
Get Stats for LoadBalancer
40-
-----------
40+
--------------------------
4141
.. sample:: networking/v2/lbaas/loadbalancers/get_stats.php
4242
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStats
4343

4444
Get Status Tree for LoadBalancer
45-
-----------
45+
--------------------------------
4646
.. sample:: networking/v2/lbaas/loadbalancers/get_statuses.php
4747
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStatuses
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
require 'vendor/autoload.php';
4+
5+
use GuzzleHttp\Client;
6+
use GuzzleHttp\HandlerStack;
7+
use OpenStack\Common\Transport\Utils as TransportUtils;
8+
use OpenStack\OpenStack;
9+
10+
$authUrl = 'https://keystone.example.com:5000/v2.0';
11+
12+
$options = [
13+
'authUrl' => $authUrl,
14+
'region' => 'RegionOne',
15+
'username' => 'foo',
16+
'password' => 'bar',
17+
'tenantName' => 'baz',
18+
'identityService' => new Client(
19+
[
20+
'base_uri' => TransportUtils::normalizeUrl($authUrl),
21+
'handler' => HandlerStack::create(),
22+
]
23+
),
24+
];
25+
26+
/** @var OpenStack $openstack */
27+
$openstack = new OpenStack($options);
28+
29+
/** @var \OpenStack\Compute\v2\Models\Server[] $servers */
30+
$servers = $openstack->computeV2()->listServers();
31+
32+

0 commit comments

Comments
 (0)