Merge "Deprecate the Spares Pool feature for removal in X"

This commit is contained in:
Zuul 2020-09-09 00:44:19 +00:00 committed by Gerrit Code Review
commit 49912974b7
5 changed files with 30 additions and 0 deletions
doc/source
admin/guides
contributor/guides
etc
octavia/common
releasenotes/notes

@ -185,6 +185,10 @@ the Octavia services (except octavia-api).
Rotating spare Amphorae Rotating spare Amphorae
----------------------- -----------------------
.. warning::
Spares pool support is deprecated as of the Victoria release.
If the spare pool is enabled in Octavia, spare amphorae must be rotated If the spare pool is enabled in Octavia, spare amphorae must be rotated
first, so a new load balancer will use the new amphora image from a newly first, so a new load balancer will use the new amphora image from a newly
spawned spare amphora. spawned spare amphora.

@ -376,6 +376,11 @@ You must:
Spares pool considerations Spares pool considerations
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning::
Spares pool support is deprecated as of the Victoria release.
One configuration directive deserves some extra consideration in this document: One configuration directive deserves some extra consideration in this document:
Depending on the specifics of your production environment, you may decide to Depending on the specifics of your production environment, you may decide to

@ -420,6 +420,8 @@
# enable_proxy_headers_parsing = False # enable_proxy_headers_parsing = False
[house_keeping] [house_keeping]
# Note: Spares pools support is deprecated as of the Victoria release.
# Interval in seconds to initiate spare amphora checks # Interval in seconds to initiate spare amphora checks
# spare_check_interval = 30 # spare_check_interval = 30
# spare_amphora_pool_size = 0 # spare_amphora_pool_size = 0

@ -594,9 +594,17 @@ certificate_opts = [
house_keeping_opts = [ house_keeping_opts = [
cfg.IntOpt('spare_check_interval', cfg.IntOpt('spare_check_interval',
deprecated_for_removal=True,
deprecated_since='Victoria',
deprecated_reason='Spares Pool support will be removed in the '
'X release.',
default=30, default=30,
help=_('Spare check interval in seconds')), help=_('Spare check interval in seconds')),
cfg.IntOpt('spare_amphora_pool_size', cfg.IntOpt('spare_amphora_pool_size',
deprecated_for_removal=True,
deprecated_since='Victoria',
deprecated_reason='Spares Pool support will be removed in the '
'X release.',
default=0, default=0,
help=_('Number of spare amphorae')), help=_('Number of spare amphorae')),
cfg.IntOpt('cleanup_interval', cfg.IntOpt('cleanup_interval',

@ -0,0 +1,11 @@
---
deprecations:
- |
Spares pool support is deprecated, pending removal in the X release. Use of
the spares pool was originally recommended to increase provisioning speed,
but since Nova's server groups do not support adding existing VMs, Octavia
cannot support use of the spares pool with the Active-Standby topology.
Since this is our recommended topology for production deployments, and
speed is less essential in development/testing environments (the only place
we could recommend the use of Single topology), the overhead of maintaining
spares pool support exceeds its theoretical usefulness.