octavia 14.0.0.0rc1__py3-none-any.whl → 15.0.0__py3-none-any.whl

octavia/amphorae/backends/agent/api_server/loadbalancer.py

@@ -18,6 +18,7 @@ import re
 import shutil
 import stat
 import subprocess
+import time
 
 import flask
 import jinja2
@@ -35,11 +36,11 @@ from octavia.common import utils as octavia_utils
 
 LOG = logging.getLogger(__name__)
 BUFFER = 100
+HAPROXY_RELOAD_RETRIES = 3
+HAPROXY_QUERY_RETRIES = 5
 
 CONF = cfg.CONF
 
-UPSTART_CONF = 'upstart.conf.j2'
-SYSVINIT_CONF = 'sysvinit.conf.j2'
 SYSTEMD_CONF = 'systemd.conf.j2'
 
 JINJA_ENV = jinja2.Environment(
@@ -47,13 +48,11 @@ JINJA_ENV = jinja2.Environment(
     loader=jinja2.FileSystemLoader(os.path.dirname(
         os.path.realpath(__file__)
     ) + consts.AGENT_API_TEMPLATES))
-UPSTART_TEMPLATE = JINJA_ENV.get_template(UPSTART_CONF)
-SYSVINIT_TEMPLATE = JINJA_ENV.get_template(SYSVINIT_CONF)
 SYSTEMD_TEMPLATE = JINJA_ENV.get_template(SYSTEMD_CONF)
 
 
 # Wrap a stream so we can compute the md5 while reading
-class Wrapped(object):
+class Wrapped:
     def __init__(self, stream_):
         self.stream = stream_
         self.hash = md5(usedforsecurity=False)  # nosec
@@ -71,7 +70,7 @@ class Wrapped(object):
         return getattr(self.stream, attr)
 
 
-class Loadbalancer(object):
+class Loadbalancer:
 
     def get_haproxy_config(self, lb_id):
         """Gets the haproxy config
@@ -79,7 +78,7 @@ class Loadbalancer(object):
         :param listener_id: the id of the listener
         """
         self._check_lb_exists(lb_id)
-        with open(util.config_path(lb_id), 'r', encoding='utf-8') as file:
+        with open(util.config_path(lb_id), encoding='utf-8') as file:
             cfg = file.read()
             resp = webob.Response(cfg, content_type='text/plain')
             resp.headers['ETag'] = (
@@ -126,12 +125,12 @@ class Loadbalancer(object):
             file.write(new_config)
 
         # use haproxy to check the config
-        cmd = "haproxy -c -L {peer} -f {config_file} -f {haproxy_ug}".format(
-            config_file=name, peer=peer_name,
-            haproxy_ug=consts.HAPROXY_USER_GROUP_CFG)
+        cmd = (f"haproxy -c -L {peer_name} -f {name} -f "
+               f"{consts.HAPROXY_USER_GROUP_CFG}")
 
         try:
-            subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT)
+            subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT,
+                                    encoding='utf-8')
         except subprocess.CalledProcessError as e:
             LOG.error("Failed to verify haproxy file: %s %s", e, e.output)
             # Save the last config that failed validation for debugging
@@ -143,43 +142,16 @@ class Loadbalancer(object):
         # file ok - move it
         os.rename(name, util.config_path(lb_id))
 
-        try:
-
-            init_system = util.get_os_init_system()
-
-            LOG.debug('Found init system: %s', init_system)
-
-            init_path = util.init_path(lb_id, init_system)
+        init_path = util.init_path(lb_id)
 
