diff --git a/doc/_exts/samples.py b/doc/_exts/samples.py index daa25a22..5daa1f9a 100644 --- a/doc/_exts/samples.py +++ b/doc/_exts/samples.py @@ -32,7 +32,10 @@ def run(self): def visit_download_reference(self, node): self.context.append('Show auth code') +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'} diff --git a/doc/conf.py b/doc/conf.py index 201fb459..9394ea7d 100755 --- a/doc/conf.py +++ b/doc/conf.py @@ -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' diff --git a/doc/services/identity/v2/authentication.rst b/doc/services/identity/v2/authentication.rst new file mode 100644 index 00000000..eb3edfc6 --- /dev/null +++ b/doc/services/identity/v2/authentication.rst @@ -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 diff --git a/doc/services/identity/v2/index.rst b/doc/services/identity/v2/index.rst new file mode 100644 index 00000000..d4f39ac1 --- /dev/null +++ b/doc/services/identity/v2/index.rst @@ -0,0 +1,7 @@ +Identity v2 +=========== + +.. toctree:: + :maxdepth: 3 + + authentication \ No newline at end of file diff --git a/doc/services/networking/v2/index.rst b/doc/services/networking/v2/index.rst index 37a4f87b..2b545644 100644 --- a/doc/services/networking/v2/index.rst +++ b/doc/services/networking/v2/index.rst @@ -6,4 +6,8 @@ Networking v2 networks subnets - ports \ No newline at end of file + ports + loadbalancers + loadbalancer-pools + loadbalancer-listeners + loadbalancer-healthmonitors \ No newline at end of file diff --git a/doc/services/networking/v2/loadbalancer-healthmonitors.rst b/doc/services/networking/v2/loadbalancer-healthmonitors.rst index 76f8973c..5a8a27ba 100644 --- a/doc/services/networking/v2/loadbalancer-healthmonitors.rst +++ b/doc/services/networking/v2/loadbalancer-healthmonitors.rst @@ -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 diff --git a/doc/services/networking/v2/loadbalancer-listeners.rst b/doc/services/networking/v2/loadbalancer-listeners.rst index 563e2ca5..90237d86 100644 --- a/doc/services/networking/v2/loadbalancer-listeners.rst +++ b/doc/services/networking/v2/loadbalancer-listeners.rst @@ -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 diff --git a/doc/services/networking/v2/loadbalancer-pools.rst b/doc/services/networking/v2/loadbalancer-pools.rst index 90774bf8..ce148918 100644 --- a/doc/services/networking/v2/loadbalancer-pools.rst +++ b/doc/services/networking/v2/loadbalancer-pools.rst @@ -1,5 +1,5 @@ LoadBalancer Pools -===== +================== Create Pool ----------- @@ -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 @@ -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 diff --git a/doc/services/networking/v2/loadbalancers.rst b/doc/services/networking/v2/loadbalancers.rst index fdc11546..1733a54d 100644 --- a/doc/services/networking/v2/loadbalancers.rst +++ b/doc/services/networking/v2/loadbalancers.rst @@ -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 diff --git a/samples/identity/v2/authentication.php b/samples/identity/v2/authentication.php new file mode 100644 index 00000000..3bf77255 --- /dev/null +++ b/samples/identity/v2/authentication.php @@ -0,0 +1,32 @@ + $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(); + +