Add deprecated_since parameter

This can be used to formalize deprecation timelines, so that options
are removed when planned. This includes moving some lines around, so
that parameters are in a regular order. A future change can remove the
fully deprecated options.

The relevant commits are:

    DEFAULT     vendordata_driver               21da1ba
    cells       manager                         0fcec69
    cells       driver                          579c98a
    conductor   use_local                       a698871
    conductor   manager                         e683c41
    service     metadata_manager                0fcec69
    service     compute_manager                 0fcec69
    service     console_manager                 0fcec69
    service     consoleauth_manager             0fcec69
    service     cert_manager                    0fcec69
    service     scheduler_manager               0fcec69
    DEFAULT     quota_driver                    4306388
    DEFAULT     compute_available_monitors      973f312
    DEFAULT     compute_stats_class             3be36fc
    DEFAULT     snapshot_name_template          aeee454
    DEFAULT     db_driver                       c87ae92
    DEFAULT     image_decryption_dir            be86b27
    DEFAULT     s3_host                         be86b27
    DEFAULT     s3_port                         be86b27
    DEFAULT     s3_access_key                   be86b27
    DEFAULT     s3_secret_key                   be86b27
    DEFAULT     s3_use_ssl                      be86b27
    DEFAULT     s3_affix_tenant                 be86b27
    DEFAULT     enable_network_quota            d0b8fec
    DEFAULT     quota_networks                  d0b8fec
    glance      use_glance_v1                   16dd86f
    image_file_url      filesystems             9931ef9
    image_file_url:???  id                      9931ef9
    image_file_url:???  mountpoint              9931ef9
    DEFAULT     fatal_exception_format_errors   6919b25
    barbican    catalog_info                    899a140
    barbican    endpoint_template               899a140
    barbican    os_region_name                  899a140
    ironic      admin_username                  2ea2399
    ironic      admin_password                  2ea2399
    libvirt     use_usb_tablet                  73d5d1f
    libvirt     image_info_filename_pattern     2c389cc
    libvirt     checksum_base_images            2c389cc
    libvirt     checksum_interval_seconds       2c389cc
    DEFAULT     share_dhcp_address              e29a800
    DEFAULT     security_group_api              ef957ee
    osapi_v21   extensions_blacklist            11507ee
    osapi_v21   extensions_whitelist            11507ee
    osapi_v21   project_id_regex                1f16a76
    DEFAULT     cert_topic                      5afc8e5
    DEFAULT     default_flavor                  b7660e0

Change-Id: I9e483109b52fe6d98e386a03010063cb37a0d9c8
Implements: bp centralize-config-options-ocata
This commit is contained in:
Stephen Finucane 2016-08-10 17:19:38 +01:00
parent 44beea1f66
commit 2e498af761
3 changed files with 19 additions and 9 deletions

View File

