Improve Help Text of Configuration Options in Glance and Glance Store

[Hemanth Makkapati]

The overall aim is operators should not need to read and understand the code to know how to configure the system.

This lite-spec is focusing on making sure oslo.config has all the information required to generate good sample configuration files and generating good documentation for the configuration options. This spec is not focusing on how the documentation is generated from the option definitions.

Most importantly, we need a good description for each of the configuration options, set in the help text of the option. This means developers reviewing each configuration option descriptions and adding any missing details.

Nova has found standardizing around a template has helped build some consistency in what is described in the help text for each option. This template, shown below, probably works well for Glance too.

# A short description about what it does. If it is a unit (e.g. timeout)
# describe the unit which is used (seconds, megabyte, mebibyte, ...)

# A long description what the impact and scope is. The operators should
# know the expected change in the behavior of Glance if they tweak this.

Possible values:

# Description of possible values. Especially if this is an option
# with numeric values (int, float), describe the edge cases (like the
# min value, max value, 0, -1). Further, for choices which are not
# obviously named, please describe the affect of each choice.
# Note: this does not replace the need for StrOpt.choices, StrOpt.regex,
# IntOpt.min, etc.

Related options:

# Which other config options have to be considered when I change this
# one? If it stands solely on its own, use "None"
# Note: this does not replace the proposed Opt.related_options, it's used
# when extra details are required.

When reviewing the description of the configuration, it's worth reviewing the other parameters passed to ``oslo.config``. There have been features added to make the opt definition more precise, but some of the options have not been updated since those new features were added.

We must pay particular attention to:

* Option type: make sure you are using the best type, and in some cases making better use of custom option types.
* Check if there is any extra options that could be used for that type of option to help improve the documentation, such as StrOpt.choices, IntOpt.min
* Deprecated: look at deprecating options that are best removed rather than having the documentation improved. Look at removing options that have been deprecated for several releases, but not yet removed. Be sure to set the deprecated_reason setting.
* Look out for bad defaults that force install guides to tell users to set configuration value because the default would never work. Always optimize the default for operators rather than the test environment.

(NOTE: This is mostly taken from the cross-project spec [0] and adapted to Glance)
[0] https://review.openstack.org/#/c/295543/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/307978
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=a37cc47817ccfffc06eb74c69295ac722a6a85a8
Submitter: Jenkins
Branch: master

commit a37cc47817ccfffc06eb74c69295ac722a6a85a8
Author: Hemanth Makkapati <email address hidden>
Date: Tue Apr 19 13:17:38 2016 -0500

    Improve help text of image cache opts

    Change-Id: Ifa88896d475a2fed3003ed68f7aadde7b3c28616
    Partial-Bug: #1570946

[Michael Glaser (mikeg451)]

Hemanth,

I'm a new developer, but shouldn't you have assigned this bug to yourself before working on it?
I started looking at this as an available bug until I saw you had your glance commit merged.
Are you also working on the glance_store bug? If so, could you please assign yourself to the bug?

Thanks

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/316314
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=0a606a5b42b3730ae58dfae01bb91b514ba749a3
Submitter: Jenkins
Branch: master

commit 0a606a5b42b3730ae58dfae01bb91b514ba749a3
Author: Hemanth Makkapati <email address hidden>
Date: Fri May 13 18:42:53 2016 -0500

    Improve help text of swift driver opts

    Partial Bug: #1570946

    Change-Id: I6b46dfc9598835181fe46647bd3e6865db89d3fd

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/318910

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/319396

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/319467

[Hemanth Makkapati (hemanth-makkapati)]

Michael,
You are absolutely right! I apologize.
This really isn't a bug though. It's a lite-spec (in its old form).
Although I started some work on it, there is a lot of room for contribution.

All the glance configurations options are gathered here: https://etherpad.openstack.org/p/improving-glance-config-opts
If you'd like to contribute to improving help text, which I think is a great starting point for new developers, please feel free to mark your name against the ones you are interested in and submit patches away to glory!

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/326126
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=d573b6f22047ba35ede5c18df610d78b065819bc
Submitter: Jenkins
Branch: master

commit d573b6f22047ba35ede5c18df610d78b065819bc
Author: Dharini Chandrasekar <email address hidden>
Date: Mon Jun 6 20:05:27 2016 +0000

    Improving help text for public_endpoint

    Change-Id: If18dc18582bbb3e388ec914af3cba784316879aa
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/335671
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=280a0273879423f8f68a76584573b4a146de90be
Submitter: Jenkins
Branch: master

