diff --git a/doc/source/admin/flavors.rst b/doc/source/admin/flavors.rst index 1d1f2006d4..c5980149f5 100644 --- a/doc/source/admin/flavors.rst +++ b/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 diff --git a/doc/source/admin/guides/operator-maintenance.rst b/doc/source/admin/guides/operator-maintenance.rst index c22d8fc93c..e926012273 100644 --- a/doc/source/admin/guides/operator-maintenance.rst +++ b/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 -`_) +`_) 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 diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index bd29b31f37..6130235a17 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -18,7 +18,7 @@ APIs .. toctree:: :maxdepth: 1 - Octavia API Reference + Octavia API Reference ../contributor/api/haproxy-amphora-api.rst diff --git a/doc/source/contributor/guides/providers.rst b/doc/source/contributor/guides/providers.rst index 9c8623b03a..a78beed284 100644 --- a/doc/source/contributor/guides/providers.rst +++ b/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 `_. +resource. See `Octavia Provisioning Status Codes `_. operating_status: the observed status of the resource. See `Octavia -Operating Status Codes `_. +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 `_. +resources. See the `Octavia API Reference `_. 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] ... diff --git a/doc/source/index.rst b/doc/source/index.rst index b05bd09f86..c2aae8e727 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,7 +18,7 @@ is grouped into the following topic areas. :maxdepth: 1 admin/index.rst - Octavia API Reference + Octavia API Reference cli/index.rst configuration/index.rst contributor/index.rst diff --git a/doc/source/user/feature-classification/feature-matrix-healthmonitor.ini b/doc/source/user/feature-classification/feature-matrix-healthmonitor.ini index 9c30e55c37..9936ad03c5 100644 --- a/doc/source/user/feature-classification/feature-matrix-healthmonitor.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-l7policy.ini b/doc/source/user/feature-classification/feature-matrix-l7policy.ini index 94ec965a8a..d38e754eaa 100644 --- a/doc/source/user/feature-classification/feature-matrix-l7policy.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-l7rule.ini b/doc/source/user/feature-classification/feature-matrix-l7rule.ini index 4ac64e665d..c8c4afbf7e 100644 --- a/doc/source/user/feature-classification/feature-matrix-l7rule.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-lb.ini b/doc/source/user/feature-classification/feature-matrix-lb.ini index ce338f34ee..b57aca7861 100644 --- a/doc/source/user/feature-classification/feature-matrix-lb.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-listener.ini b/doc/source/user/feature-classification/feature-matrix-listener.ini index 6a4719499b..5b167d86e0 100644 --- a/doc/source/user/feature-classification/feature-matrix-listener.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-member.ini b/doc/source/user/feature-classification/feature-matrix-member.ini index 84c18b71dc..22459f8849 100644 --- a/doc/source/user/feature-classification/feature-matrix-member.ini +++ b/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 diff --git a/doc/source/user/feature-classification/feature-matrix-pool.ini b/doc/source/user/feature-classification/feature-matrix-pool.ini index 5d0b861aba..c8dd6de13d 100644 --- a/doc/source/user/feature-classification/feature-matrix-pool.ini +++ b/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 diff --git a/doc/source/user/feature-classification/index.rst b/doc/source/user/feature-classification/index.rst index 869cafb9fc..aed3eede35 100644 --- a/doc/source/user/feature-classification/index.rst +++ b/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 `_ section. +`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 `_ section. +`Create a 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 `_ section. +`Create a 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 `_ section. +`Create a 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 `_ section. +`Create a 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 `_ section. +`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 `_ section. +`Create an L7 Rule `_ section. .. support_matrix:: feature-matrix-l7rule.ini diff --git a/doc/source/user/guides/basic-cookbook.rst b/doc/source/user/guides/basic-cookbook.rst index c268932d92..49d8cfb6f0 100644 --- a/doc/source/user/guides/basic-cookbook.rst +++ b/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 `_ +See also: `Octavia API Reference `_ Heath monitor options diff --git a/doc/source/user/guides/l7.rst b/doc/source/user/guides/l7.rst index 7949ad8f28..c41e34d083 100644 --- a/doc/source/user/guides/l7.rst +++ b/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 `_ +See also: `Octavia API Reference `_ 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 `_ +See also: `Octavia API Reference `_ 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 `_ +* `Octavia API Reference `_ * `LBaaS Layer 7 rules `_ * `Using ACLs and fetching samples `_ * `OpenSSL openssl-verify command `_ diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index f0df560832..7770b1d31d 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -26,7 +26,7 @@ References :glob: :maxdepth: 1 - Octavia API Reference + Octavia API Reference Command Line Interface Reference sdks diff --git a/specs/version0.9/stats_api.rst b/specs/version0.9/stats_api.rst index 36da1c1008..519eb34027 100644 --- a/specs/version0.9/stats_api.rst +++ b/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 diff --git a/specs/version1.0/flavors.rst b/specs/version1.0/flavors.rst index e953d62cec..e740b52d2a 100644 --- a/specs/version1.0/flavors.rst +++ b/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 diff --git a/specs/version1.1/enable-provider-driver.rst b/specs/version1.1/enable-provider-driver.rst index d66e1189fc..e1b9d0908b 100644 --- a/specs/version1.1/enable-provider-driver.rst +++ b/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 ` document for details of the fields and expected outcome of these calls. +.. note:: Driver developers should refer to the official `Octavia API reference ` 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 `_. +resource. See `Octavia Provisioning Status Codes `_. operating_status: the observed status of the resource. See `Octavia -Operating Status Codes `_. +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 `_. +resources. See the `Octavia API Reference `_. 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 diff --git a/tox.ini b/tox.ini index 97e0ec57bf..0257c9eea5 100644 --- a/tox.ini +++ b/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