@ -64,6 +64,7 @@ Possible values:
cfg.StrOpt("vendordata_driver", cfg.StrOpt("vendordata_driver",
default="nova.api.metadata.vendordata_json.JsonFileVendorData", default="nova.api.metadata.vendordata_json.JsonFileVendorData",
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_since="13.0.0",
help=""" help="""
When returning instance metadata, this is the class that is used When returning instance metadata, this is the class that is used
for getting vendor metadata when that class isn't specified in the individual for getting vendor metadata when that class isn't specified in the individual
@ -278,6 +279,7 @@ fping_path_opts = [
os_network_opts = [ os_network_opts = [
cfg.BoolOpt("enable_network_quota", cfg.BoolOpt("enable_network_quota",
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason=""" deprecated_reason="""
CRUD operations on tenant networks are only available when using nova-network CRUD operations on tenant networks are only available when using nova-network
and nova-network is itself deprecated.""", and nova-network is itself deprecated.""",
@ -311,6 +313,7 @@ Related options:
"""), """),
cfg.IntOpt("quota_networks", cfg.IntOpt("quota_networks",
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason=""" deprecated_reason="""
CRUD operations on tenant networks are only available when using nova-network CRUD operations on tenant networks are only available when using nova-network
and nova-network is itself deprecated.""", and nova-network is itself deprecated.""",

View File

@ -28,8 +28,9 @@ _DEFAULT_SQL_CONNECTION = 'sqlite:///' + paths.state_path_def('nova.sqlite')
db_driver_opt = cfg.StrOpt( db_driver_opt = cfg.StrOpt(
'db_driver', 'db_driver',
default='nova.db', default='nova.db',
help='DEPRECATED: The driver to use for database access', deprecated_for_removal=True,
deprecated_for_removal=True) deprecated_since='13.0.0',
help='The driver to use for database access')
# NOTE(markus_z): We cannot simply do: # NOTE(markus_z): We cannot simply do:

View File

@ -126,6 +126,7 @@ Possible Values:
cfg.StrOpt('metadata_manager', cfg.StrOpt('metadata_manager',
default='nova.api.manager.MetadataManager', default='nova.api.manager.MetadataManager',
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_since='13.0.0',
help="Full class name for the service metadata manager."), help="Full class name for the service metadata manager."),
cfg.StrOpt('metadata_listen', cfg.StrOpt('metadata_listen',
default="0.0.0.0", default="0.0.0.0",
@ -164,19 +165,23 @@ Possible Values:
cfg.StrOpt('compute_manager', cfg.StrOpt('compute_manager',
default='nova.compute.manager.ComputeManager', default='nova.compute.manager.ComputeManager',
deprecated_for_removal=True, deprecated_for_removal=True,
help="Full class name for the Manager for compute"), deprecated_since='13.0.0',
help='Full class name for the Manager for compute'),
cfg.StrOpt('console_manager', cfg.StrOpt('console_manager',
default='nova.console.manager.ConsoleProxyManager', default='nova.console.manager.ConsoleProxyManager',
deprecated_for_removal=True, deprecated_for_removal=True,
help="Full class name for the Manager for console proxy"), deprecated_since='13.0.0',
help='Full class name for the Manager for console proxy'),
cfg.StrOpt('consoleauth_manager', cfg.StrOpt('consoleauth_manager',
default='nova.consoleauth.manager.ConsoleAuthManager', default='nova.consoleauth.manager.ConsoleAuthManager',
deprecated_for_removal=True, deprecated_for_removal=True,
help="Full clase name for the Manager for console auth"), deprecated_since='13.0.0',
help='Full class name for the Manager for console auth'),
cfg.StrOpt('cert_manager', cfg.StrOpt('cert_manager',
default='nova.cert.manager.CertManager', default='nova.cert.manager.CertManager',
deprecated_for_removal=True, deprecated_for_removal=True,
help="Full class name for the Manager for cert"), deprecated_since='13.0.0',
help='Full class name for the Manager for cert'),
# NOTE(sdague): the network_manager has a bunch of different in # NOTE(sdague): the network_manager has a bunch of different in
# tree classes that are still legit options. In Newton we should # tree classes that are still legit options. In Newton we should
# turn this into a selector. # turn this into a selector.
@ -187,12 +192,13 @@ Possible Values:
'nova.network.manager.VlanManager', 'nova.network.manager.VlanManager',
], ],
default='nova.network.manager.VlanManager', default='nova.network.manager.VlanManager',
help="Full class name for the Manager for network"), help='Full class name for the Manager for network'),
cfg.StrOpt('scheduler_manager', cfg.StrOpt('scheduler_manager',
default='nova.scheduler.manager.SchedulerManager', default='nova.scheduler.manager.SchedulerManager',
deprecated_for_removal=True, deprecated_for_removal=True,
help="Full class name for the Manager for scheduler"), deprecated_since='13.0.0',
] help='Full class name for the Manager for scheduler'),
]
def register_opts(conf): def register_opts(conf):