openstack
/
nova
Code Issues Proposed changes

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 4cc5ef121f
commit e9515ba745
18 changed files with 68 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
nova/conf/api.py
View File

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

1
nova/conf/cells.py
View File

@ -237,6 +237,7 @@ cell_manager_opts = [
cfg.StrOpt('driver',
default='nova.cells.rpc_driver.CellsRPCDriver',
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason='The only available driver '
'is the RPC driver.',
help="""Cells communication driver

1
nova/conf/cert.py
View File

@ -19,6 +19,7 @@ from oslo_config import cfg
cert_opts = [
cfg.StrOpt("cert_topic",
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="""
Since the nova-cert service is marked for deprecation, the feature to change
RPC topic that cert nodes listen may be removed as early as the 15.0.0

6
nova/conf/compute.py
View File

@ -114,6 +114,7 @@ Possible values:
"""),
cfg.MultiStrOpt('compute_available_monitors',
deprecated_for_removal=True,
deprecated_since='12.0.0',
deprecated_reason='stevedore and setuptools entry points '
'now allow a set of plugins to be '
'specified without this config option.',
@ -174,6 +175,7 @@ Possible values:
cfg.StrOpt('compute_stats_class',
default='nova.compute.stats.Stats',
deprecated_for_removal=True,
deprecated_since='13.0.0',
help="""
Abstracts out managing compute host stats to pluggable class. This class
manages and updates stats for the local compute host after an instance
@ -700,8 +702,8 @@ Related options:
cfg.StrOpt('snapshot_name_template',
default='snapshot-%s',
deprecated_for_removal=True,
deprecated_reason='This is not used anymore and will be '
'removed in the O release.',
deprecated_since='14.0.0',
deprecated_reason='This is not used anymore.',
help='Template string to be used to generate snapshot names')
]

2
nova/conf/conductor.py
View File

@ -33,6 +33,7 @@ ALL_OPTS = [
'use_local',
default=False,
deprecated_for_removal=True,
deprecated_since='13.0.0',
help="""
Perform nova-conductor operations locally. This legacy mode was
introduced to bridge a gap during the transition to the conductor service.
@ -51,6 +52,7 @@ Topic exchange name on which conductor nodes listen.
'manager',
default='nova.conductor.manager.ConductorManager',
deprecated_for_removal=True,
deprecated_since='13.0.0',
help="""
Full class name for the Manager for conductor.

5
nova/conf/database.py
View File

@ -28,8 +28,9 @@ _DEFAULT_SQL_CONNECTION = 'sqlite:///' + paths.state_path_def('nova.sqlite')
db_driver_opt = cfg.StrOpt(
'db_driver',
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:

1
nova/conf/exceptions.py
View File

@ -19,6 +19,7 @@ exc_log_opts = [
cfg.BoolOpt('fatal_exception_format_errors',
default=False,
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="This is only used for internal testing.",
help="""
When set to true, this option enables validation of exception

3
nova/conf/flavors.py
View File

@ -21,7 +21,8 @@ flavor_opts = [
"default_flavor",
default="m1.small",
deprecated_for_removal=True,
deprecated_reason="The EC2 API is deprecated",
deprecated_since="14.0.0",
deprecated_reason="The EC2 API is deprecated.",
help="""
Default flavor to use for the EC2 API only.
The Nova API does not support a default flavor.

9
nova/conf/glance.py
View File

@ -50,6 +50,10 @@ should be fully qualified urls of the form
'[file].'),
cfg.BoolOpt('use_glance_v1',
default=False,
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason='Glance v1 support will be removed in '
'Ocata',
help="""
This flag allows reverting to glance v1 if for some reason glance v2 doesn't
work in your environment. This will only exist in Newton, and a fully working
@ -68,10 +72,7 @@ Glance v2 will be a hard requirement in Ocata.
* Related options:
None
""",
deprecated_for_removal=True,
deprecated_reason='Glance v1 support will be removed in '
'Ocata'),
"""),
cfg.BoolOpt('verify_glance_signatures',
default=False,
help='Require Nova to perform signature verification on '

3
nova/conf/image_file_url.py
View File

@ -24,6 +24,7 @@ filesystems = cfg.ListOpt(
name='filesystems',
default=[],
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="""
The feature to download images from glance via filesystem is not used and will
be removed in the future.
@ -39,6 +40,7 @@ image_file_url:<list entry name> sections
filesystem_opts = [
cfg.StrOpt('id',
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="""
The feature to download images from glance via filesystem is not used and will
be removed in the future.
@ -50,6 +52,7 @@ file system.
"""),
cfg.StrOpt('mountpoint',
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="""
The feature to download images from glance via filesystem is not used and will
be removed in the future.

2
nova/conf/ironic.py
View File

@ -46,12 +46,14 @@ ironic_options = [
cfg.StrOpt(
'admin_username',
deprecated_for_removal=True,
deprecated_since='14.0.0',
help='Ironic keystone admin name. '
'Use ``username`` instead.'),
cfg.StrOpt(
'admin_password',
secret=True,
deprecated_for_removal=True,
deprecated_since='14.0.0',
help='Ironic keystone admin password. '
'Use ``password`` instead.'),
cfg.StrOpt(

3
nova/conf/key_manager.py
View File

@ -42,6 +42,7 @@ barbican_opts = [
cfg.StrOpt("catalog_info",
default="key-manager:barbican:public",
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="This option have been moved to the "
"Castellan library",
help="""
@ -51,6 +52,7 @@ catalog. Format is: separated values of the form:
"""),
cfg.StrOpt("endpoint_template",
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="This option have been moved to the "
"Castellan library",
help="""
@ -60,6 +62,7 @@ http://localhost:9311/v1/%(project_id)s
"""),
cfg.StrOpt("os_region_name",
deprecated_for_removal=True,
deprecated_since="14.0.0",
deprecated_reason="This option have been moved to the "
"Castellan library",
help='Region name of this node'),

22
nova/conf/libvirt.py
View File

@ -223,6 +223,7 @@ Related options:
deprecated_for_removal=True,
deprecated_reason="This option is being replaced by the "
"'pointer_model' option.",
deprecated_since='14.0.0',
help="""
Enable a mouse cursor within a graphical VNC or SPICE sessions.
@ -503,31 +504,34 @@ libvirt_imagecache_opts = [
cfg.StrOpt('image_info_filename_pattern',
default='$instances_path/$image_cache_subdirectory_name/'
'%(image)s.info',
help='Allows image information files to be stored in '
'non-standard locations',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='Image info files are no longer used by the '
'image cache'),
'image cache',
help='Allows image information files to be stored in '
'non-standard locations'),
cfg.IntOpt('remove_unused_resized_minimum_age_seconds',
default=3600,
help='Unused resized base images younger than this will not be '
'removed'),
cfg.BoolOpt('checksum_base_images',
default=False,
help='Write a checksum for files in _base to disk',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='The image cache no longer periodically '
'calculates checksums of stored images. '
'Data integrity can be checked at the block '
'or filesystem level.'),
'or filesystem level.',
help='Write a checksum for files in _base to disk'),
cfg.IntOpt('checksum_interval_seconds',
default=3600,
help='How frequently to checksum base images',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='The image cache no longer periodically '
'calculates checksums of stored images. '
'Data integrity can be checked at the block '
'or filesystem level.'),
'or filesystem level.',
help='How frequently to checksum base images'),
]
libvirt_lvm_opts = [
@ -560,8 +564,8 @@ libvirt_volume_opts = [
'from QEMU. Currently supported protocols: [gluster]'),
cfg.BoolOpt('volume_use_multipath',
default=False,
help='Use multipath connection of the iSCSI or FC volume',
deprecated_name='iscsi_use_multipath'),
deprecated_name='iscsi_use_multipath',
help='Use multipath connection of the iSCSI or FC volume')
]
libvirt_volume_aoe_opts = [

1
nova/conf/network.py
View File

@ -370,6 +370,7 @@ Related options:
cfg.BoolOpt("share_dhcp_address",
default=False,
deprecated_for_removal=True,
deprecated_since='2014.2',
help="""
THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK.

6
nova/conf/osapi_v21.py
View File

@ -23,7 +23,7 @@ api_opts = [
cfg.ListOpt("extensions_blacklist",
default=[],
deprecated_for_removal=True,
deprecated_group="osapi_v21",
deprecated_since="12.0.0",
help="""
This option is a list of all of the v2.1 API extensions to never load. However,
it will be removed in the near future, after which all the functionality
@ -43,7 +43,7 @@ Related options:
cfg.ListOpt("extensions_whitelist",
default=[],
deprecated_for_removal=True,
deprecated_group="osapi_v21",
deprecated_since="12.0.0",
help="""
This is a list of extensions. If it is empty, then *all* extensions except
those specified in the extensions_blacklist option will be loaded. If it is not
@ -64,7 +64,7 @@ Related options:
"""),
cfg.StrOpt("project_id_regex",
deprecated_for_removal=True,
deprecated_group="osapi_v21",
deprecated_since="13.0.0",
help="""
This option is a string representing a regular expression (regex) that matches
the project_id as contained in URLs. If not set, it will match normal UUIDs

1
nova/conf/quota.py
View File

@ -230,6 +230,7 @@ Possible values:
cfg.StrOpt('quota_driver',
default='nova.quota.DbQuotaDriver',
deprecated_for_removal=True,
deprecated_since='14.0.0',
help="""
Provides abstraction for quota checks. Users can configure a specific
driver to use for quota checks.

7
nova/conf/s3.py
View File

@ -20,6 +20,7 @@ from oslo_config import cfg
s3_opts = [
cfg.StrOpt('image_decryption_dir',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default='/tmp',
help="""
@ -27,6 +28,7 @@ Parent directory for tempdir used for image decryption
"""),
cfg.StrOpt('s3_host',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default='$my_ip',
help="""
@ -34,6 +36,7 @@ Hostname or IP for OpenStack to use when accessing the S3 API
"""),
cfg.PortOpt('s3_port',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default=3333,
help="""
@ -42,21 +45,25 @@ Port used when accessing the S3 API. It should be in the range of
"""),
cfg.StrOpt('s3_access_key',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default='notchecked',
help='Access key to use S3 server for images'),
cfg.StrOpt('s3_secret_key',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default='notchecked',
help='Secret key to use for S3 server for images'),
cfg.BoolOpt('s3_use_ssl',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default=False,
help='Whether to use SSL when talking to S3'),
cfg.BoolOpt('s3_affix_tenant',
deprecated_for_removal=True,
deprecated_since='14.0.0',
deprecated_reason='EC2 API related options are not supported.',
default=False,
help="""

20
nova/conf/service.py
View File

@ -126,6 +126,7 @@ Possible Values:
cfg.StrOpt('metadata_manager',
default='nova.api.manager.MetadataManager',
deprecated_for_removal=True,
deprecated_since='13.0.0',
help="Full class name for the service metadata manager."),
cfg.StrOpt('metadata_listen',
default="0.0.0.0",
@ -164,19 +165,23 @@ Possible Values:
cfg.StrOpt('compute_manager',
default='nova.compute.manager.ComputeManager',
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',
default='nova.console.manager.ConsoleProxyManager',
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',
default='nova.consoleauth.manager.ConsoleAuthManager',
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',
default='nova.cert.manager.CertManager',
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
# tree classes that are still legit options. In Newton we should
# turn this into a selector.
@ -187,12 +192,13 @@ Possible Values:
'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',
default='nova.scheduler.manager.SchedulerManager',
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):