-            if init_system == consts.INIT_SYSTEMD:
-                template = SYSTEMD_TEMPLATE
-                # Render and install the network namespace systemd service
-                util.install_netns_systemd_service()
-                util.run_systemctl_command(
-                    consts.ENABLE, consts.AMP_NETNS_SVC_PREFIX + '.service')
-            elif init_system == consts.INIT_UPSTART:
-                template = UPSTART_TEMPLATE
-            elif init_system == consts.INIT_SYSVINIT:
-                template = SYSVINIT_TEMPLATE
-                init_enable_cmd = "insserv {file}".format(file=init_path)
-            else:
-                raise util.UnknownInitError()
+        template = SYSTEMD_TEMPLATE
+        # Render and install the network namespace systemd service
+        util.install_netns_systemd_service()
+        util.run_systemctl_command(
+            consts.ENABLE, consts.AMP_NETNS_SVC_PREFIX + '.service', False)
 
-        except util.UnknownInitError:
-            LOG.error("Unknown init system found.")
-            return webob.Response(json={
-                'message': "Unknown init system in amphora",
-                'details': "The amphora image is running an unknown init "
-                           "system.  We can't create the init configuration "
-                           "file for the load balancing process."}, status=500)
-
-        if init_system == consts.INIT_SYSTEMD:
-            # mode 00644
-            mode = stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IROTH
-        else:
-            # mode 00755
-            mode = (stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP |
-                    stat.S_IROTH | stat.S_IXOTH)
+        # mode 00644
+        mode = stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IROTH
 
         hap_major, hap_minor = haproxy_compatibility.get_haproxy_versions()
         if not os.path.exists(init_path):
@@ -193,9 +165,6 @@ class Loadbalancer(object):
                     haproxy_state_file=util.state_file_path(lb_id),
                     haproxy_socket=util.haproxy_sock_path(lb_id),
                     haproxy_user_group_cfg=consts.HAPROXY_USER_GROUP_CFG,
-                    respawn_count=util.CONF.haproxy_amphora.respawn_count,
-                    respawn_interval=(util.CONF.haproxy_amphora.
-                                      respawn_interval),
                     amphora_netns=consts.AMP_NETNS_SVC_PREFIX,
                     amphora_nsname=consts.AMPHORA_NAMESPACE,
                     haproxy_major_version=hap_major,
@@ -204,26 +173,36 @@ class Loadbalancer(object):
                 text_file.write(text)
 
         # Make sure the new service is enabled on boot
-        if init_system == consts.INIT_SYSTEMD:
+        try:
             util.run_systemctl_command(
-                consts.ENABLE, "haproxy-{lb_id}".format(lb_id=lb_id))
-        elif init_system == consts.INIT_SYSVINIT:
-            try:
-                subprocess.check_output(init_enable_cmd.split(),
-                                        stderr=subprocess.STDOUT)
-            except subprocess.CalledProcessError as e:
-                LOG.error("Failed to enable haproxy-%(lb_id)s service: "
-                          "%(err)s %(out)s", {'lb_id': lb_id, 'err': e,
-                                              'out': e.output})
-                return webob.Response(json={
-                    'message': "Error enabling haproxy-{0} service".format(
-                        lb_id), 'details': e.output}, status=500)
+                consts.ENABLE, consts.LOADBALANCER_SYSTEMD % lb_id)
+        except subprocess.CalledProcessError as e:
+            return webob.Response(json={
+                'message': "Error enabling octavia-keepalived service",
+                'details': e.output}, status=500)
 
         res = webob.Response(json={'message': 'OK'}, status=202)
         res.headers['ETag'] = stream.get_md5()
 
         return res
 
