Browse Source

Update api-ref location

The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I9f617159eddc8af532403e47c325048d92cc9ade
changes/02/672102/2
Andreas Jaeger 3 years ago
parent
commit
bc19e07923
  1. 6
      doc/source/admin/flavors.rst
  2. 2
      doc/source/admin/guides/operator-maintenance.rst
  3. 2
      doc/source/admin/index.rst
  4. 10
      doc/source/contributor/guides/providers.rst
  5. 2
      doc/source/index.rst
  6. 2
      doc/source/user/feature-classification/feature-matrix-healthmonitor.ini
  7. 2
      doc/source/user/feature-classification/feature-matrix-l7policy.ini
  8. 2
      doc/source/user/feature-classification/feature-matrix-l7rule.ini
  9. 2
      doc/source/user/feature-classification/feature-matrix-lb.ini
  10. 2
      doc/source/user/feature-classification/feature-matrix-listener.ini
  11. 2
      doc/source/user/feature-classification/feature-matrix-member.ini
  12. 2
      doc/source/user/feature-classification/feature-matrix-pool.ini
  13. 14
      doc/source/user/feature-classification/index.rst
  14. 2
      doc/source/user/guides/basic-cookbook.rst
  15. 6
      doc/source/user/guides/l7.rst
  16. 2
      doc/source/user/index.rst
  17. 2
      specs/version0.9/stats_api.rst
  18. 2
      specs/version1.0/flavors.rst
  19. 12
      specs/version1.1/enable-provider-driver.rst
  20. 2
      tox.ini

6
doc/source/admin/flavors.rst

@ -37,7 +37,7 @@ There are three steps to creating a new Octavia flavor:
Provider Capabilities
=====================
.. _provider driver flavor capabilities: https://developer.openstack.org/api-ref/load-balancer/v2/index.html##show-provider-flavor-capabilities
.. _provider driver flavor capabilities: https://docs.openstack.org/api-ref/load-balancer/v2/index.html##show-provider-flavor-capabilities
To start the process of defining a flavor, you will want to look at the
flavor capabilities that the provider driver exposes. To do this you can use
@ -66,7 +66,7 @@ capability, among many others::
Flavor Profiles
===============
.. _flavor profile: https://developer.openstack.org/api-ref/load-balancer/v2/index.html#create-flavor-profile
.. _flavor profile: https://docs.openstack.org/api-ref/load-balancer/v2/index.html#create-flavor-profile
The next step in the process of creating a flavor is to define a flavor
profile. The flavor profile includes the provider and the flavor data.
@ -102,7 +102,7 @@ The output of the command above is::
Flavors
=======
.. _flavor: https://developer.openstack.org/api-ref/load-balancer/v2/index.html#create-flavor
.. _flavor: https://docs.openstack.org/api-ref/load-balancer/v2/index.html#create-flavor
Finally we will create the user facing Octavia flavor. This defines the
information users will see and use to create a load balancer with an Octavia

2
doc/source/admin/guides/operator-maintenance.rst

@ -62,7 +62,7 @@ when response times become too high.
An additional check might be to monitor the provisioning status of a
load balancer (see `Load Balance Status Codes
<https://developer.openstack.org/api-ref/load-balancer/v2/#status-codes>`_)
<https://docs.openstack.org/api-ref/load-balancer/v2/#status-codes>`_)
and alert depending on the application if the provisioning status is
not ACTIVE. For some applications other states might not lead to alerts:
For instance if an application is making regular changes to the pool

2
doc/source/admin/index.rst

@ -18,7 +18,7 @@ APIs
.. toctree::
:maxdepth: 1
Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>
Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>
../contributor/api/haproxy-amphora-api.rst

10
doc/source/contributor/guides/providers.rst

@ -82,7 +82,7 @@ See the `Exception Model`_ below for more details.
`Octavia API reference`_ document for details of the fields and
expected outcome of these calls.
.. _Octavia API reference: https://developer.openstack.org/api-ref/load-balancer/v2/index.html
.. _Octavia API reference: https://docs.openstack.org/api-ref/load-balancer/v2/index.html
Load balancer
-------------
@ -1830,10 +1830,10 @@ unchanged.
the configured limit.
provisioning_status: status associated with lifecycle of the
resource. See `Octavia Provisioning Status Codes <https://developer.openstack.org/api-ref/load-balancer/v2/index.html#provisioning-status-codes>`_.
resource. See `Octavia Provisioning Status Codes <https://docs.openstack.org/api-ref/load-balancer/v2/index.html#provisioning-status-codes>`_.
operating_status: the observed status of the resource. See `Octavia
Operating Status Codes <https://developer.openstack.org/api-ref/load-balancer/v2/index.html#operating-status-codes>`_.
Operating Status Codes <https://docs.openstack.org/api-ref/load-balancer/v2/index.html#operating-status-codes>`_.
The dictionary takes this form:
@ -1913,7 +1913,7 @@ Provider drivers may need to get information about an Octavia resource.
As an example of its use, a provider driver may need to sync with Octavia,
and therefore need to fetch all of the Octavia resources it is responsible
for managing. Provider drivers can use the existing Octavia API to get these
resources. See the `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/v2/index.html>`_.
resources. See the `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/v2/index.html>`_.
API Exception Model
-------------------
@ -2003,7 +2003,7 @@ following to the feature-matrix-lb.ini file.
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[operation.admin_state_up]
...

