openstack/kolla-ansible
Code Issues Proposed changes

Deprecate storage_interface variable

Browse Source 
Per [1] and exchange on IRC.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-December/026437.html

Change-Id: I322500e7204eb129d7bf085006627e8c4aaaa934
This commit is contained in:
Radosław Piliszek 2021-12-23 15:37:03 +00:00
parent f8457d2e41
commit 8cc569306a
5 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ansible/group_vars/all.yml
View File

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

9
doc/source/admin/production-architecture-guide.rst
View File

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

2
doc/source/reference/storage/swift-guide.rst
View File

@ -22,7 +22,7 @@ Internal API interface (``api_interface``)
used by HAProxy to access the Swift proxy servers. used by HAProxy to access the Swift proxy servers.
Swift Storage interface (``swift_storage_interface``) Swift Storage interface (``swift_storage_interface``)
This interface is used by the Swift proxy server to access the account, 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``) Swift replication interface (``swift_replication_interface``)
This interface is used for Swift storage replication traffic. This interface is used for Swift storage replication traffic.
This is optional as the default configuration uses This is optional as the default configuration uses

1
etc/kolla/globals.yml
View File

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

7
releasenotes/notes/deprecate-storage-interface-8e82d446baff4da8.yaml Normal file
View File

@ -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.