+    def _check_haproxy_uptime(self, lb_id):
+        stat_sock_file = util.haproxy_sock_path(lb_id)
+        lb_query = haproxy_query.HAProxyQuery(stat_sock_file)
+        retries = HAPROXY_QUERY_RETRIES
+        for idx in range(retries):
+            try:
+                info = lb_query.show_info()
+                uptime_sec = info['Uptime_sec']
+            except Exception as e:
+                LOG.warning('Failed to get haproxy info: %s, retrying.', e)
+                time.sleep(1)
+                continue
+            uptime = int(uptime_sec)
+            return uptime
+        LOG.error('Failed to get haproxy uptime after %d tries.', retries)
+        return None
+
     def start_stop_lb(self, lb_id, action):
         action = action.lower()
         if action not in [consts.AMP_ACTION_START,
@@ -231,7 +210,7 @@ class Loadbalancer(object):
                           consts.AMP_ACTION_RELOAD]:
             return webob.Response(json={
                 'message': 'Invalid Request',
-                'details': "Unknown action: {0}".format(action)}, status=400)
+                'details': f"Unknown action: {action}"}, status=400)
 
         self._check_lb_exists(lb_id)
         is_vrrp = (CONF.controller_worker.loadbalancer_topology ==
@@ -257,20 +236,45 @@ class Loadbalancer(object):
                     # failure!
                     LOG.warning('Failed to save haproxy-%s state!', lb_id)
 
-        cmd = ("/usr/sbin/service haproxy-{lb_id} {action}".format(
-            lb_id=lb_id, action=action))
-
-        try:
-            subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT)
-        except subprocess.CalledProcessError as e:
-            if b'Job is already running' not in e.output:
-                LOG.debug(
-                    "Failed to %(action)s haproxy-%(lb_id)s service: %(err)s "
-                    "%(out)s", {'action': action, 'lb_id': lb_id,
-                                'err': e, 'out': e.output})
-                return webob.Response(json={
-                    'message': "Error {0}ing haproxy".format(action),
-                    'details': e.output}, status=500)
+        retries = (HAPROXY_RELOAD_RETRIES
+                   if action == consts.AMP_ACTION_RELOAD
+                   else 1)
+        saved_exc = None
+        for idx in range(retries):
+            try:
+                util.run_systemctl_command(
+                    action, consts.LOADBALANCER_SYSTEMD % lb_id)
+            except subprocess.CalledProcessError as e:
+                # Mitigation for
+                # https://bugs.launchpad.net/octavia/+bug/2054666
+                if ('is not active, cannot reload.' in e.output and
+                        action == consts.AMP_ACTION_RELOAD):
+
+                    saved_exc = e
+
+                    # Wait a few seconds and check that haproxy was restarted
+                    uptime = self._check_haproxy_uptime(lb_id)
+                    # If haproxy is not reachable or was restarted more than 15
+                    # sec ago, let's retry (or maybe restart?)
+                    if not uptime or uptime > 15:
+                        continue
+                    # haproxy probably crashed and was restarted, log it and
+                    # continue
+                    LOG.warning("An error occured with haproxy while it "
+                                "was reloaded, check the haproxy logs for "
+                                "more details.")
+                    break
+                if 'Job is already running' not in e.output:
+                    return webob.Response(json={
+                        'message': f"Error {action}ing haproxy",
+                        'details': e.output
+                    }, status=500)
+            break
+        else:
+            # no break, we reach the retry limit for reloads
+            return webob.Response(json={
+                'message': f"Error {action}ing haproxy",
+                'details': saved_exc.output}, status=500)
 
         # If we are not in active/standby we need to send an IP
         # advertisement (GARP or NA). Keepalived handles this for
@@ -283,12 +287,10 @@ class Loadbalancer(object):
                       consts.AMP_ACTION_RELOAD]:
             return webob.Response(json={
                 'message': 'OK',
-                'details': 'Listener {lb_id} {action}ed'.format(
-                    lb_id=lb_id, action=action)}, status=202)
+                'details': f'Listener {lb_id} {action}ed'}, status=202)
 
         details = (
-            'Configuration file is valid\n'
-            'haproxy daemon for {0} started'.format(lb_id)
+            f'Configuration file is valid\nhaproxy daemon for {lb_id} started'
         )
 
         return webob.Response(json={'message': 'OK', 'details': details},
@@ -303,9 +305,9 @@ class Loadbalancer(object):
         # check if that haproxy is still running and if stop it
         if os.path.exists(util.pid_path(lb_id)) and os.path.exists(
                 os.path.join('/proc', util.get_haproxy_pid(lb_id))):
-            cmd = "/usr/sbin/service haproxy-{0} stop".format(lb_id)
             try:
-                subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT)
+                util.run_systemctl_command(
+                    consts.STOP, consts.LOADBALANCER_SYSTEMD % lb_id)
             except subprocess.CalledProcessError as e:
                 LOG.error("Failed to stop haproxy-%s service: %s %s",
                           lb_id, e, e.output)
