Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/_exts/samples.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ def run(self):
def visit_download_reference(self, node):
self.context.append('<a href="javascript:void(0);" class="toggle btn">Show auth code</a>')

def depart_download_reference(self, node):
self.body.append(self.context.pop())

def setup(app):
app.add_node(download_reference, html=(visit_download_reference, HTMLTranslator.depart_download_reference))
app.add_node(download_reference, html=(visit_download_reference, depart_download_reference))
app.add_directive('sample', Sample)
return {'version': '0.1'}
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
primary_domain = 'php'

extensions = ['sphinxcontrib.phpdomain', 'samples', 'refdoc']
extensions = ['samples', 'refdoc', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinxcontrib.phpdomain']
source_suffix = '.rst'
master_doc = 'index'
project = u'php-opencloud'
Expand Down
12 changes: 12 additions & 0 deletions doc/services/identity/v2/authentication.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Authentication
==============

Identity v2.0
-------------

We recommend users to use identity v3 when possible.

RackSpace cloud and OVH cloud, however, are still using Keystone v2.0. This following code will work for such providers.


.. sample:: identity/v2/authentication.php
7 changes: 7 additions & 0 deletions doc/services/identity/v2/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Identity v2
===========

.. toctree::
:maxdepth: 3

authentication
6 changes: 5 additions & 1 deletion doc/services/networking/v2/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,8 @@ Networking v2

networks
subnets
ports
ports
loadbalancers
loadbalancer-pools
loadbalancer-listeners
loadbalancer-healthmonitors
12 changes: 6 additions & 6 deletions doc/services/networking/v2/loadbalancer-healthmonitors.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
LoadBalancer HealthMonitors
=====
===========================

Create HealthMonitor
-----------
--------------------

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

Get HealthMonitor
-----------
-----------------

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

List HealthMonitors
-----------
-------------------

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

Update HealthMonitor
-----------
--------------------

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

Delete HealthMonitor
-----------
--------------------

.. sample:: networking/v2/lbaas/healthmonitors/delete.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerHealthMonitor.html#method_delete
12 changes: 6 additions & 6 deletions doc/services/networking/v2/loadbalancer-listeners.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
LoadBalancer Listeners
=====
======================

Create Listener
-----------
---------------

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

Get Listener
-----------
------------

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

List Listeners
-----------
--------------

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

Update Listener
-----------
---------------

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

Delete Listener
-----------
---------------

.. sample:: networking/v2/lbaas/listeners/delete.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerListener.html#method_delete
14 changes: 7 additions & 7 deletions doc/services/networking/v2/loadbalancer-pools.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
LoadBalancer Pools
=====
==================

Create Pool
-----------
Expand All @@ -8,13 +8,13 @@ Create Pool
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerPool

Get Pool
-----------
--------

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

List Pools
-----------
----------

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

Add Member
-----------
----------

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

Get Member
-----------
----------

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

Delete Member
-----------
-------------

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

Add Health Monitor
-----------
------------------

.. sample:: networking/v2/lbaas/pools/add-healthmonitor.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_addHealthMonitor
18 changes: 9 additions & 9 deletions doc/services/networking/v2/loadbalancers.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
LoadBalancers
=====
=============

Create LoadBalancer
-----------
-------------------

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

Get LoadBalancer
-----------
----------------

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

List LoadBalancers
-----------
------------------

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

Update LoadBalancer
-----------
-------------------

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

Delete LoadBalancer
-----------
-------------------

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

Add Listener to LoadBalancer
-----------
----------------------------
.. sample:: networking/v2/lbaas/loadbalancers/add_listener.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_addListener

Get Stats for LoadBalancer
-----------
--------------------------
.. sample:: networking/v2/lbaas/loadbalancers/get_stats.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStats

Get Status Tree for LoadBalancer
-----------
--------------------------------
.. sample:: networking/v2/lbaas/loadbalancers/get_statuses.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStatuses
30 changes: 30 additions & 0 deletions samples/identity/v2/authentication.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use OpenStack\Common\Transport\Utils as TransportUtils;
use OpenStack\OpenStack;

$authUrl = 'https://keystone.example.com:5000/v2.0';

$options = [
'authUrl' => $authUrl,
'region' => 'RegionOne',
'username' => 'foo',
'password' => 'bar',
'tenantName' => 'baz',
'identityService' => new Client(
[
'base_uri' => TransportUtils::normalizeUrl($authUrl),
'handler' => HandlerStack::create(),
]
),
];

/** @var OpenStack $openstack */
$openstack = new OpenStack($options);

/** @var \OpenStack\Compute\v2\Models\Server[] $servers */
$servers = $openstack->computeV2()->listServers();