commit 280a0273879423f8f68a76584573b4a146de90be
Author: Dharini Chandrasekar <email address hidden>
Date: Wed Jun 29 21:23:37 2016 +0000

    Improving help text for context middleware opts

    Partial-Bug: #1570946

    Change-Id: I61b55e169e37e4bc73a374311283184cd0b26c8b

[OpenStack Infra (hudson-openstack)]

Change abandoned by Itisha Dewan (<email address hidden>) on branch: master
Review: https://review.openstack.org/343238
Reason: The S3 driver has been removed

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/340536
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=276b40b86684618ac51b4f89b791ed84ca3aebf8
Submitter: Jenkins
Branch: master

commit 276b40b86684618ac51b4f89b791ed84ca3aebf8
Author: Dharini Chandrasekar <email address hidden>
Date: Mon Jul 11 19:24:30 2016 +0000

    Improving help text for taskflow executor opts.

    Adding improved help texts for the config options engine_mode and
    max_workers

    Partial-Bug: #1570946

    Change-Id: I2c14301ac3ed881dc80c0e9bff3a092bc1cf0bc5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/345109
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=71d09f0649cde4dc1e359da85cb53e37076fd53b
Submitter: Jenkins
Branch: master

commit 71d09f0649cde4dc1e359da85cb53e37076fd53b
Author: Dharini Chandrasekar <email address hidden>
Date: Thu Jul 21 00:12:28 2016 +0000

    Improving help text for proprty utils opts.

    Adding improved help text for property_protection_file and
    property_protection_rule_format

    Change-Id: I93ecba6c2bb4dc89e41e4a450e397562c7ff064b
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/342286
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=2a60cdf6e5409e3bf7a29f8515b28d4e9cfc8a67
Submitter: Jenkins
Branch: master

commit 2a60cdf6e5409e3bf7a29f8515b28d4e9cfc8a67
Author: Itisha Dewan <email address hidden>
Date: Thu Jul 14 22:30:02 2016 +0530

    Improve the help text for vmware datastore driver opts

    Change-Id: I6c976612270938da6158488db692f764b7fa4baf
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/342485
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=d66d0c31852781f72f26b8438cbb3da225511285
Submitter: Jenkins
Branch: master

commit d66d0c31852781f72f26b8438cbb3da225511285
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Jul 15 01:09:17 2016 +0000

    Improving help text for swift_store_utils opts

    Adding improved help texts for default_swift_reference and
    swift_store_config_file and deprecated_reason for the
    deprecated options.

    Change-Id: Ie1145c7c907310f60fbb2a5bee021c00309f4e81
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/351911

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/345709
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=60a490d57d702924206ca234ac2d3d3b37895529
Submitter: Jenkins
Branch: master

commit 60a490d57d702924206ca234ac2d3d3b37895529
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Jul 22 00:30:11 2016 +0000

    Improving help text for location_strategy opt.

    Change-Id: I642d95cfe1fa2cc1db3b2aeae393ede5ef926594
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/342254

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/351832
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=a3262591701d8be1b6a3704f2b919e874af208d7
Submitter: Jenkins
Branch: master

commit a3262591701d8be1b6a3704f2b919e874af208d7
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Aug 5 16:22:08 2016 +0000

    Improving help text for Glance store Swift opts.

    Change-Id: I70aa0432d4fc625c3f79eabe1f94cf78e704cd25
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/341553
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=135bede1cac9e117613fc9d12b8a219716df38dd
Submitter: Jenkins
Branch: master

commit 135bede1cac9e117613fc9d12b8a219716df38dd
Author: Itisha Dewan <email address hidden>
Date: Wed Jul 13 20:22:59 2016 +0530

    Improve help text of http driver opts

    Change-Id: Id5ee58fe2628039c70a8518a596fe86f62790939
    Partial-Bug: #1570946
    Co-Authored-By: Itisha Dewan <email address hidden>
    Co-Authored-By: Hemanth Makkapati <email address hidden>

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/351911
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=e9b3efd38055d66e79a322f0bca5e9c79ce59960
Submitter: Jenkins
Branch: master

commit e9b3efd38055d66e79a322f0bca5e9c79ce59960
Author: Hemanth Makkapati <email address hidden>
Date: Fri Aug 5 15:38:13 2016 -0500

    Improve help text of filesystem store opts

    Added improved help text for filesystem_store_datadir,
    filesystem_store_datadirs, filesystem_store_file_perm and
    filesystem_store_metadata_file opts.

    Change-Id: Ie3d1e38d84da4178d60d21d4b75c6a015a73ae38
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/343237
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=b17d0930bc8bbad450dff12c4d2ffbf764f4aa63
Submitter: Jenkins
Branch: master

