KATO Tomoyuki 7f0ce54249 Add plug-in summary for osc doc
Stevedore Sphinx extension handles this comment.
http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html

Change-Id: Id999b32cf00a79b1344a8fbaff55f8bd33b5b13d
2016-10-14 13:56:35 +09:00

57 lines
1.7 KiB
Python

# Copyright 2014 OpenStack Foundation
#
# 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.
"""OpenStackClient plugin for Telemetry Alarming service."""
from osc_lib import utils
DEFAULT_ALARMING_API_VERSION = '2'
API_VERSION_OPTION = 'os_alarming_api_version'
API_NAME = "alarming"
API_VERSIONS = {
"2": "aodhclient.v2.client.Client",
}
def make_client(instance):
"""Returns an queues service client."""
version = instance._api_version[API_NAME]
try:
version = int(version)
except ValueError:
version = float(version)
aodh_client = utils.get_client_class(
API_NAME,
version,
API_VERSIONS)
# NOTE(sileht): ensure setup of the session is done
instance.setup_auth()
return aodh_client(session=instance.session)
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-alarming-api-version',
metavar='<alarming-api-version>',
default=utils.env(
'OS_ALARMING_API_VERSION',
default=DEFAULT_ALARMING_API_VERSION),
help=('Queues API version, default=' +
DEFAULT_ALARMING_API_VERSION +
' (Env: OS_ALARMING_API_VERSION)'))
return parser