skyline-apiserver/skyline_apiserver/client/utils.py
Arnaud Morin 51a5b4a483 Use service_type instead of service_name
When retrieving endpoints from keystone catalog, it's better to use
service_type rather than service_name because the name can be arbitrary
(some operator use custom names) while the service_type should always be
consistent.

Change-Id: I966f2d9f40b8306ba645363a4967139f44d6adde
Signed-off-by: Arnaud Morin <arnaud.morin@gmail.com>
2023-12-06 23:13:56 +01:00

180 lines
5.6 KiB
Python

# Copyright 2021 99cloud
#
# 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 __future__ import annotations
from typing import Any, Optional
from cinderclient.client import Client as CinderClient
from glanceclient.client import Client as GlanceClient
from keystoneauth1.access.access import AccessInfoV3
from keystoneauth1.identity.v3 import Password, Token
from keystoneauth1.session import Session
from keystoneclient.client import Client as KeystoneClient
from keystoneclient.httpclient import HTTPClient
from neutronclient.v2_0.client import Client as NeutronClient
from novaclient.client import Client as NovaClient
from starlette.concurrency import run_in_threadpool
from skyline_apiserver import schemas
from skyline_apiserver.config import CONF
from skyline_apiserver.types import constants
SESSION = None
async def generate_session(profile: schemas.Profile) -> Any:
auth_url = await get_endpoint(
region=profile.region,
service="identity",
session=get_system_session(),
)
kwargs = {
"auth_url": auth_url,
"token": profile.keystone_token,
"project_id": profile.project.id,
}
auth = Token(**kwargs)
session = Session(auth=auth, verify=CONF.default.cafile, timeout=constants.DEFAULT_TIMEOUT)
session.auth.auth_ref = await run_in_threadpool(session.auth.get_auth_ref, session)
return session
def get_system_session() -> Session:
global SESSION
if SESSION is not None:
return SESSION
auth = Password(
auth_url=CONF.openstack.keystone_url,
user_domain_name=CONF.openstack.system_user_domain,
username=CONF.openstack.system_user_name,
password=CONF.openstack.system_user_password,
project_name=CONF.openstack.system_project,
project_domain_name=CONF.openstack.system_project_domain,
reauthenticate=True,
)
SESSION = Session(auth=auth, verify=CONF.default.cafile, timeout=constants.DEFAULT_TIMEOUT)
return SESSION
async def get_system_scope_access(keystone_token: str, region: str) -> AccessInfoV3:
auth_url = await get_endpoint(region, "identity", get_system_session())
scope_auth = Token(auth_url, keystone_token, system_scope="all")
session = Session(
auth=scope_auth, verify=CONF.default.cafile, timeout=constants.DEFAULT_TIMEOUT
)
return await run_in_threadpool(session.auth.get_auth_ref, session)
async def get_access(session: Session) -> AccessInfoV3:
auth = session.auth
if auth._needs_reauthenticate():
auth.auth_ref = await run_in_threadpool(auth.get_auth_ref, session)
return auth.auth_ref
async def get_endpoint(region: str, service: str, session: Session) -> Any:
access = await get_access(session=session)
service_catalog = access.service_catalog
endpoint = service_catalog.get_urls(
region_name=region,
service_type=service,
interface=CONF.openstack.interface_type,
)
if not endpoint:
raise ValueError("Endpoint not found")
return endpoint[0]
async def keystone_client(
session: Session,
region: str,
global_request_id: Optional[str] = None,
version: str = constants.KEYSTONE_API_VERSION,
) -> HTTPClient:
endpoint = await get_endpoint(region, "identity", session=session)
client = KeystoneClient(
version=version,
session=session,
endpoint=endpoint,
global_request_id=global_request_id,
interface=CONF.openstack.interface_type,
)
return client
async def glance_client(
session: Session,
region: str,
global_request_id: Optional[str] = None,
version: str = constants.GLANCE_API_VERSION,
) -> HTTPClient:
endpoint = await get_endpoint(region, "image", session=session)
client = GlanceClient(
version=version,
session=session,
endpoint=endpoint,
global_request_id=global_request_id,
)
return client
async def nova_client(
session: Session,
region: str,
global_request_id: Optional[str] = None,
version: str = constants.NOVA_API_VERSION,
) -> HTTPClient:
endpoint = await get_endpoint(region, "compute", session=session)
client = NovaClient(
version=version,
session=session,
endpoint_override=endpoint,
global_request_id=global_request_id,
)
return client
async def cinder_client(
session: Session,
region: str,
global_request_id: Optional[str] = None,
version: str = constants.CINDER_API_VERSION,
) -> HTTPClient:
endpoint = await get_endpoint(region, "volumev3", session=session)
client = CinderClient(
version=version,
session=session,
endpoint_override=endpoint,
global_request_id=global_request_id,
)
return client
async def neutron_client(
session: Session,
region: str,
global_request_id: Optional[str] = None,
version: str = constants.NEUTRON_API_VERSION,
) -> HTTPClient:
endpoint = await get_endpoint(region, "network", session=session)
client = NeutronClient(
version=version,
session=session,
endpoint_override=endpoint,
global_request_id=global_request_id,
)
return client