From e8653f28dee5044b943c4ca1ee0329e0bd7b34d2 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 21 Aug 2019 16:09:09 -0400 Subject: [PATCH] doc: remove deprecated [neutron]/url from compute install guide The nova [neutron]/url config option was deprecated in Queens [1] and is being removed in Train [2]. The neutron install guide sections about configuring compute to work with neutron were still using the url option so this change removes them. There are a few things to note here: 1. The url option functionality is replaced with the endpoint_override option from keystoneauth1 but we don't really want users using that unless there is a real need. One of the main reasons for moving the nova configuration to use keystoneauth1 was so that the network service endpoint can be looked up via KSA dynamically based on the configurable interfaces (public, internal, private) and service types authority so the endpoint URL will just be pulled from the service catalog. That means not having to hard-code the endpoint URL in nova config which makes deployment and config management simpler. As such, the url option removed in the install guide here is not replaced with the endpoint_override option. 2. Following on #1, the install guide portion about the nova/neutron config is updated with a link back to the nova config guide for the full set of options in case an operator needs to tweak the config, e.g. to set valid_interfaces or endpoint_override because the KSA defaults don't work for their deployment. 3. With the old url option, if region_name was not specified, nova would default to 'RegionOne'. That is not the case if not using the url option so we leave the region_one config in the install guide example, otherwise region_name would default to None. [1] I41724a612a5f3eabd504f3eaa9d2f9d141ca3f69 [2] I6c068a84c4c0bd88f088f9328d7897bfc1f843f1 Change-Id: I30445edeb8509330571db28c7d61dd63886e9e61 Closes-Bug: #1840930 --- doc/source/install/compute-install-obs.rst | 5 ++++- doc/source/install/compute-install-rdo.rst | 5 ++++- doc/source/install/compute-install-ubuntu.rst | 5 ++++- doc/source/install/controller-install-obs.rst | 5 ++++- doc/source/install/controller-install-rdo.rst | 5 ++++- doc/source/install/controller-install-ubuntu.rst | 5 ++++- 6 files changed, 24 insertions(+), 6 deletions(-) diff --git a/doc/source/install/compute-install-obs.rst b/doc/source/install/compute-install-obs.rst index dca926df23d..9307ff3faf1 100644 --- a/doc/source/install/compute-install-obs.rst +++ b/doc/source/install/compute-install-obs.rst @@ -119,7 +119,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -134,6 +133,10 @@ Configure the Compute service to use the Networking service Replace ``NEUTRON_PASS`` with the password you chose for the ``neutron`` user in the Identity service. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation --------------------- diff --git a/doc/source/install/compute-install-rdo.rst b/doc/source/install/compute-install-rdo.rst index 981bf953695..79a1e3fada7 100644 --- a/doc/source/install/compute-install-rdo.rst +++ b/doc/source/install/compute-install-rdo.rst @@ -122,7 +122,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -137,6 +136,10 @@ Configure the Compute service to use the Networking service Replace ``NEUTRON_PASS`` with the password you chose for the ``neutron`` user in the Identity service. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation --------------------- diff --git a/doc/source/install/compute-install-ubuntu.rst b/doc/source/install/compute-install-ubuntu.rst index 5cff3417cbc..faa1e813d21 100644 --- a/doc/source/install/compute-install-ubuntu.rst +++ b/doc/source/install/compute-install-ubuntu.rst @@ -118,7 +118,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -133,6 +132,10 @@ Configure the Compute service to use the Networking service Replace ``NEUTRON_PASS`` with the password you chose for the ``neutron`` user in the Identity service. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation --------------------- diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst index 4d55567ac95..3999c5c729e 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/controller-install-obs.rst @@ -247,7 +247,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -267,6 +266,10 @@ Configure the Compute service to use the Networking service Replace ``METADATA_SECRET`` with the secret you chose for the metadata proxy. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation --------------------- diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst index 352fa241b35..890065c8a8b 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/controller-install-rdo.rst @@ -247,7 +247,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -267,6 +266,10 @@ Configure the Compute service to use the Networking service Replace ``METADATA_SECRET`` with the secret you chose for the metadata proxy. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation --------------------- diff --git a/doc/source/install/controller-install-ubuntu.rst b/doc/source/install/controller-install-ubuntu.rst index f108f5a8b6d..6ea58aa1020 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/controller-install-ubuntu.rst @@ -247,7 +247,6 @@ Configure the Compute service to use the Networking service [neutron] # ... - url = http://controller:9696 auth_url = http://controller:5000 auth_type = password project_domain_name = default @@ -267,6 +266,10 @@ Configure the Compute service to use the Networking service Replace ``METADATA_SECRET`` with the secret you chose for the metadata proxy. + See the :nova-doc:`compute service configuration guide ` + for the full set of options including overriding the service catalog + endpoint URL if necessary. + Finalize installation ---------------------