1 # Copyright (C) 2022 Wind River Systems, Inc.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # client talking to Stx standalone
18 from o2common.service.client.base_client import BaseClient
19 from typing import List
21 from o2ims.domain import stx_object as ocloudModel
22 from o2common.config import config
23 from o2ims.domain.resource_type import ResourceTypeEnum
25 # from dcmanagerclient.api import client
26 from cgtsclient.client import get_client as get_stx_client
27 from cgtsclient.exc import EndpointException
28 from dcmanagerclient.api.client import client as get_dc_client
30 from o2common.helper import o2logging
31 logger = o2logging.get_logger(__name__)
34 CGTSCLIENT_ENDPOINT_ERROR_MSG = \
35 'Must provide Keystone credentials or user-defined endpoint and token'
38 class StxOcloudClient(BaseClient):
39 def __init__(self, driver=None):
41 self.driver = driver if driver else StxClientImp()
43 def _get(self, id) -> ocloudModel.StxGenericModel:
44 return self.driver.getInstanceInfo()
46 def _list(self, **filters):
47 return [self.driver.getInstanceInfo()]
49 def _set_stx_client(self):
53 class StxResourcePoolClient(BaseClient):
56 self.driver = StxClientImp()
58 def _get(self, id) -> ocloudModel.StxGenericModel:
59 return self.driver.getResourcePoolDetail(id)
61 def _list(self, **filters):
62 return self.driver.getResourcePoolList(**filters)
64 def _set_stx_client(self):
68 class StxDmsClient(BaseClient):
71 self.driver = StxClientImp()
73 def _get(self, name) -> ocloudModel.StxGenericModel:
74 return self.driver.getK8sDetail(name)
76 def _list(self, **filters):
77 return self.driver.getK8sList(**filters)
79 def _set_stx_client(self):
83 class StxPserverClient(BaseClient):
86 self.driver = StxClientImp()
88 def _get(self, id) -> ocloudModel.StxGenericModel:
89 return self.driver.getPserver(id)
91 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
92 filters['resourcepoolid']
93 return self.driver.getPserverList(**filters)
95 def _set_stx_client(self):
96 self.driver.setStxClient(self._pool_id)
99 class StxCpuClient(BaseClient):
102 # self._pserver_id = pserver_id
103 self.driver = StxClientImp()
105 def _get(self, id) -> ocloudModel.StxGenericModel:
106 return self.driver.getCpu(id)
108 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
109 return self.driver.getCpuList(**filters)
111 def _set_stx_client(self):
112 self.driver.setStxClient(self._pool_id)
115 class StxMemClient(BaseClient):
118 self.driver = StxClientImp()
120 def _get(self, id) -> ocloudModel.StxGenericModel:
121 return self.driver.getMem(id)
123 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
124 return self.driver.getMemList(**filters)
126 def _set_stx_client(self):
127 self.driver.setStxClient(self._pool_id)
130 class StxEthClient(BaseClient):
133 self.driver = StxClientImp()
135 def _get(self, id) -> ocloudModel.StxGenericModel:
136 return self.driver.getEthernet(id)
138 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
139 return self.driver.getEthernetList(**filters)
141 def _set_stx_client(self):
142 self.driver.setStxClient(self._pool_id)
145 class StxIfClient(BaseClient):
148 self.driver = StxClientImp()
150 def _get(self, id) -> ocloudModel.StxGenericModel:
151 return self.driver.getIf(id)
153 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
154 return self.driver.getIfList(**filters)
156 def _set_stx_client(self):
157 self.driver.setStxClient(self._pool_id)
160 class StxIfPortClient(BaseClient):
163 self.driver = StxClientImp()
165 def _get(self, id) -> ocloudModel.StxGenericModel:
166 return self.driver.getPort(id)
168 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
169 return self.driver.getPortList(**filters)
171 def _set_stx_client(self):
172 self.driver.setStxClient(self._pool_id)
175 class StxDevClient(BaseClient):
178 self.driver = StxClientImp()
180 def _get(self, id) -> ocloudModel.StxGenericModel:
181 return self.driver.getDevice(id)
183 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
184 return self.driver.getDeviceList(**filters)
186 def _set_stx_client(self):
187 self.driver.setStxClient(self._pool_id)
190 class StxAccClient(BaseClient):
193 self.driver = StxClientImp()
195 def _get(self, id) -> ocloudModel.StxGenericModel:
196 return self.driver.getAccelerator(id)
198 def _list(self, **filters) -> List[ocloudModel.StxGenericModel]:
199 return self.driver.getAcceleratorList(**filters)
201 def _set_stx_client(self):
202 self.driver.setStxClient(self._pool_id)
205 # internal driver which implement client call to Stx Standalone and DC instance
206 class StxClientImp(object):
207 def __init__(self, stx_client=None, dc_client=None):
209 self.stxclient = stx_client if stx_client else self.getStxClient()
210 self.dcclient = dc_client if dc_client else self.getDcmanagerClient()
211 # if subcloud_id is not None:
212 # self.stxclient = self.getSubcloudClient(subcloud_id)
214 def getStxClient(self):
215 os_client_args = config.get_stx_access_info()
216 config_client = get_stx_client(**os_client_args)
219 def getDcmanagerClient(self):
220 os_client_args = config.get_dc_access_info()
221 config_client = get_dc_client(**os_client_args)
224 def getSubcloudClient(self, subcloud_id):
225 subcloud = self.dcclient.subcloud_manager.\
226 subcloud_additional_details(subcloud_id)
227 logger.debug('subcloud name: %s, oam_floating_ip: %s' %
228 (subcloud[0].name, subcloud[0].oam_floating_ip))
230 os_client_args = config.get_stx_access_info(
231 region_name=subcloud[0].name,
232 subcloud_hostname=subcloud[0].oam_floating_ip)
233 logger.info(os_client_args)
234 config_client = get_stx_client(**os_client_args)
235 except EndpointException as e:
236 msg = e.format_message()
237 if CGTSCLIENT_ENDPOINT_ERROR_MSG in msg:
238 os_client_args = config.get_stx_access_info(
239 region_name=subcloud[0].name, sub_is_https=True,
240 subcloud_hostname=subcloud[0].oam_floating_ip)
241 logger.info(os_client_args)
242 config_client = get_stx_client(**os_client_args)
244 raise ValueError('Stx endpoint exception: %s' % msg)
246 raise ValueError('cgtsclient get subcloud client failed')
250 def setStxClient(self, resource_pool_id):
251 systems = self.stxclient.isystem.list()
252 if resource_pool_id == systems[0].uuid:
253 logger.debug('Stx Client not change: %s' % resource_pool_id)
256 subclouds = self.getSubcloudList()
257 for subcloud in subclouds:
258 subcloud_stxclient = self.getSubcloudClient(subcloud.subcloud_id)
259 systems = subcloud_stxclient.isystem.list()
260 # logger.debug('subcloud %s id: %s' %
261 # (systems[0].name, systems[0].uuid))
262 # logger.debug('subcloud: %s' % (systems[0].to_dict()))
263 if resource_pool_id == systems[0].uuid:
264 self.stxclient = subcloud_stxclient
266 def getInstanceInfo(self) -> ocloudModel.StxGenericModel:
267 systems = self.stxclient.isystem.list()
268 logger.debug('systems:' + str(systems[0].to_dict()))
269 # logger.debug('systems[0] uuid: ' + str(systems[0].uuid))
270 return ocloudModel.StxGenericModel(
271 ResourceTypeEnum.OCLOUD, systems[0]) if systems else None
273 def getSubcloudList(self):
274 subs = self.dcclient.subcloud_manager.list_subclouds()
275 known_subs = [sub for sub in subs if sub.sync_status != 'unknown']
278 def getResourcePoolList(self, **filters) -> List[
279 ocloudModel.StxGenericModel]:
280 systems = self.stxclient.isystem.list()
281 logger.debug('system controller distributed_cloud_role:' +
282 str(systems[0].distributed_cloud_role))
284 if systems[0].distributed_cloud_role is None or \
285 systems[0].distributed_cloud_role != 'systemcontroller':
286 return [ocloudModel.StxGenericModel(
287 ResourceTypeEnum.RESOURCE_POOL,
288 self._respoolconverter(systems[0]))]
291 if config.get_system_controller_as_respool():
292 pools.append(systems[0])
294 subclouds = self.getSubcloudList()
295 logger.debug('subclouds numbers: %s' % len(subclouds))
296 for subcloud in subclouds:
298 subcloud_stxclient = self.getSubcloudClient(
299 subcloud.subcloud_id)
300 systems = subcloud_stxclient.isystem.list()
301 logger.debug('systems:' + str(systems[0].to_dict()))
302 pools.append(systems[0])
303 except Exception as ex:
304 logger.warning('Failed get cgstclient of subcloud %s: %s' %
308 return [ocloudModel.StxGenericModel(
309 ResourceTypeEnum.RESOURCE_POOL,
310 self._respoolconverter(
311 respool)) for respool in pools if respool]
313 def getResourcePoolDetail(self, id):
314 self.setStxClient(id)
315 systems = self.stxclient.isystem.list()
316 logger.debug('systems:' + str(systems[0].to_dict()))
317 return ocloudModel.StxGenericModel(
318 ResourceTypeEnum.RESOURCE_POOL, systems[0]) if systems else None
320 def getPserverList(self, **filters) -> List[ocloudModel.StxGenericModel]:
321 hosts = self.stxclient.ihost.list()
322 logger.debug('host 1:' + str(hosts[0].to_dict()))
323 return [ocloudModel.StxGenericModel(
324 ResourceTypeEnum.PSERVER, self._hostconverter(host))
325 for host in hosts if host and (host.availability == 'available'
326 or host.availability == 'degraded')]
328 def getPserver(self, id) -> ocloudModel.StxGenericModel:
329 host = self.stxclient.ihost.get(id)
330 logger.debug('host:' + str(host.to_dict()))
331 return ocloudModel.StxGenericModel(
332 ResourceTypeEnum.PSERVER, self._hostconverter(host))
334 def getK8sList(self, **filters) -> List[ocloudModel.StxGenericModel]:
335 systems = self.stxclient.isystem.list()
336 logger.debug('system controller distributed_cloud_role:' +
337 str(systems[0].distributed_cloud_role))
339 if systems[0].distributed_cloud_role is None or \
340 systems[0].distributed_cloud_role != 'systemcontroller':
341 k8sclusters = self.stxclient.kube_cluster.list()
342 setattr(k8sclusters[0], 'cloud_name', systems[0].name)
343 logger.debug('k8sresources[0]:' + str(k8sclusters[0].to_dict()))
344 # logger.debug('k8sresources[0] cluster_api_endpoint: ' +
345 # str(k8sclusters[0].cluster_api_endpoint))
346 return [ocloudModel.StxGenericModel(
347 ResourceTypeEnum.DMS,
348 self._k8sconverter(k8sres), self._k8shasher(k8sres))
349 for k8sres in k8sclusters if k8sres]
352 if config.get_system_controller_as_respool():
353 k8sclusters = self.stxclient.kube_cluster.list()
354 setattr(k8sclusters[0], 'cloud_name', systems[0].name)
355 logger.debug('k8sresources[0]:' + str(k8sclusters[0].to_dict()))
356 # logger.debug('k8sresources[0] cluster_api_endpoint: ' +
357 # str(k8sclusters[0].cluster_api_endpoint))
358 k8s_list.append(k8sclusters[0])
360 subclouds = self.getSubcloudList()
361 logger.debug('subclouds numbers: %s' % len(subclouds))
362 for subcloud in subclouds:
364 subcloud_stxclient = self.getSubcloudClient(
365 subcloud.subcloud_id)
366 systems = subcloud_stxclient.isystem.list()
367 k8sclusters = subcloud_stxclient.kube_cluster.list()
368 setattr(k8sclusters[0], 'cloud_name', systems[0].name)
369 logger.debug('k8sresources[0]:' +
370 str(k8sclusters[0].to_dict()))
371 # logger.debug('k8sresources[0] cluster_api_endpoint: ' +
372 # str(k8sclusters[0].cluster_api_endpoint))
373 k8s_list.append(k8sclusters[0])
374 except Exception as ex:
375 logger.warning('Failed get cgstclient of subcloud %s: %s' %
379 return [ocloudModel.StxGenericModel(ResourceTypeEnum.DMS,
380 self._k8sconverter(k8sres), self._k8shasher(k8sres))
381 for k8sres in k8s_list if k8sres]
383 def getK8sDetail(self, name) -> ocloudModel.StxGenericModel:
384 systems = self.stxclient.isystem.list()
386 k8sclusters = self.stxclient.kube_cluster.list()
387 # logger.debug("k8sresources[0]:" + str(k8sclusters[0].to_dict()))
388 setattr(k8sclusters[0], 'cloud_name', systems[0].name)
389 k8scluster = k8sclusters.pop()
391 sname = name.split('.')
392 cloud_name = '.'.join(sname[:-1])
394 if cloud_name == systems[0].name:
395 k8scluster = self.stxclient.kube_cluster.get(k8s_name)
396 setattr(k8scluster, 'cloud_name', cloud_name)
398 subclouds = self.getSubcloudList()
400 sub.subcloud_id for sub in subclouds
401 if sub.name == cloud_name][0]
402 subcloud_stxclient = self.getSubcloudClient(subcloud_id)
403 k8scluster = subcloud_stxclient.kube_cluster.get(k8s_name)
404 setattr(k8scluster, 'cloud_name', cloud_name)
405 # logger.debug('k8sresources[0]:' +
406 # str(k8sclusters[0].to_dict()))
407 # logger.debug('k8sresources[0] cluster_api_endpoint: ' +
408 # str(k8sclusters[0].cluster_api_endpoint))
412 logger.debug('k8sresource:' + str(k8scluster.to_dict()))
413 return ocloudModel.StxGenericModel(
414 ResourceTypeEnum.DMS,
415 self._k8sconverter(k8scluster), self._k8shasher(k8scluster))
417 def getCpuList(self, **filters) -> List[ocloudModel.StxGenericModel]:
418 hostid = filters.get('hostid', None)
419 assert (hostid is not None), 'missing hostid to query icpu list'
420 cpulist = self.stxclient.icpu.list(hostid)
421 return [ocloudModel.StxGenericModel(
422 ResourceTypeEnum.PSERVER_CPU,
423 self._cpuconverter(cpures)) for cpures in cpulist if cpures]
425 def getCpu(self, id) -> ocloudModel.StxGenericModel:
426 cpuinfo = self.stxclient.icpu.get(id)
427 return ocloudModel.StxGenericModel(
428 ResourceTypeEnum.PSERVER_CPU, self._cpuconverter(cpuinfo))
430 def getMemList(self, **filters) -> List[ocloudModel.StxGenericModel]:
431 hostid = filters.get('hostid', None)
432 assert (hostid is not None), 'missing hostid to query imem list'
433 memlist = self.stxclient.imemory.list(hostid)
434 return [ocloudModel.StxGenericModel(
435 ResourceTypeEnum.PSERVER_RAM,
436 self._memconverter(memories)) for memories in memlist if memories]
438 def getMem(self, id) -> ocloudModel.StxGenericModel:
439 meminfo = self.stxclient.imemory.get(id)
440 return ocloudModel.StxGenericModel(
441 ResourceTypeEnum.PSERVER_RAM, self._memconverter(meminfo))
443 def getEthernetList(self, **filters) -> List[ocloudModel.StxGenericModel]:
444 hostid = filters.get('hostid', None)
445 assert (hostid is not None), 'missing hostid to query port list'
446 ethlist = self.stxclient.ethernet_port.list(hostid)
447 return [ocloudModel.StxGenericModel(
448 ResourceTypeEnum.PSERVER_ETH,
449 self._ethconverter(eth)) for eth in ethlist if eth]
451 def getEthernet(self, id) -> ocloudModel.StxGenericModel:
452 ethinfo = self.stxclient.ethernet_port.get(id)
453 return ocloudModel.StxGenericModel(
454 ResourceTypeEnum.PSERVER_ETH, self._ethconverter(ethinfo))
456 def getIfList(self, **filters) -> List[ocloudModel.StxGenericModel]:
457 hostid = filters.get('hostid', None)
458 assert (hostid is not None), 'missing hostid to query iinterface list'
459 iflist = self.stxclient.iinterface.list(hostid)
460 return [ocloudModel.StxGenericModel(
461 ResourceTypeEnum.PSERVER_IF,
462 self._ifconverter(ifs)) for ifs in iflist if ifs]
464 def getIf(self, id) -> ocloudModel.StxGenericModel:
465 ifinfo = self.stxclient.iinterface.get(id)
466 return ocloudModel.StxGenericModel(
467 ResourceTypeEnum.PSERVER_IF, self._ifconverter(ifinfo))
469 def getPortList(self, **filters) -> List[ocloudModel.StxGenericModel]:
470 ifid = filters.get('interfaceid', None)
471 assert (ifid is not None), 'missing interface id to query port list'
472 portlist = self.stxclient.iinterface.list_ports(ifid)
473 return [ocloudModel.StxGenericModel(
474 ResourceTypeEnum.PSERVER_IF_PORT,
475 port) for port in portlist if port]
477 def getPort(self, id) -> ocloudModel.StxGenericModel:
478 portinfo = self.stxclient.port.get(id)
479 return ocloudModel.StxGenericModel(
480 ResourceTypeEnum.PSERVER_IF_PORT, portinfo)
482 def getDeviceList(self, **filters) -> List[ocloudModel.StxGenericModel]:
483 hostid = filters.get('hostid', None)
484 assert (hostid is not None), 'missing hostid to query pci device list'
485 pci_dev_list = self.stxclient.pci_device.list(hostid)
486 return [ocloudModel.StxGenericModel(
487 ResourceTypeEnum.PSERVER_PCI_DEV,
488 self._devconverter(pci_dev))
489 for pci_dev in pci_dev_list if pci_dev]
491 def getDevice(self, id) -> ocloudModel.StxGenericModel:
492 pciinfo = self.stxclient.pci_device.get(id)
493 return ocloudModel.StxGenericModel(
494 ResourceTypeEnum.PSERVER_PCI_DEV, self._devconverter(pciinfo))
496 def getAcceleratorList(self, **filters) -> \
497 List[ocloudModel.StxGenericModel]:
498 hostid = filters.get('hostid', None)
499 assert (hostid is not None), 'missing hostid to query accelerator list'
500 pci_dev_list = self.stxclient.pci_device.list(hostid)
502 for pci_dev in pci_dev_list:
503 if pci_dev.pvendor_id in ['8086']:
504 if pci_dev.pdevice_id in ['0d5c', '0d5d']:
505 logger.info('Accelerator vendor ID: {}, device ID: {}'.
506 format(pci_dev.pvendor_id, pci_dev.pdevice_id))
507 acc_list.append(ocloudModel.StxGenericModel(
508 ResourceTypeEnum.PSERVER_ACC,
509 self._devconverter(pci_dev)))
512 def getAccelerator(self, id) -> ocloudModel.StxGenericModel:
513 pciinfo = self.stxclient.pci_device.get(id)
514 return ocloudModel.StxGenericModel(
515 ResourceTypeEnum.PSERVER_ACC, self._devconverter(pciinfo))
517 def _getIsystems(self):
518 return self.stxclient.isystem.list()
520 def _getIsystem(self, id=None):
522 return self.stxclient.isystem.get(id)
524 isystems = self.stxclient.isystem.list()
525 if len(isystems) != 1 and not id:
526 raise Exception('No system uuid was provided and '
527 'more than one system exists in the account.')
531 def _respoolconverter(res_pool):
532 setattr(res_pool, 'name', res_pool.region_name)
536 def _hostconverter(host):
537 setattr(host, 'name', host.hostname)
541 def _cpuconverter(cpu):
542 setattr(cpu, 'name', cpu.ihost_uuid.split(
543 '-', 1)[0] + '-cpu-'+str(cpu.cpu))
547 def _memconverter(mem):
548 setattr(mem, 'name', mem.ihost_uuid.split('-', 1)[0] +
549 '-mem-node-'+str(mem.numa_node))
553 def _ethconverter(eth):
554 setattr(eth, 'name', eth.host_uuid.split('-', 1)[0] + '-'+eth.name)
555 setattr(eth, 'updated_at', None)
556 setattr(eth, 'created_at', None)
560 def _ifconverter(ifs):
561 setattr(ifs, 'name', ifs.ihost_uuid.split('-', 1)[0] + '-'+ifs.ifname)
562 setattr(ifs, 'updated_at', None)
563 setattr(ifs, 'created_at', None)
567 def _devconverter(dev):
568 setattr(dev, 'name', dev.host_uuid.split('-', 1)[0] + '-'+dev.name)
572 def _k8sconverter(cluster):
573 setattr(cluster, 'name', cluster.cloud_name +
574 '.' + cluster.cluster_name)
575 setattr(cluster, 'uuid',
576 uuid.uuid3(uuid.NAMESPACE_URL, cluster.name))
577 setattr(cluster, 'updated_at', None)
578 setattr(cluster, 'created_at', None)
579 setattr(cluster, 'events', [])
580 logger.debug('k8s cluster name/uuid:' +
581 cluster.name + '/' + str(cluster.uuid))
585 def _k8shasher(cluster):
586 return str(hash((cluster.cluster_name, cluster.cloud_name,
587 cluster.cluster_api_endpoint, cluster.admin_user)))