@@ -334,29 +336,10 @@ class Loadbalancer(object):
             pass
 
         # disable the service
-        init_system = util.get_os_init_system()
-        init_path = util.init_path(lb_id, init_system)
+        init_path = util.init_path(lb_id)
 
-        if init_system == consts.INIT_SYSTEMD:
-            util.run_systemctl_command(
-                consts.DISABLE, "haproxy-{lb_id}".format(
-                    lb_id=lb_id))
-        elif init_system == consts.INIT_SYSVINIT:
-            init_disable_cmd = "insserv -r {file}".format(file=init_path)
-        elif init_system != consts.INIT_UPSTART:
-            raise util.UnknownInitError()
-
-        if init_system == consts.INIT_SYSVINIT:
-            try:
-                subprocess.check_output(init_disable_cmd.split(),
-                                        stderr=subprocess.STDOUT)
-            except subprocess.CalledProcessError as e:
-                LOG.error("Failed to disable haproxy-%(lb_id)s service: "
-                          "%(err)s %(out)s", {'lb_id': lb_id, 'err': e,
-                                              'out': e.output})
-                return webob.Response(json={
-                    'message': "Error disabling haproxy-{0} service".format(
-                        lb_id), 'details': e.output}, status=500)
+        util.run_systemctl_command(
+            consts.DISABLE, consts.LOADBALANCER_SYSTEMD % lb_id, False)
 
         # delete the directory + init script for that listener
         shutil.rmtree(util.haproxy_dir(lb_id))
@@ -420,10 +403,10 @@ class Loadbalancer(object):
         if not path_exists:
             return webob.Response(json={
                 'message': 'Certificate Not Found',
-                'details': "No certificate with filename: {f}".format(
-                    f=filename)}, status=404)
+                'details': f"No certificate with filename: {filename}"},
+                status=404)
 
-        with open(cert_path, 'r', encoding='utf-8') as crt_file:
+        with open(cert_path, encoding='utf-8') as crt_file:
             cert = crt_file.read()
             md5sum = md5(octavia_utils.b(cert),
                          usedforsecurity=False).hexdigest()  # nosec
@@ -442,8 +425,7 @@ class Loadbalancer(object):
             if os.path.exists(
                     os.path.join('/proc', util.get_haproxy_pid(lb_id))):
                 # Check if the listener is disabled
-                with open(util.config_path(lb_id),
-                          'r', encoding='utf-8') as file:
+                with open(util.config_path(lb_id), encoding='utf-8') as file:
                     cfg = file.read()
                     m = re.findall('^frontend (.*)$', cfg, re.MULTILINE)
                     return m or []
@@ -458,8 +440,8 @@ class Loadbalancer(object):
             raise exceptions.HTTPException(
                 response=webob.Response(json={
                     'message': 'Loadbalancer Not Found',
-                    'details': "No loadbalancer with UUID: {0}".format(
-                        lb_id)}, status=404))
+                    'details': f"No loadbalancer with UUID: {lb_id}"},
+                    status=404))
 
     def _check_ssl_filename_format(self, filename):
         # check if the format is (xxx.)*xxx.pem

octavia/amphorae/backends/agent/api_server/lvs_listener_base.py

@@ -20,7 +20,7 @@ from oslo_config import cfg
 CONF = cfg.CONF
 
 
-class LvsListenerApiServerBase(object, metaclass=abc.ABCMeta):
+class LvsListenerApiServerBase(metaclass=abc.ABCMeta):
     """Base LVS Listener Server API
 
     """