2
doc/source/index.rst

@ -18,7 +18,7 @@ is grouped into the following topic areas.
:maxdepth: 1
admin/index.rst
Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>
Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>
cli/index.rst
configuration/index.rst
contributor/index.rst

2
doc/source/user/feature-classification/feature-matrix-healthmonitor.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-l7policy.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-l7rule.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-lb.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-listener.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-member.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

2
doc/source/user/feature-classification/feature-matrix-pool.ini

@ -14,7 +14,7 @@
[driver.amphora]
title=Amphora Provider
link=https://developer.openstack.org/api-ref/load-balancer/v2/index.html
link=https://docs.openstack.org/api-ref/load-balancer/v2/index.html
[driver.ovn]
title=OVN Provider

14
doc/source/user/feature-classification/index.rst

@ -26,7 +26,7 @@ Load Balancer API Features
--------------------------
These features are documented in the Octavia API reference
`Create a Load Balancer <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-a-load-balancer-detail#create-a-load-balancer>`_ section.
`Create a Load Balancer <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-a-load-balancer-detail#create-a-load-balancer>`_ section.
.. support_matrix:: feature-matrix-lb.ini
@ -39,7 +39,7 @@ Listener API Features
---------------------
These features are documented in the Octavia API reference
`Create a Listener <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-listener-detail#create-listener>`_ section.
`Create a Listener <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-listener-detail#create-listener>`_ section.
.. support_matrix:: feature-matrix-listener.ini
@ -52,7 +52,7 @@ Pool API Features
-----------------
These features are documented in the Octavia API reference
`Create a Pool <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-pool-detail#create-pool>`_ section.
`Create a Pool <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-pool-detail#create-pool>`_ section.
.. support_matrix:: feature-matrix-pool.ini
@ -65,7 +65,7 @@ Member API Features
-------------------
These features are documented in the Octavia API reference
`Create a Member <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-member-detail#create-member>`_ section.
`Create a Member <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-member-detail#create-member>`_ section.
.. support_matrix:: feature-matrix-member.ini
@ -78,7 +78,7 @@ Health Monitor API Features
---------------------------
These features are documented in the Octavia API reference
`Create a Health Monitor <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-health-monitor-detail#create-health-monitor>`_ section.
`Create a Health Monitor <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-health-monitor-detail#create-health-monitor>`_ section.
.. support_matrix:: feature-matrix-healthmonitor.ini
@ -91,7 +91,7 @@ L7 Policy API Features
----------------------
These features are documented in the Octavia API reference
`Create an L7 Policy <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-l7-policy-detail#create-an-l7-policy>`_ section.
`Create an L7 Policy <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-l7-policy-detail#create-an-l7-policy>`_ section.
.. support_matrix:: feature-matrix-l7policy.ini
@ -104,6 +104,6 @@ L7 Rule API Features
--------------------
These features are documented in the Octavia API reference
`Create an L7 Rule <https://developer.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-l7-rule-detail#create-an-l7-rule>`_ section.
`Create an L7 Rule <https://docs.openstack.org/api-ref/load-balancer/v2/index.html?expanded=create-l7-rule-detail#create-an-l7-rule>`_ section.
.. support_matrix:: feature-matrix-l7rule.ini

2
doc/source/user/guides/basic-cookbook.rst

@ -541,7 +541,7 @@ them out of the pool. Since effective health monitors depend as much on
back-end application server configuration as proper load balancer
configuration, some additional discussion of best practices is warranted here.
See also: `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>`_
See also: `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>`_
Heath monitor options

6
doc/source/user/guides/l7.rst