commit b17d0930bc8bbad450dff12c4d2ffbf764f4aa63
Author: Itisha Dewan <email address hidden>
Date: Sun Jul 17 04:53:17 2016 +0530

    Improve help text of rbd driver opts

    Change-Id: I246f8929cf19a93e9356a3296f24db03c92192c6
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/351902
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=3050338160f024c85f6457a51c3e274929d5f883
Submitter: Jenkins
Branch: master

commit 3050338160f024c85f6457a51c3e274929d5f883
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Aug 5 20:21:58 2016 +0000

    Improving help text for Sheepdog opts

    Partial-Bug: #1570946

    Change-Id: I73db318599445cf4af819f5794753c760a8fff67

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/354944

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/354944
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=5ff6709e0aeb03b0ecfe1793f711f04d2416f351
Submitter: Jenkins
Branch: master

commit 5ff6709e0aeb03b0ecfe1793f711f04d2416f351
Author: Hemanth Makkapati <email address hidden>
Date: Fri Aug 12 12:30:30 2016 -0500

    Remove "Services which consume this" section

    In the first few improvements to the help text of configuration
    options, the section "Services which consume this" was included
    to clearly indicate which services consume a particular
    configuration option. However, this is redundant information as
    all glance services have their configuration files. And, the very
    fact that a configuration option appears in a certain file
    indicates that the corresponding service potentially consumes it.

    Change-Id: I1dbaf620d5d9e7025a491b28546be66bfa4442c3
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/344047
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=fe58b4b0495241d06e4fddac28e2d41cdf8e6097
Submitter: Jenkins
Branch: master

commit fe58b4b0495241d06e4fddac28e2d41cdf8e6097
Author: Itisha Dewan <email address hidden>
Date: Tue Jul 19 12:01:34 2016 +0530

    Improve the help text for Swift driver opts

    Change-Id: If2c21a465b228155b6cfa372994e6d78a6d755c8
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/355622

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/351436
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=9b245541b18b055641fb7645f0b32147d0405efc
Submitter: Jenkins
Branch: master

commit 9b245541b18b055641fb7645f0b32147d0405efc
Author: Dharini Chandrasekar <email address hidden>
Date: Thu Aug 4 23:55:31 2016 +0000

    Improving help text for backend store opts.

    Change-Id: Idc416b1b1c9632987f104aa3f31279bbf0d372ec
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/329788
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=007aa986ff2a2575995306b77b85a87349cd38a7
Submitter: Jenkins
Branch: master

commit 007aa986ff2a2575995306b77b85a87349cd38a7
Author: Tomoki Sekiyama <email address hidden>
Date: Thu Jun 9 11:50:41 2016 +0900

    Improve help text of cinder driver opts

    Partial-Bug: #1570946

    Change-Id: Ib270314dd1405cfa05fc7bcade8a88ba8dc87033
    Co-Authored-By: Tomoki Sekiyama <email address hidden>
    Co-Authored-By: Hemanth Makkapati <email address hidden>

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/353094
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=cbe1e5d43db38a989b703e0995c70b2f8665d363
Submitter: Jenkins
Branch: master

commit cbe1e5d43db38a989b703e0995c70b2f8665d363
Author: Dharini Chandrasekar <email address hidden>
Date: Tue Aug 9 20:06:13 2016 +0000

    Improving help text for Swift store util opts.

    Adding improved help text for:
    swift_store_ssl_compression
    swift_store_retry_get_count
    swift_store_expire_soon_interval
    swift_store_use_trusts

    Change-Id: I1bcd8415e7b93b7693cc950d5d6531c770147206
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/355622
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=0ec9da6ce5e30848e6b060c98d91e072cbe4caf5
Submitter: Jenkins
Branch: master

