osm_mon/dashboarder/service.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2021 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact: glavado@whitestack.com or fbravo@whitestack.com
  22 ##
  23 import logging
  24
  25 from osm_mon.core.common_db import CommonDbClient
  26 from osm_mon.core.config import Config
  27 from osm_mon.core.keystone import KeystoneConnection
  28 from osm_mon.dashboarder.backends.grafana import GrafanaBackend
  29 from osm_mon import __path__ as mon_path
  30 from osm_mon.core.utils import find_in_list, create_filter_from_nsr
  31
  32 log = logging.getLogger(__name__)
  33
  34
  35 class DashboarderService:
  36     def __init__(self, config: Config):
  37         self.conf = config
  38         self.common_db = CommonDbClient(self.conf)
  39         self.grafana = GrafanaBackend(self.conf)
  40
  41         if bool(self.conf.get('keystone', 'enabled')):
  42             self.keystone = KeystoneConnection(self.conf)
  43         else:
  44             self.keystone = None
  45
  46     def create_dashboards(self):
  47         # TODO lavado: migrate these methods to mongo change streams
  48         # Lists all dashboards and OSM resources for later comparisons
  49         dashboard_uids = self.grafana.get_all_dashboard_uids()
  50         osm_resource_uids = []
  51         projects = []
  52
  53         # Check if keystone is the auth/projects backend and get projects from there
  54         if self.keystone:
  55             try:
  56                 projects.extend(
  57                     map(lambda project: {'_id': project.id, 'name': project.name}, self.keystone.getProjects())
  58                 )
  59             except Exception:
  60                 log.error('Cannot retrieve projects from keystone')
  61
  62         # Reads existing project list and creates a dashboard for each
  63         projects.extend(self.common_db.get_projects())
  64         for project in projects:
  65             project_id = project['_id']
  66             # Collect Project IDs for periodical dashboard clean-up
  67             osm_resource_uids.append(project_id)
  68             dashboard_path = '{}/dashboarder/templates/project_scoped.json'.format(mon_path[0])
  69             if project_id not in dashboard_uids:
  70                 project_name = project['name']
  71                 if project_name != "admin":
  72                     # Create project folder in Grafana only if user is not admin.
  73                     # Admin user's dashboard will be created in default folder
  74                     self.grafana.create_grafana_folders(project_name)
  75                 self.grafana.create_dashboard(project_id, project_name,
  76                                               dashboard_path)
  77                 log.debug('Created dashboard for Project: %s', project_id)
  78             else:
  79                 log.debug('Dashboard already exists')
  80
  81         # Reads existing NS list and creates a dashboard for each
  82         # TODO lavado: only create for ACTIVE NSRs
  83         nsrs = self.common_db.get_nsrs()
  84         for nsr in nsrs:
  85             nsr_id = nsr['_id']
  86             dashboard_path = '{}/dashboarder/templates/ns_scoped.json'.format(mon_path[0])
  87             # Collect NS IDs for periodical dashboard clean-up
  88             osm_resource_uids.append(nsr_id)
  89             # Check if the NSR's VNFDs contain metrics
  90             # Only one DF at the moment, support for this feature is comming in the future
  91             vnfds_profiles = nsr['nsd']["df"][0]['vnf-profile']
  92             for vnf_profile in vnfds_profiles:
  93                 try:
  94                     vnfd = self.common_db.get_vnfd_by_id(vnf_profile['vnfd-id'], create_filter_from_nsr(nsr))
  95                     # If there are metrics, create dashboard (if exists)
  96                     vdu_found = find_in_list(vnfd["vdu"], lambda a_vdu: "monitoring-parameter" in a_vdu)
  97                     if vdu_found:
  98                         if nsr_id not in dashboard_uids:
  99                             nsr_name = nsr['name']
 100                             project_id = nsr["_admin"]["projects_read"][0]
 101                             try:
 102                                 # Get project details from commondb
 103                                 project_details = self.common_db.get_project(project_id)
 104                                 project_name = project_details["name"]
 105                             except Exception as e:
 106                                 # Project not found in commondb
 107                                 if self.keystone:
 108                                     # Serach project in keystone
 109                                     for project in projects:
 110                                         if project_id == project['_id']:
 111                                             project_name = project["name"]
 112                                 else:
 113                                     log.info('Project %s not found', project_id)
 114                                     log.debug('Exception %s' % e)
 115                             self.grafana.create_dashboard(nsr_id, nsr_name,
 116                                                           dashboard_path, project_name)
 117                             log.debug('Created dashboard for NS: %s', nsr_id)
 118                         else:
 119                             log.debug('Dashboard already exists')
 120                         break
 121                     else:
 122                         log.debug('NS does not has metrics')
 123                 except Exception:
 124                     log.exception("VNFD is not valid or has been renamed")
 125                     continue
 126
 127         # Delete obsolete dashboards
 128         for dashboard_uid in dashboard_uids:
 129             if dashboard_uid not in osm_resource_uids:
 130                 self.grafana.delete_dashboard(dashboard_uid)
 131                 log.debug('Deleted obsolete dashboard: %s', dashboard_uid)
 132             else:
 133                 log.debug('All dashboards in use')
 134
 135     def create_grafana_user(self, user):
 136         self.grafana.create_grafana_users(user)
 137
 138     def create_grafana_team_member(self, project_data, userid=None, project_list=None, user=None):
 139         if user:
 140             user_name = user
 141         else:
 142             try:
 143                 # Get user details from  commondb
 144                 user = self.common_db.get_user_by_id(userid)
 145                 user_name = user["username"]
 146             except Exception as e:
 147                 # User not found in commondb
 148                 if self.keystone:
 149                     # Search user in keystone
 150                     user = self.keystone.getUserById(userid)
 151                     user_name = user.name
 152                 else:
 153                     log.info('User %s not found', userid)
 154                     log.debug('Exception %s' % e)
 155         if project_list:
 156             # user-project mapping is done by osm cli
 157             for proj in project_data:
 158                 project = self.common_db.get_project(proj["project"])
 159                 proj_name = project['name']
 160                 role_obj = self.common_db.get_role_by_id(proj["role"])
 161                 is_admin = role_obj["permissions"].get("admin")
 162                 self.grafana.create_grafana_teams_members(proj_name, user_name, is_admin, project_list)
 163         else:
 164             # user-project mapping is done by osm ui
 165             proj_list = []
 166             if self.keystone:
 167                 users_proj_list = self.keystone.getProjectsById(userid)
 168                 for project in users_proj_list:
 169                     proj_list.append(project.name)
 170             else:
 171                 users_proj_list = user.get("project_role_mappings")
 172                 for project in users_proj_list:
 173                     proj_data = self.common_db.get_project(project["project"])
 174                     proj_list.append(proj_data['name'])
 175             for proj in project_data:
 176                 if self.keystone:
 177                     # Backend authentication type is keystone
 178                     try:
 179                         # Getting project and role objects from keystone using ids
 180                         role_obj = self.keystone.getRoleById(proj["role"])
 181                         proj_data = self.keystone.getProjectsByProjectId(proj["project"])
 182                         log.info('role object {} {}'.format(role_obj.permissions, proj_data.name))
 183                         is_admin = role_obj.permissions['admin']
 184                     except Exception:
 185                         # Getting project and role objects from keystone using names
 186                         role_obj = self.keystone.getRoleByName(proj["role"])[0]
 187                         proj_data = self.keystone.getProjectsByProjectName(proj["project"])[0]
 188                         is_admin = role_obj.to_dict().get("permissions").get('admin')
 189                         log.info('role object {} {}'.format(role_obj.to_dict(), proj_data.name))
 190                     proj_name = proj_data.name
 191                 else:
 192                     # Backend authentication type is internal
 193                     try:
 194                         # Getting project and role object from commondb using names
 195                         role_obj = self.common_db.get_role_by_name(proj["role"])
 196                         proj_name = proj["project"]
 197                     except Exception:
 198                         # Getting project and role object from commondb using ids
 199                         role_obj = self.common_db.get_role_by_id(proj["role"])
 200                         proj_data = self.common_db.get_project(proj["project"])
 201                         proj_name = proj_data['name']
 202                     is_admin = role_obj["permissions"].get("admin")
 203                 self.grafana.create_grafana_teams_members(proj_name, user_name, is_admin, proj_list)
 204
 205     def create_grafana_team(self, team_name):
 206         self.grafana.create_grafana_teams(team_name)
 207
 208     def delete_grafana_user(self, user_name):
 209         self.grafana.delete_grafana_users(user_name)
 210
 211     def delete_grafana_team(self, project_name):
 212         self.grafana.delete_grafana_team(project_name)
 213
 214     def update_grafana_team(self, project_new_name, project_old_name):
 215         self.grafana.update_grafana_teams(project_new_name, project_old_name)
 216
 217     def remove_grafana_team_members(self, user_id, proj_data):
 218         try:
 219             # Get user details from  commondb
 220             user = self.common_db.get_user_by_id(user_id)
 221             user_name = user["username"]
 222         except Exception as e:
 223             # User not found in commondb
 224             if self.keystone:
 225                 # Find user in keystone
 226                 user = self.keystone.getUserById(user_id)
 227                 user_name = user.name
 228             else:
 229                 log.info('User %s not found', user_id)
 230                 log.debug('Exception %s' % e)
 231         self.grafana.remove_grafana_team_member(user_name, proj_data)