Merge "Deprecate storage_interface variable"

ansible/group_vars/all.yml

@@ -226,6 +226,7 @@ network_interface: "eth0"
 neutron_external_interface: "eth1"
 kolla_external_vip_interface: "{{ network_interface }}"
 api_interface: "{{ network_interface }}"
+# NOTE: storage_interface is deprecated, please set swift_storage_interface directly instead
 storage_interface: "{{ network_interface }}"
 swift_storage_interface: "{{ storage_interface }}"
 swift_replication_interface: "{{ swift_storage_interface }}"

doc/source/admin/production-architecture-guide.rst

@@ -54,13 +54,14 @@ In Kolla operators should configure following network interfaces:
   ``kolla_enable_tls_external`` is set to yes. Defaults to
   ``network_interface``.
 
-* ``storage_interface`` - This is the interface that is used by Swift.
-  This can be heavily utilized so it's recommended to use a high speed
-  network fabric. Defaults to ``network_interface``.
+* ``storage_interface`` (**deprecated**) - Sets the default for
+  ``swift_storage_interface``. Defaults to ``network_interface``.
+  Please set ``swift_storage_interface`` directly instead.
 
 * ``swift_storage_interface`` - This interface is used by Swift for storage
   access traffic.  This can be heavily utilized so it's recommended to use
-  a high speed network fabric. Defaults to ``storage_interface``.
+  a high speed network fabric. Defaults to ``storage_interface``, will default
+  directly to ``network_interface`` in a future release.
 
 * ``swift_replication_interface`` - This interface is used by Swift for storage
   replication traffic.  This can be heavily utilized so it's recommended to use

doc/source/reference/storage/swift-guide.rst

@@ -22,7 +22,7 @@ Internal API interface (``api_interface``)
   used by HAProxy to access the Swift proxy servers.
 Swift Storage interface (``swift_storage_interface``)
   This interface is used by the Swift proxy server to access the account,
-  container and object servers. Defaults to ``storage_interface``.
+  container and object servers.
 Swift replication interface (``swift_replication_interface``)
   This interface is used for Swift storage replication traffic.
   This is optional as the default configuration uses

etc/kolla/globals.yml

@@ -127,6 +127,7 @@
 # the 'network_interface'. These interfaces must contain an IP address.
 #kolla_external_vip_interface: "{{ network_interface }}"
 #api_interface: "{{ network_interface }}"
+# NOTE: storage_interface is deprecated, please set swift_storage_interface directly instead
 #storage_interface: "{{ network_interface }}"
 #swift_storage_interface: "{{ storage_interface }}"
 #swift_replication_interface: "{{ swift_storage_interface }}"

releasenotes/notes/deprecate-storage-interface-8e82d446baff4da8.yaml

@@ -0,0 +1,7 @@
+---
+deprecations:
+  - |
+    The ``storage_interface`` variable is deprecated and will be removed in the
+    next release as it was causing confusion. The variable only sets the
+    default for ``swift_storage_interface`` which we now recommend to set
+    directly instead.