commit 0ec9da6ce5e30848e6b060c98d91e072cbe4caf5
Author: Hemanth Makkapati <email address hidden>
Date: Mon Aug 15 14:36:21 2016 -0500

    Fix help text of swift_store_config_file

    While attempting to improve help text for configuration option
    "swift_store_config_file", None is incorrectly listed as a
    possible value. None is incorrect because a configuration option
    can either be set or not. It can't be set to None. When no value
    is set for a configuration option, it is inherently parsed as None
    by oslo.config. Hence, there is no need to specify None as a
    possible value.

    Also, the configuration option swift_store_config_file is marked as
    secret. Although the file pointed by this path can contain
    credentials, the path itself need not be marked secret. This in fact
    may make debugging harder if the file path is not logged clearly.

    Change-Id: If4fa246d642098e96093cb6be92b8cd9f4350268
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/351950
Committed: https://git.openstack.org/cgit/openstack/glance_store/commit/?id=044da5c3674c2165a49680e6f600028c1bc52679
Submitter: Jenkins
Branch: master

commit 044da5c3674c2165a49680e6f600028c1bc52679
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Aug 5 23:22:56 2016 +0000

    Improving help text for Swift store opts.

    Adding improved help text for swift_store_region, swift_store_endpoint
    and swift_store_service_type

    Partial-Bug: #1570946
    Change-Id: I81cf3502c88dcaddb91ca8c20bd43e9c7790a72f

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358113

[OpenStack Infra (hudson-openstack)]

Change abandoned by Hemanth Makkapati (<email address hidden>) on branch: master
Review: https://review.openstack.org/319396
Reason: Abandoning because the configuration options are deprecated as Erno pointed out.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/319467
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=cbb4b90e6b6f3ceebad0e5c098862469abdb9608
Submitter: Jenkins
Branch: master

commit cbb4b90e6b6f3ceebad0e5c098862469abdb9608
Author: Hemanth Makkapati <email address hidden>
Date: Fri May 20 16:45:52 2016 -0500

    Improve help text of quota opts

    Change-Id: I19c7c20f4ecad1cc6c2bd4d92bb154d2ca0bbac9
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/312720
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=9522d772b2a82df83e3b09c3d9a9a32cabedc4e2
Submitter: Jenkins
Branch: master

commit 9522d772b2a82df83e3b09c3d9a9a32cabedc4e2
Author: Hemanth Makkapati <email address hidden>
Date: Wed May 4 14:47:56 2016 -0500

    Improve help text of scrubber opts

    Change-Id: I05cb32e2d1943b0fc5954ab9158ed42887ab79a5
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/353781
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=7c73e643dbfd0786b53dd85cb3f2023c77b0d889
Submitter: Jenkins
Branch: master

commit 7c73e643dbfd0786b53dd85cb3f2023c77b0d889
Author: Alexander Bashmakov <email address hidden>
Date: Wed Aug 10 16:25:44 2016 -0700

    Improving help text for Notifier opts

    Change-Id: Ie2b369191dca7047d7345dacf026b7bbe2d115e3
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/318910
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=b158de35c08aa78578f374f125884607468e67d1
Submitter: Jenkins
Branch: master

commit b158de35c08aa78578f374f125884607468e67d1
Author: Hemanth Makkapati <email address hidden>
Date: Wed May 18 15:53:04 2016 -0500

    Improve help text of registry server opts

    Partial-Bug: #1570946

    Change-Id: Iad255d3ab5d96b91f897731f4f29cd804d6b1840

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/345692
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=91f37fd7e7839e88f2d2a2a5763a506c14117aa3
Submitter: Jenkins
Branch: master

commit 91f37fd7e7839e88f2d2a2a5763a506c14117aa3
Author: Dharini Chandrasekar <email address hidden>
Date: Thu Jul 21 22:14:31 2016 +0000

    Improving help text for store_type_preference opt.

    Change-Id: Ib15f17b40cc880a478a0d5fe222bc0e31935ab97
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/361393

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/340557
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=3d6857744c5992710595075695c97376a3c8e8f9
Submitter: Jenkins
Branch: master

commit 3d6857744c5992710595075695c97376a3c8e8f9
Author: Dharini Chandrasekar <email address hidden>
Date: Mon Jul 11 20:12:04 2016 +0000

    Improving help text for image conversion_format

    Adding improved help text for conversion_format which is used to
    change the image format for stored images automatically.

    Partial-Bug: #1570946

    Change-Id: I139472cb90e139d93c83ab7e0fc4d26aca6de161

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/361474

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/356083
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=56623710e199bbd750c381b42fc730b7c8401c72
Submitter: Jenkins
Branch: master

commit 56623710e199bbd750c381b42fc730b7c8401c72
Author: Alexander Bashmakov <email address hidden>
Date: Tue Aug 16 11:03:48 2016 -0700

    Improving help text of v1/v2 API & Registry opts

    Change-Id: I36e34b6eb6f8e9595c9bcf852b8c2cde614b2fc9
    Partial-bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/342947
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=45ab30407e6170eaf36b00e5f4e745d73044da0e
Submitter: Jenkins
Branch: master