octavia/amphorae/backends/agent/api_server/osutils.py

@@ -29,7 +29,7 @@ CONF = cfg.CONF
 LOG = logging.getLogger(__name__)
 
 
-class BaseOS(object):
+class BaseOS:
 
     def __init__(self, os_name):
         self.os_name = os_name
@@ -75,11 +75,13 @@ class BaseOS(object):
             is_sriov=is_sriov)
         vip_interface.write()
 
-    def write_port_interface_file(self, interface, fixed_ips, mtu):
+    def write_port_interface_file(self, interface, fixed_ips, mtu,
+                                  is_sriov=False):
         port_interface = interface_file.PortInterfaceFile(
             name=interface,
             mtu=mtu,
-            fixed_ips=fixed_ips)
+            fixed_ips=fixed_ips,
+            is_sriov=is_sriov)
         port_interface.write()
 
     @classmethod
@@ -89,15 +91,16 @@ class BaseOS(object):
         LOG.debug("Executing: %s", cmd)
         try:
             out = subprocess.check_output(cmd.split(),
-                                          stderr=subprocess.STDOUT)
-            for line in out.decode('utf-8').split('\n'):
+                                          stderr=subprocess.STDOUT,
+                                          encoding='utf-8')
+            for line in out.split('\n'):
                 LOG.debug(line)
         except subprocess.CalledProcessError as e:
             LOG.error('Failed to set up %s due to error: %s %s', interface,
                       e, e.output)
             raise exceptions.HTTPException(
                 response=webob.Response(json={
-                    'message': 'Error plugging {0}'.format(name),
+                    'message': f'Error plugging {name}',
                     'details': e.output}, status=500))
 
 
@@ -109,7 +112,7 @@ class Ubuntu(BaseOS):
 
     def cmd_get_version_of_installed_package(self, package_name):
         name = self._map_package_name(package_name)
-        return "dpkg-query -W -f=${{Version}} {name}".format(name=name)
+        return f"dpkg-query -W -f=${{Version}} {name}"
 
 
 class RH(BaseOS):
@@ -120,7 +123,7 @@ class RH(BaseOS):
 
     def cmd_get_version_of_installed_package(self, package_name):
         name = self._map_package_name(package_name)
-        return "rpm -q --queryformat %{{VERSION}} {name}".format(name=name)
+        return f"rpm -q --queryformat %{{VERSION}} {name}"
 
 
 class CentOS(RH):

octavia/amphorae/backends/agent/api_server/plug.py

@@ -34,7 +34,7 @@ CONF = cfg.CONF
 LOG = logging.getLogger(__name__)
 
 
-class Plug(object):
+class Plug:
     def __init__(self, osutils):
         self._osutils = osutils
 
@@ -89,7 +89,7 @@ class Plug(object):
         try:
             rendered_vips = self.render_vips(vips)
         except ValueError as e:
-            vip_error_message = "Invalid VIP: {}".format(e)
+            vip_error_message = f"Invalid VIP: {e}"
             return webob.Response(json={'message': vip_error_message},
                                   status=400)
 
@@ -98,7 +98,7 @@ class Plug(object):
                                              gateway, host_routes)
         except ValueError as e:
             return webob.Response(
-                json={'message': "Invalid VRRP Address: {}".format(e)},
+                json={'message': f"Invalid VRRP Address: {e}"},
                 status=400)
 
         # Check if the interface is already in the network namespace
@@ -148,14 +148,14 @@ class Plug(object):
             for ip in fixed_ips:
                 try:
                     socket.inet_pton(socket.AF_INET, ip.get('ip_address'))
-                except socket.error:
+                except OSError:
                     socket.inet_pton(socket.AF_INET6, ip.get('ip_address'))
 
     def plug_network(self, mac_address, fixed_ips, mtu=None,
-                     vip_net_info=None):
+                     vip_net_info=None, is_sriov=False):
         try:
             self._check_ip_addresses(fixed_ips=fixed_ips)
