Skip to content

Commit

Permalink
new docs for networking
Browse files Browse the repository at this point in the history
  • Loading branch information
k0ka committed Jan 30, 2024
1 parent 52df2be commit 8eba760
Show file tree
Hide file tree
Showing 38 changed files with 312 additions and 359 deletions.
3 changes: 3 additions & 0 deletions doc/services/networking/v2/create.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. |method| replace:: networkingV2

.. include:: /common/create-service.rst
6 changes: 6 additions & 0 deletions doc/services/networking/v2/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
Networking v2
=============

OpenStack Networking (Neutron) API Version 2. The project provides “network connectivity as a service” between
interface devices (e.g., vNICs) managed by other OpenStack services (e.g., nova).

.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html

.. toctree::
:maxdepth: 3

create
networks
subnets
ports
Expand Down
40 changes: 22 additions & 18 deletions doc/services/networking/v2/loadbalancer-healthmonitors.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
LoadBalancer HealthMonitors
===========================

Create HealthMonitor
--------------------
.. warning::
Load balancing functions accessed via the neutron endpoint are deprecated and will be removed in a future release.
Users are strongly encouraged to migrate to using the octavia endpoint.
This library does not support the octavia endpoint yet.
Consider `helping <https://github.com/php-opencloud/openstack/pulls>`_ us to implement it .

.. sample:: Networking/v2/lbaas/healthmonitors/create.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerHealthMonitor
.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#load-balancer-as-a-service-2-0-deprecated

Get HealthMonitor
-----------------
Create
------

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

List HealthMonitors
-------------------
Read
----

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

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

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

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

.. sample:: Networking/v2/lbaas/healthmonitors/delete.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerHealthMonitor.html#method_delete

List
----

.. sample:: Networking/v2/lbaas/healthmonitors/list.php

39 changes: 21 additions & 18 deletions doc/services/networking/v2/loadbalancer-listeners.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
LoadBalancer Listeners
======================

Create Listener
---------------
.. warning::
Load balancing functions accessed via the neutron endpoint are deprecated and will be removed in a future release.
Users are strongly encouraged to migrate to using the octavia endpoint.
This library does not support the octavia endpoint yet.
Consider `helping <https://github.com/php-opencloud/openstack/pulls>`_ us to implement it .

.. sample:: Networking/v2/lbaas/listeners/create.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerListener
.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#load-balancer-as-a-service-2-0-deprecated

Get Listener
------------
Create
------

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

List Listeners
--------------
Read
----

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

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

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

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

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

List
----

.. sample:: Networking/v2/lbaas/listeners/list.php
37 changes: 18 additions & 19 deletions doc/services/networking/v2/loadbalancer-pools.rst
Original file line number Diff line number Diff line change
@@ -1,56 +1,55 @@
LoadBalancer Pools
==================

Create Pool
-----------
.. warning::
Load balancing functions accessed via the neutron endpoint are deprecated and will be removed in a future release.
Users are strongly encouraged to migrate to using the octavia endpoint.
This library does not support the octavia endpoint yet.
Consider `helping <https://github.com/php-opencloud/openstack/pulls>`_ us to implement it .

.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#load-balancer-as-a-service-2-0-deprecated

Create
------

.. sample:: Networking/v2/lbaas/pools/create.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancerPool

Get Pool
--------
Read
----

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

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

.. sample:: Networking/v2/lbaas/pools/list.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_listLoadBalancerPools

Update Pool
Update
-----------

.. sample:: Networking/v2/lbaas/pools/update.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancerPool.html#method_update

Delete Pool
-----------
Delete
------

.. sample:: Networking/v2/lbaas/pools/delete.php
.. 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
59 changes: 33 additions & 26 deletions doc/services/networking/v2/loadbalancers.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1,54 @@
LoadBalancers
=============

Create LoadBalancer
-------------------
.. warning::
Load balancing functions accessed via the neutron endpoint are deprecated and will be removed in a future release.
Users are strongly encouraged to migrate to using the octavia endpoint.
This library does not support the octavia endpoint yet.
Consider `helping <https://github.com/php-opencloud/openstack/pulls>`_ us to implement it .