@ -70,7 +70,7 @@ It consists of a rule type, a comparison type, a value, and an optional key
that gets used depending on the rule type. An L7 rule must always be associated
with an L7 policy.
See also: `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>`_
See also: `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>`_
Rule types
__________
@ -124,7 +124,7 @@ may also have an association to a back-end pool. Policies describe actions that
should be taken by the load balancing software if all of the rules in the
policy return true.
See also: `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>`_
See also: `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>`_
Policy Logic
____________
@ -189,7 +189,7 @@ For a cookbook of common L7 usage examples, please see the :doc:`l7-cookbook`
Useful links
============
* `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>`_
* `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>`_
* `LBaaS Layer 7 rules <https://github.com/openstack/neutron-specs/blob/master/specs/mitaka/lbaas-l7-rules.rst>`_
* `Using ACLs and fetching samples <http://cbonte.github.io/haproxy-dconv/1.6/configuration.html#7>`_
* `OpenSSL openssl-verify command <https://www.openssl.org/docs/manmaster/man1/openssl-verify.html>`_

2
doc/source/user/index.rst

@ -26,7 +26,7 @@ References
:glob:
:maxdepth: 1
Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/>
Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>
Command Line Interface Reference <https://docs.openstack.org/python-octaviaclient/latest/cli/index.html>
sdks

2
specs/version0.9/stats_api.rst

@ -164,4 +164,4 @@ Changes shall be introduced to the octavia APIs: see [1]
References
==========
[1] https://developer.openstack.org/api-ref/load-balancer/v1/octaviaapi.html
[1] https://docs.openstack.org/api-ref/load-balancer/v1/octaviaapi.html

2
specs/version1.0/flavors.rst

@ -337,4 +337,4 @@ extensions.
References
==========
[1] https://developer.openstack.org/api-ref/load-balancer/v2/index.html
[1] https://docs.openstack.org/api-ref/load-balancer/v2/index.html

12
specs/version1.1/enable-provider-driver.rst

@ -67,7 +67,7 @@ request against the current driver capabilities.
See the `Exception Model`_ below for more details.
.. note:: Driver developers should refer to the official `Octavia API reference <https://developer.openstack.org/api-ref/load-balancer/v2/index.html>` document for details of the fields and expected outcome of these calls.
.. note:: Driver developers should refer to the official `Octavia API reference <https://docs.openstack.org/api-ref/load-balancer/v2/index.html>` document for details of the fields and expected outcome of these calls.
Load balancer
^^^^^^^^^^^^^
@ -1603,10 +1603,10 @@ existing object is not included in the input parameter, the status remains
unchanged.
provisioning_status: status associated with lifecycle of the
resource. See `Octavia Provisioning Status Codes <https://developer.openstack.org/api-ref/load-balancer/v2/index.html#provisioning-status-codes>`_.
resource. See `Octavia Provisioning Status Codes <https://docs.openstack.org/api-ref/load-balancer/v2/index.html#provisioning-status-codes>`_.
operating_status: the observed status of the resource. See `Octavia
Operating Status Codes <https://developer.openstack.org/api-ref/load-balancer/v2/index.html#operating-status-codes>`_.
Operating Status Codes <https://docs.openstack.org/api-ref/load-balancer/v2/index.html#operating-status-codes>`_.
The dictionary takes this form:
@ -1679,7 +1679,7 @@ Provider drivers may need to get information about an Octavia resource.
As an example of its use, a provider driver may need to sync with Octavia,
and therefore need to fetch all of the Octavia resources it is responsible
for managing. Provider drivers can use the existing Octavia API to get these
resources. See the `Octavia API Reference <https://developer.openstack.org/api-ref/load-balancer/v2/index.html>`_.
resources. See the `Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/v2/index.html>`_.
API Exception Model
^^^^^^^^^^^^^^^^^^^
@ -1798,7 +1798,7 @@ Work Items
Dependencies
============
* Octavia API:
https://developer.openstack.org/api-ref/load-balancer/
https://docs.openstack.org/api-ref/load-balancer/
* Flavors:
https://docs.openstack.org/octavia/latest/contributor/specs/version1.0/flavors.html
@ -1822,7 +1822,7 @@ A driver developer guide should be created.
References
==========
Octavia API
https://developer.openstack.org/api-ref/load-balancer/v2/index.html
https://docs.openstack.org/api-ref/load-balancer/v2/index.html
Octavia Flavors Specification
https://docs.openstack.org/octavia/latest/contributor/specs/version1.0/flavors.html

2
tox.ini

@ -20,7 +20,7 @@ commands =
[testenv:api-ref]
basepython = python3
# This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org.
# the API Ref to docs.openstack.org.
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/requirements.txt

Loading…
Cancel
Save