commit 45ab30407e6170eaf36b00e5f4e745d73044da0e
Author: Dharini Chandrasekar <email address hidden>
Date: Fri Jul 15 16:25:04 2016 +0000

    Improving help text for RPC opt

    Adding improved help text for allowed_rpc_exception_modules opt.

    Change-Id: I4bf2257cef7d99110e67aefa58dad9055e4dfccb
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/361393
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=c8e4e80cd7bb2de1212ca3fa1041052faaa1d08c
Submitter: Jenkins
Branch: master

commit c8e4e80cd7bb2de1212ca3fa1041052faaa1d08c
Author: Hemanth Makkapati <email address hidden>
Date: Fri Aug 26 12:21:09 2016 -0500

    Improve help text of scrubber daemon option

    Change-Id: I87feeede2e9fb963d486633e8eacf2345a86a5a2
    Partial-bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358113
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=3ff3debc1427ba0da4c60ac8ff9ef66bbdfe1f6a
Submitter: Jenkins
Branch: master

commit 3ff3debc1427ba0da4c60ac8ff9ef66bbdfe1f6a
Author: Hemanth Makkapati <email address hidden>
Date: Fri Aug 19 15:46:31 2016 -0500

    Remove "Services which consume this" section

    In the first few improvements to the help text of configuration
    options, the section "Services which consume this" was included
    to clearly indicate which services consume a particular
    configuration option. However, this is redundant information as
    all glance services have their configuration files. And, the very
    fact that a configuration option appears in a certain file
    indicates that the corresponding service potentially consumes it.

    Hence, in this patch we drop the redundant section from the help text
    of configuration options it appears in. The configuration options
    that are impacted are:
    * public_endpoint (glance/api/glare/versions.py)
    * owner_is_tenant (glance/api/middleware/context.py)
    * admin_role (glance/api/middleware/context.py)
    * allow_anonymous_access (glance/api/middleware/context.py)
    * max_request_id_length (glance/api/middleware/context.py)
    * public_endpoint (glance/api/versions.py)
    * image_cache_driver (glance/image_cache/__init__.py)
    * image_cache_max_size (glance/image_cache/__init__.py)
    * image_cache_stall_time (glance/image_cache/__init__.py)
    * image_cache_dir (glance/image_cache/__init__.py)
    * image_cache_sqlite_db (glance/image_cache/drivers/sqlite.py)
    * admin_role (glance/scrubber.py)

    Change-Id: I9ea635368994a9f89bb4f19a82104499e5174b46
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Change abandoned by Hemanth Makkapati (<email address hidden>) on branch: master
Review: https://review.openstack.org/361474
Reason: This patch has been blocked without a genuine reason! The formatting issue that is cited to be the reason for blocking is not even related to this patch. Furthermore, the formatting issue is now fixed overall. There is no reason for this to remain blocked especially when the deadline to merge is a few hours away. Hence, abandoning this and posting a new patch is the only way to move ahead with this effort.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/363832

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/360743
Reason: This patch, despite not having any direct formatting issues was blocked due to a confusion in oslo's formatting (wrap_width) and has remained in blocked state.
Abandoning this and submitting a new patch in order to meet the Glance deadlines.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/360773
Reason: This patch was blocked due to a confusion in oslo's formatting (wrap_width) and has remained in blocked state though not having any formatting issues.
Abandoning this and submitting a new patch in order to meet the Glance deadlines.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/360043
Reason: This patch was blocked due to a confusion in oslo's formatting (wrap_width) and has remained in blocked state though not having any formatting issues.
Abandoning this and submitting a new patch to meet the Glance deadlines.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/341168
Reason: This patch was blocked due to a confusion in oslo's formatting (wrap_width) and has remained in blocked state though not having any formatting issues.
Abandoning this and submitting a new patch to meet the Glance deadlines.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Hemanth Makkapati (<email address hidden>) on branch: master
Review: https://review.openstack.org/344362
Reason: Abandoning in favor of https://review.openstack.org/#/c/363841/

[OpenStack Infra (hudson-openstack)]

Change abandoned by Brian Rosmaita (<email address hidden>) on branch: master
Review: https://review.openstack.org/361493
Reason: Resubmitting due to unavailability of core reviewer to remove -2.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dharini Chandrasekar (<email address hidden>) on branch: master
Review: https://review.openstack.org/363831
Reason: abandoning this and resubmitting a new patch as this one depends on an abandoned patch.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363857
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=5085b29bc23cd66d71014bfc9c611709ae2ff31e
Submitter: Jenkins
Branch: master

