conf: Deprecate 'torrent_' options

These are not tested and the feature either needs test coverage or
should be deprecated. Take the latter option, deprecating the feature
for a cycle to see if anyone actually cares about the feature.

Change-Id: I90206e6554bcbf5cd9105aa975c447c69640c923
Implements: bp centralize-config-options-ocata
This commit is contained in:
Stephen Finucane 2016-11-28 11:17:52 +00:00
parent 310562f52f
commit bee269cf3d
2 changed files with 64 additions and 0 deletions

View File

@ -159,6 +159,12 @@ session, which allows you to make concurrent XenAPI connections.
xenapi_torrent_opts = [ xenapi_torrent_opts = [
cfg.StrOpt('torrent_base_url', cfg.StrOpt('torrent_base_url',
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help=""" help="""
Base URL for torrent files; must contain a slash character (see RFC 1808, Base URL for torrent files; must contain a slash character (see RFC 1808,
step 6). step 6).
@ -166,9 +172,21 @@ step 6).
cfg.FloatOpt('torrent_seed_chance', cfg.FloatOpt('torrent_seed_chance',
default=1.0, default=1.0,
min=0, min=0,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help='Probability that peer will become a seeder (1.0 = 100%)'), help='Probability that peer will become a seeder (1.0 = 100%)'),
cfg.IntOpt('torrent_seed_duration', cfg.IntOpt('torrent_seed_duration',
default=3600, default=3600,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help=""" help="""
Number of seconds after downloading an image via BitTorrent that it should Number of seconds after downloading an image via BitTorrent that it should
be seeded for other peers.' be seeded for other peers.'
@ -176,18 +194,42 @@ be seeded for other peers.'
cfg.IntOpt('torrent_max_last_accessed', cfg.IntOpt('torrent_max_last_accessed',
default=86400, default=86400,
min=0, min=0,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help=""" help="""
Cached torrent files not accessed within this number of seconds can be reaped. Cached torrent files not accessed within this number of seconds can be reaped.
"""), """),
cfg.PortOpt('torrent_listen_port_start', cfg.PortOpt('torrent_listen_port_start',
default=6881, default=6881,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help='Beginning of port range to listen on'), help='Beginning of port range to listen on'),
cfg.PortOpt('torrent_listen_port_end', cfg.PortOpt('torrent_listen_port_end',
default=6891, default=6891,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help='End of port range to listen on'), help='End of port range to listen on'),
cfg.IntOpt('torrent_download_stall_cutoff', cfg.IntOpt('torrent_download_stall_cutoff',
default=600, default=600,
min=0, min=0,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help=""" help="""
Number of seconds a download can remain at the same progress percentage w/o Number of seconds a download can remain at the same progress percentage w/o
being considered a stall. being considered a stall.
@ -195,6 +237,12 @@ being considered a stall.
cfg.IntOpt('torrent_max_seeder_processes_per_host', cfg.IntOpt('torrent_max_seeder_processes_per_host',
default=1, default=1,
min=-1, min=-1,
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
The torrent feature has not been tested nor maintained, and as such is being
removed.
""",
help=""" help="""
Maximum number of seeder processes to run concurrently within a given dom0 Maximum number of seeder processes to run concurrently within a given dom0
(-1 = no limit). (-1 = no limit).

View File

@ -0,0 +1,16 @@
---
deprecations:
- |
The XenServer driver provides support for downloading images via torrents.
This feature has not been tested, and it's not clear whether there's a
clear use case for such a feature. As a result, this feature is now
deprecated as are the following config options.
* ``torrent_base_url``
* ``torrent_seed_chance``
* ``torrent_seed_duration``
* ``torrent_max_last_accessed``
* ``torrent_listen_port_start``
* ``torrent_listen_port_end``
* ``torrent_download_stall_cutoff``
* ``torrent_max_seeder_processes_per_host``