-        except socket.error:
+        except OSError:
             return webob.Response(json={
                 'message': "Invalid network port"}, status=400)
 
@@ -189,7 +189,8 @@ class Plug(object):
                     vips=rendered_vips,
                     mtu=mtu,
                     vrrp_info=vrrp_info,
-                    fixed_ips=fixed_ips)
+                    fixed_ips=fixed_ips,
+                    is_sriov=is_sriov)
                 self._osutils.bring_interface_up(existing_interface, 'vip')
             # Otherwise, we are just plugging a run-of-the-mill network
             else:
@@ -197,7 +198,7 @@ class Plug(object):
                 self._osutils.write_port_interface_file(
                     interface=existing_interface,
                     fixed_ips=fixed_ips,
-                    mtu=mtu)
+                    mtu=mtu, is_sriov=is_sriov)
                 self._osutils.bring_interface_up(existing_interface, 'network')
 
             util.send_member_advertisements(fixed_ips)
@@ -222,7 +223,7 @@ class Plug(object):
         self._osutils.write_port_interface_file(
             interface=netns_interface,
             fixed_ips=fixed_ips,
-            mtu=mtu)
+            mtu=mtu, is_sriov=is_sriov)
 
         # Update the list of interfaces to add to the namespace
         self._update_plugged_interfaces_file(netns_interface, mac_address)
@@ -239,8 +240,7 @@ class Plug(object):
 
         return webob.Response(json={
             'message': "OK",
-            'details': "Plugged on interface {interface}".format(
-                interface=netns_interface)}, status=202)
+            'details': f"Plugged on interface {netns_interface}"}, status=202)
 
     def _interface_by_mac(self, mac):
         try:
@@ -277,8 +277,7 @@ class Plug(object):
         with os.fdopen(os.open(plug_inf_file, flags, mode), 'r+') as text_file:
             inf_list = [inf.split()[0].rstrip() for inf in text_file]
             if mac_address not in inf_list:
-                text_file.write("{mac_address} {interface}\n".format(
-                    mac_address=mac_address, interface=interface))
+                text_file.write(f"{mac_address} {interface}\n")
 
     def _netns_interface_by_mac(self, mac_address):
         with pyroute2.NetNS(consts.AMPHORA_NAMESPACE,

octavia/amphorae/backends/agent/api_server/server.py

@@ -55,7 +55,7 @@ def register_app_error_handler(app):
         app.register_error_handler(code, make_json_error)
 
 
-class Server(object):
+class Server:
     def __init__(self):
         self.app = flask.Flask(__name__)
         self._osutils = osutils.BaseOS.get_os_util()
@@ -223,7 +223,8 @@ class Server(object):
         return self._plug.plug_network(port_info['mac_address'],
                                        port_info.get('fixed_ips'),
                                        port_info.get('mtu'),
-                                       port_info.get('vip_net_info'))
+                                       port_info.get('vip_net_info'),
+                                       port_info.get('is_sriov'))
 
     def upload_cert(self):
         return certificate_update.upload_server_cert()
@@ -278,7 +279,7 @@ class Server(object):
             raise exceptions.BadRequest(
                 description='Invalid rules information') from e
 
-        nftable_utils.write_nftable_vip_rules_file(interface, rules_info)
+        nftable_utils.write_nftable_rules_file(interface, rules_info)
 
         nftable_utils.load_nftables_file()
 

octavia/amphorae/backends/agent/api_server/templates/keepalived_lvs_check_script.sh.j2

@@ -11,11 +11,7 @@ do
       pid) echo "Check keepalived pid file: " $file;;
       *) continue;;
   esac
-  {% if init_system == consts.INIT_SYSTEMD %}
   systemctl status $(basename $file .pid) > /dev/null
-  {% elif init_system in (consts.INIT_UPSTART, consts.INIT_SYSVINIT) %}
-  kill -0 `cat $file`
-  {% endif %}
   status=$(( $status + $? ))
 done
 exit $status