commit 5085b29bc23cd66d71014bfc9c611709ae2ff31e
Author: Brian Rosmaita <email address hidden>
Date: Fri Aug 26 18:06:35 2016 -0400

    Improving help text for metadefs config option

    Adding improved help text for the config option used to specify
    the location of the metadefs JSON files.

    Change-Id: Ia943444ac30c816e3e7f7e08d854334c106338cb
    Partial-bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363841
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=898c08797cbdd573ca7bfff48656ca3ecc72f0a9
Submitter: Jenkins
Branch: master

commit 898c08797cbdd573ca7bfff48656ca3ecc72f0a9
Author: Itisha Dewan <email address hidden>
Date: Tue Jul 19 22:08:26 2016 +0530

    Improve the help text for registry client opts

    Change-Id: Id384079480b53450a9f85a43fbbfbeabd36e4a86
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363834
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=34be9d9283b680e91c32cd10145545a0654634ed
Submitter: Jenkins
Branch: master

commit 34be9d9283b680e91c32cd10145545a0654634ed
Author: Dharini Chandrasekar <email address hidden>
Date: Thu Aug 25 19:27:13 2016 +0000

    Improving help text for send_identity_headers opt

    Change-Id: Id3e485643ffa761bb827a80f212339ac3c1d7a6a
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363839
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=6d8870940f3c38f9b692f0379783e9207874474e
Submitter: Jenkins
Branch: master

commit 6d8870940f3c38f9b692f0379783e9207874474e
Author: Dharini Chandrasekar <email address hidden>
Date: Tue Jul 19 15:25:16 2016 +0000

    Improving help text for WSGI server conf opts.

    Adding improved help texts for the config options to be used for
    WSGI servers of the API services.

    Change-Id: I8f2159f3f46a223685970548f5b6cb6f9cd34d57
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363832
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=1f5deddf2e3af229bac624559d86f21434ff4967
Submitter: Jenkins
Branch: master

commit 1f5deddf2e3af229bac624559d86f21434ff4967
Author: Hemanth Makkapati <email address hidden>
Date: Fri Aug 26 16:14:32 2016 -0500

    Improve help text of glance config opts

    Improves help text of "limit_param_default", "api_limit_max",
    "show_image_direct_url", "show_multiple_locations",
    "image_size_cap" and "allow_additional_image_properties"
    configuration options

    Change-Id: I9f5140fafcae6fbb083709a1061c21d3a57a206d
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363838
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=afb18df869946a4a1175fc20268417671da7dcf3
Submitter: Jenkins
Branch: master

commit afb18df869946a4a1175fc20268417671da7dcf3
Author: Dharini Chandrasekar <email address hidden>
Date: Wed Aug 24 18:46:06 2016 +0000

    Improving help text for Glance common-config opts

    Adding improved help text for ``flavor``, ``config_file``, ``task_executor``
    and ``work_dir``.

    Change-Id: Ica2757cc81b222364d863e00785b09a77774c4dc
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/363870
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=ab9811b8ee9fce07d99e0347a6e7fc66c1a68a67
Submitter: Jenkins
Branch: master

commit ab9811b8ee9fce07d99e0347a6e7fc66c1a68a67
Author: Dharini Chandrasekar <email address hidden>
Date: Thu Aug 25 20:19:12 2016 +0000

    Improving help text for common-config opts

    Adding improved help text for:
    ``pydev_worker_debug_host``
    ``pydev_worker_debug_port``
    ``metadata_encryption_key``
    ``digest_algorithm``

    Change-Id: I2b506dceef1070eef5fde22a8d50044b5d57b0b3
    Partial-Bug: #1570946

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/354332
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=71aca20b674367dfc571cae34c34c67f828dbf0c
Submitter: Jenkins
Branch: master

commit 71aca20b674367dfc571cae34c34c67f828dbf0c
Author: Alexander Bashmakov <email address hidden>
Date: Thu Aug 11 11:23:23 2016 -0700

    Improving help text for data access API option

    Partial-Bug: #1570946

    Co-Authored-By: Alexander Bashmakov <email address hidden>
    Co-Authored-By: Dharini Chandrasekar <email address hidden>

    Change-Id: Ib7e265c3b1c3fc7752c77ef75fa28c9b4151f8e3