From 3ff3debc1427ba0da4c60ac8ff9ef66bbdfe1f6a Mon Sep 17 00:00:00 2001 From: Hemanth Makkapati Date: Fri, 19 Aug 2016 15:46:31 -0500 Subject: [PATCH] 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 --- glance/api/glare/versions.py | 3 --- glance/api/middleware/context.py | 21 --------------------- glance/api/versions.py | 3 --- glance/image_cache/__init__.py | 12 ------------ glance/image_cache/drivers/sqlite.py | 3 --- glance/scrubber.py | 6 ------ 6 files changed, 48 deletions(-) diff --git a/glance/api/glare/versions.py b/glance/api/glare/versions.py index b73833c2..3f89596f 100644 --- a/glance/api/glare/versions.py +++ b/glance/api/glare/versions.py @@ -42,9 +42,6 @@ API service. Change the endpoint to represent the proxy URL if the API service is running behind a proxy. If the service is running behind a load balancer, add the load balancer's URL for this value. -Services which consume this: - * glance-api/glare-api - Possible values: * None * Proxy URL diff --git a/glance/api/middleware/context.py b/glance/api/middleware/context.py index da720d18..4b6e11ec 100644 --- a/glance/api/middleware/context.py +++ b/glance/api/middleware/context.py @@ -36,11 +36,6 @@ Setting it to False makes the image private to the associated user and sharing with other users within the same tenant (or "project") requires explicit image sharing via image membership. -Services which consume this: - * glance-api - * glare-api - * glance-registry - Possible values: * True * False @@ -59,12 +54,6 @@ administrative user. Users with this role will be granted administrative privileges. The default value for this option is 'admin'. -Services which consume this: - * glance-api - * glare-api - * glance-registry - * glance-scrubber - Possible values: * A string value which is a valid Keystone role @@ -83,11 +72,6 @@ unauthenticated users. When set to True, unauthenticated users can access the API with read-only privileges. This however only applies when using ContextMiddleware. -Services which consumes this: - * glance-api - * glare-api - * glance-registry - Possible values: * True * False @@ -106,11 +90,6 @@ the specified length. The default value is 64. Users can change this to any ineteger value between 0 and 16384 however keeping in mind that a larger value may flood the logs. -Services which consumes this: - * glance-api - * glare-api - * glance-registry - Possible values: * Integer value between 0 and 16384 diff --git a/glance/api/versions.py b/glance/api/versions.py index 75a10d3d..44aab5b4 100644 --- a/glance/api/versions.py +++ b/glance/api/versions.py @@ -41,9 +41,6 @@ API service. Change the endpoint to represent the proxy URL if the API service is running behind a proxy. If the service is running behind a load balancer, add the load balancer's URL for this value. -Services which consume this: - * glance-api/glare-api - Possible values: * None * Proxy URL diff --git a/glance/image_cache/__init__.py b/glance/image_cache/__init__.py index be1e7c21..31c33a95 100644 --- a/glance/image_cache/__init__.py +++ b/glance/image_cache/__init__.py @@ -56,9 +56,6 @@ store the information about cached images: information. It also requires a filesystem that sets ``atime`` on the files when accessed. -Services which consume this: - * glance-api - Possible values: * sqlite * xattr @@ -88,9 +85,6 @@ compares the current size of image cache and triggers a cleanup if the image cache grew beyond the size specified here. After the cleanup, the size of cache is less than or equal to size specified here. -Services which consume this: - * None (consumed by cache-pruner, an independent periodic task) - Possible values: * Any non-negative integer @@ -116,9 +110,6 @@ removed by cache-cleaner on its next run. It is recommended to run cache-cleaner as a periodic task on the Glance API nodes to keep the incomplete images from occupying disk space. -Services which consume this: - * None (consumed by cache-cleaner, an independent periodic task) - Possible values: * Any non-negative integer @@ -151,9 +142,6 @@ successful, the zero-sized file is deleted from the ``queue`` directory. If the download fails, the zero-sized file remains and it'll be retried the next time cache-prefetcher runs. -Services which consume this: - * glance-api - Possible values: * A valid path diff --git a/glance/image_cache/drivers/sqlite.py b/glance/image_cache/drivers/sqlite.py index 916294b4..89a87645 100644 --- a/glance/image_cache/drivers/sqlite.py +++ b/glance/image_cache/drivers/sqlite.py @@ -48,9 +48,6 @@ directory, specified by the configuration option ``image_cache_dir``. This is a lightweight database with just one table. -Services which consume this: - * glance-api - Possible values: * A valid relative path to sqlite file database diff --git a/glance/scrubber.py b/glance/scrubber.py index 0e6d931a..46214fa8 100644 --- a/glance/scrubber.py +++ b/glance/scrubber.py @@ -61,12 +61,6 @@ administrative user. Users with this role will be granted administrative privileges. The default value for this option is 'admin'. -Services which consume this: - * glance-api - * glare-api - * glance-registry - * glance-scrubber - Possible values: * A string value which is a valid Keystone role