python-observabilityclient/observabilityclient/v1/deploy.py

#   Copyright 2022 Red Hat, Inc.
#
#   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 os
import requests
import shutil
import sys
import yaml

from osc_lib.i18n import _

from observabilityclient.v1 import base
from observabilityclient.utils import runner


class InventoryError(Exception):
    def __init__(self, err, out):
        self.err = err
        self.out = out

    def __str__(self):
        return ('Failed to generate or locate Ansible '
                'inventory file:\n%s\n%s' % (self.err or '', self.out))


INVENTORY = os.path.join(base.OBSWRKDIR, 'openstack-inventory.yaml')
INV_FALLBACKS = [
    '~/tripleo-deploy/{stack}/openstack-inventory.yaml',
    '~/tripleo-deploy/{stack}/tripleo-ansible-inventory.yaml',
    './overcloud-deploy/{stack}/openstack-inventory.yaml',
    './overcloud-deploy/{stack}/tripleo-ansible-inventory.yaml',
]
ENDPOINTS = os.path.join(base.OBSWRKDIR, 'scrape-endpoints.yaml')
STACKRC = os.path.join(base.OBSWRKDIR, 'stackrc')


def _curl(host: dict, port: int, timeout: int = 1) -> str:
    """Returns scraping endpoint URL if it is reachable
    otherwise returns None."""
    url = f'http://{host["ip"]}:{port}/metrics'
    try:
        r = requests.get(url, timeout=1)
        if r.status_code != 200:
            url = None
        r.close()
    except requests.exceptions.ConnectionError:
        url = None
    return url


class Discover(base.ObservabilityBaseCommand):
    """Generate Ansible inventory file and scrapable enpoints list file."""

    def get_parser(self, prog_name):
        parser = super().get_parser(prog_name)
        parser.add_argument(
            '--scrape',
            action='append',
            default=['collectd/9103'],
            help=_("Service/Port of scrape endpoint to check on nodes")
        )
        parser.add_argument(
            '--stack-name',
            default='overcloud',
            help=_("Overcloud stack name for which inventory file should "
                   "be generated")
        )
        parser.add_argument(
            '--inventory',
            help=_("Use this argument in case you have inventory file "
                   "generated or moved to non-standard place. Value has to be "
                   "path to inventory file including the file name.")
        )
        return parser

    def take_action(self, parsed_args):
        # discover undercloud and overcloud nodes
        try:
            rc, out, err = self._execute(
                'tripleo-ansible-inventory '
                '--static-yaml-inventory {} '
                '--stack {}'.format(INVENTORY, parsed_args.stack_name),
                parsed_args
            )
            if rc:
                raise InventoryError(err, out)

            # OSP versions with deprecated tripleo-ansible-inventory fallbacks
            # to static inventory file generated at one of the fallback path
            if not os.path.exists(INVENTORY):
                if parsed_args.inventory:
                    INV_FALLBACKS.insert(0, parsed_args.inventory)
                for i in INV_FALLBACKS:
                    absi = i.format(stack=parsed_args.stack_name)
                    absi = os.path.abspath(os.path.expanduser(absi))
                    if os.path.exists(absi):
                        shutil.copyfile(absi, INVENTORY)
                        break
                else:
                    raise InventoryError('None of the fallback inventory files'
                                         ' exists: %s' % INV_FALLBACKS, '')
        except InventoryError as ex:
            print(str(ex))
            sys.exit(1)

        # discover scrape endpoints
        endpoints = dict()
        hosts = runner.parse_inventory_hosts(INVENTORY)
        for scrape in parsed_args.scrape:
            service, port = scrape.split('/')
            for host in hosts:
                if parsed_args.dev:
                    name = host["hostname"] if host["hostname"] else host["ip"]
                    print(f'Trying to fetch {service} metrics on host '
                          f'{name} at port {port}', end='')
                node = _curl(host, port, timeout=1)
                if node:
                    endpoints.setdefault(service.strip(), []).append(node)
                if parsed_args.dev:
                    print(' [success]' if node else ' [failure]')
        data = yaml.safe_dump(endpoints, default_flow_style=False)
        with open(ENDPOINTS, 'w') as f:
            f.write(data)
        print("Discovered following scraping endpoints:\n%s" % data)


class Setup(base.ObservabilityBaseCommand):
    """Install and configure given Observability component(s)"""

    auth_required = False

    def get_parser(self, prog_name):
        parser = super().get_parser(prog_name)
        parser.add_argument(
            'components',
            nargs='+',
            choices=[
                'prometheus_agent',
                # TODO: in future will contain option for all stack components
            ]
        )
        parser.add_argument(
            '--inventory',
            help=_("Use this argument in case you don't want to use for "
                   "whatever reason the inventory file generated by discovery "
                   "command")
        )
        return parser

    def take_action(self, parsed_args):
        inventory = INVENTORY
        if parsed_args.inventory:
            inventory = parsed_args.inventory
        for compnt in parsed_args.components:
            playbook = '%s.yml' % compnt
            try:
                self._run_playbook(playbook, inventory,
                                   parsed_args=parsed_args)
            except OSError as ex:
                print('Failed to load playbook file: %s' % ex)
                sys.exit(1)
            except yaml.YAMLError as ex:
                print('Failed to parse playbook configuration: %s' % ex)
                sys.exit(1)
            except runner.AnsibleRunnerFailed as ex:
                print('Ansible run %s (rc %d)' % (ex.status, ex.rc))
                if parsed_args.dev:
                    print(ex.stderr)