.. sample:: Networking/v2/lbaas/loadbalancers/create.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_createLoadBalancer
.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#load-balancer-as-a-service-2-0-deprecated

Get LoadBalancer
----------------
.. |models| replace:: load balancers

.. sample:: Networking/v2/lbaas/loadbalancers/get.php
.. refdoc:: OpenStack/Networking/v2/Service.html#method_getLoadBalancer
.. include:: /common/service.rst

List LoadBalancers
------------------
Create
------

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

Update LoadBalancer
-------------------
Read
----

.. sample:: Networking/v2/lbaas/loadbalancers/read.php

Update
------

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

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

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

Add Listener to LoadBalancer
----------------------------
List
----

.. sample:: Networking/v2/lbaas/loadbalancers/list.php

Add Listener
------------

.. sample:: Networking/v2/lbaas/loadbalancers/add_listener.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_addListener

Get Stats for LoadBalancer
--------------------------
Get Stats
---------

.. sample:: Networking/v2/lbaas/loadbalancers/get_stats.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStats

Get Status Tree for LoadBalancer
Get Status Tree
--------------------------------

.. sample:: Networking/v2/lbaas/loadbalancers/get_statuses.php
.. refdoc:: OpenStack/Networking/v2/Models/LoadBalancer.html#method_getStatuses
36 changes: 21 additions & 15 deletions doc/services/networking/v2/networks.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
Networks
========

Create network
Network represents an isolated Layer-2 networking segment within the cloud. It can be shared across tenants,
or isolated to a single tenant.

.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#layer-2-networking

.. |models| replace:: networks

.. include:: /common/service.rst

Create
--------------

.. sample:: Networking/v2/networks/create.php
.. refdoc:: OpenStack/Networking/v2/networks/Service.html#method_createNetwork

Create networks
---------------
Batch
~~~~~

To create multiple networks in a single request, use the following code:

.. sample:: Networking/v2/networks/create_batch.php
.. refdoc:: OpenStack/Networking/v2/networks/Service.html#method_createNetworks

Get network
-----------
Read
----

.. sample:: Networking/v2/networks/get.php
.. refdoc:: OpenStack/Networking/v2/networks/Service.html#method_getNetwork
.. sample:: Networking/v2/networks/read.php

Update network
--------------
Update
------

.. sample:: Networking/v2/networks/update.php
.. refdoc:: OpenStack/Networking/v2/networks/Models/Network.html#method_update

Delete network
--------------
Delete
------

.. sample:: Networking/v2/networks/delete.php
.. refdoc:: OpenStack/Networking/v2/networks/Models/Network.html#method_delete
38 changes: 22 additions & 16 deletions doc/services/networking/v2/ports.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
Ports
=====

Create port
-----------
A port is a connection point for attaching a single device, such as the NIC of a virtual server, to a virtual network.
The port also describes the associated network configuration, such as the MAC and IP addresses to be used on that port.

.. osdoc:: https://docs.openstack.org/api-ref/network/v2/index.html#ports

.. |models| replace:: ports

.. include:: /common/service.rst

Create
------

.. sample:: Networking/v2/ports/create.php
.. refdoc:: OpenStack/Networking/v2/ports/Service.html#method_createPort

Create ports
------------
Batch
~~~~~

To create multiple ports in a single request, use the following code:

.. sample:: Networking/v2/ports/create_batch.php
.. refdoc:: OpenStack/Networking/v2/ports/Service.html#method_createPorts

Get port
--------
Read
----

.. sample:: Networking/v2/ports/get.php
.. refdoc:: OpenStack/Networking/v2/ports/Service.html#method_getPort
.. sample:: Networking/v2/ports/read.php

Update port
-----------
Update
------

.. sample:: Networking/v2/ports/update.php
.. refdoc:: OpenStack/Networking/v2/ports/Models/Port.html#method_update

Delete port
-----------
Delete
------

.. sample:: Networking/v2/ports/delete.php
.. refdoc:: OpenStack/Networking/v2/ports/Models/Port.html#method_delete
Loading

0 comments on commit 8eba760

Please sign in to comment.