58c39b7a80
Currently, during the ironic shell client construction, if only os_auth_token and endpoint arguments are passed, custom HTTPClient class based on requests' sessions is used. This is unnecessary, as there is admin_token auth type in keystoneauth that does basically the same, eliminating the need for our custom implementation. Apart from that, there is a none auth, which requires only passing the desired endpoint to use, so we can use it too without having to specify fake token strings anymore. Let's use these auth methods instead and deprecate HTTPClient. Also this patch deprecates a bunch of arguments to client.get_client function, changing them to the standard keystoneauth naming. DocImpact Story: 1696791 Task: 11836 Depends-On: https://review.openstack.org/559116 Change-Id: Ifc7b45d047c8882a41021e1604b74d17eac2e6e8
134 lines
5.6 KiB
Python
134 lines
5.6 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.
|
|
|
|
import logging
|
|
|
|
from keystoneauth1 import loading as kaloading
|
|
from oslo_utils import importutils
|
|
|
|
from ironicclient.common.i18n import _
|
|
from ironicclient import exc
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
# TODO(vdrok): remove in Stein
|
|
def convert_keystoneauth_opts(kwargs):
|
|
old_to_new_names = {
|
|
('os_auth_token',): 'token',
|
|
('os_username',): 'username',
|
|
('os_password',): 'password',
|
|
('os_auth_url',): 'auth_url',
|
|
('os_project_id',): 'project_id',
|
|
('os_project_name',): 'project_name',
|
|
('os_tenant_id',): 'tenant_id',
|
|
('os_tenant_name',): 'tenant_name',
|
|
('os_region_name',): 'region_name',
|
|
('os_user_domain_id',): 'user_domain_id',
|
|
('os_user_domain_name',): 'user_domain_name',
|
|
('os_project_domain_id',): 'project_domain_id',
|
|
('os_project_domain_name',): 'project_domain_name',
|
|
('os_service_type',): 'service_type',
|
|
('os_endpoint_type',): 'interface',
|
|
('ironic_url',): 'endpoint',
|
|
('os_cacert', 'ca_file'): 'cafile',
|
|
('os_cert', 'cert_file'): 'certfile',
|
|
('os_key', 'key_file'): 'keyfile'
|
|
}
|
|
for olds, new in old_to_new_names.items():
|
|
for old in olds:
|
|
if kwargs.get(old):
|
|
LOG.warning('The argument "%s" passed to get_client is '
|
|
'deprecated and will be removed in Stein release, '
|
|
'please use "%s" instead.', old, new)
|
|
kwargs.setdefault(new, kwargs[old])
|
|
|
|
|
|
def get_client(api_version, auth_type=None, os_ironic_api_version=None,
|
|
max_retries=None, retry_interval=None, **kwargs):
|
|
"""Get an authenticated client, based on the credentials.
|
|
|
|
:param api_version: the API version to use. Valid value: '1'.
|
|
:param auth_type: type of keystoneauth auth plugin loader to use.
|
|
:param os_ironic_api_version: ironic API version to use.
|
|
:param max_retries: Maximum number of retries in case of conflict error
|
|
:param retry_interval: Amount of time (in seconds) between retries in case
|
|
of conflict error.
|
|
:param kwargs: all the other params that are passed to keystoneauth.
|
|
"""
|
|
# TODO(TheJulia): At some point, we should consider possibly noting
|
|
# the "latest" flag for os_ironic_api_version to cause the client to
|
|
# auto-negotiate to the greatest available version, however we do not
|
|
# have the ability yet for a caller to cap the version, and will hold
|
|
# off doing so until then.
|
|
convert_keystoneauth_opts(kwargs)
|
|
if auth_type is None:
|
|
if 'endpoint' in kwargs:
|
|
if 'token' in kwargs:
|
|
auth_type = 'admin_token'
|
|
else:
|
|
auth_type = 'none'
|
|
elif 'token' in kwargs and 'auth_url' in kwargs:
|
|
auth_type = 'token'
|
|
else:
|
|
auth_type = 'password'
|
|
session = kwargs.get('session')
|
|
if not session:
|
|
loader = kaloading.get_plugin_loader(auth_type)
|
|
loader_options = loader.get_options()
|
|
# option.name looks like 'project-name', while dest will be the actual
|
|
# argument name to which the value will be passed to (project_name)
|
|
auth_options = [o.dest for o in loader_options]
|
|
# Include deprecated names as well
|
|
auth_options.extend([d.dest for o in loader_options
|
|
for d in o.deprecated])
|
|
auth_kwargs = {k: v for (k, v) in kwargs.items() if k in auth_options}
|
|
auth_plugin = loader.load_from_options(**auth_kwargs)
|
|
# Let keystoneauth do the necessary parameter conversions
|
|
session_loader = kaloading.session.Session()
|
|
session_opts = {k: v for (k, v) in kwargs.items() if k in
|
|
[o.dest for o in session_loader.get_conf_options()]}
|
|
session = session_loader.load_from_options(auth=auth_plugin,
|
|
**session_opts)
|
|
|
|
endpoint = kwargs.get('endpoint')
|
|
if not endpoint:
|
|
try:
|
|
# endpoint will be used to get hostname
|
|
# and port that will be used for API version caching.
|
|
endpoint = session.get_endpoint(
|
|
service_type=kwargs.get('service_type') or 'baremetal',
|
|
interface=kwargs.get('interface') or 'publicURL',
|
|
region_name=kwargs.get('region_name')
|
|
)
|
|
except Exception as e:
|
|
raise exc.AmbiguousAuthSystem(
|
|
_('Must provide Keystone credentials or user-defined '
|
|
'endpoint, error was: %s') % e)
|
|
|
|
ironicclient_kwargs = {
|
|
'os_ironic_api_version': os_ironic_api_version,
|
|
'max_retries': max_retries,
|
|
'retry_interval': retry_interval,
|
|
'session': session,
|
|
'endpoint_override': endpoint
|
|
}
|
|
|
|
return Client(api_version, **ironicclient_kwargs)
|
|
|
|
|
|
def Client(version, *args, **kwargs):
|
|
module = importutils.import_versioned_module('ironicclient',
|
|
version, 'client')
|
|
client_class = getattr(module, 'Client')
|
|
return client_class(*args, **kwargs)
|