5f521471e1
To get the placement_client OptGroup help text to generate in the docs, we have to use the OptGroup object in the list_opts() method rather than a string for the group name. https://docs.openstack.org/oslo.config/latest/cli/generator.html#defining-option-discovery-entry-points Change-Id: Ie728081caa205ded2435c6b95f5e8d4bbd23372c
42 lines
1.5 KiB
Python
42 lines
1.5 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from oslo_config import cfg
|
|
|
|
|
|
placement_group = cfg.OptGroup(
|
|
'placement_client',
|
|
title='Placement Service Options',
|
|
help="Configuration options for connecting to the placement API service")
|
|
|
|
placement_opts = [
|
|
cfg.StrOpt('api_version',
|
|
default='1.29',
|
|
help='microversion of placement API when using '
|
|
'placement service.'),
|
|
cfg.StrOpt('interface',
|
|
default='public',
|
|
choices=['internal', 'public', 'admin'],
|
|
help='Type of endpoint when using placement service.'),
|
|
cfg.StrOpt('region_name',
|
|
help='Region in Identity service catalog to use for '
|
|
'communication with the OpenStack service.')]
|
|
|
|
|
|
def register_opts(conf):
|
|
conf.register_group(placement_group)
|
|
conf.register_opts(placement_opts, group=placement_group)
|
|
|
|
|
|
def list_opts():
|
|
return [(placement_group, placement_opts)]
|