CLEANUP: remove bridge support in slapos node format

The bridge was never used anymore. For KVM software release, we are using tap with their own routes (packets are routes directly through the tap device).

CHANGES.txt

 Changes
 =======
 
+1.4.12 (???)
+------------
+
+ * totally deprecate no_bridge and bridge_name options (there was a warning for a long time)
+ * create_tap = True won't create tap attached to bridge anymore
+    -> it should always be used with option tap_gateway_interface
+    -> if option tap_gateway_interface is not present, the tap will have a default gateway (10.0.0.1)
+
 1.4.11 (2018-09-28)
 -------------------
 

slapos/README.format.txt

@@ -6,7 +6,6 @@ slapformat is an application to prepare SlapOS-ready node to be used inside Slap
 It "formats" the machine by:
 
  - creating users and groups
- - creating bridge interface
  - creating needed tap interfaces
  - creating TUN interfaces
  - creating needed directories with proper ownership and permissions
@@ -31,11 +30,10 @@ This program shall be only run by root.
 Requirements
 ------------
 
-Linux with IPv6, bridging and tap interface support.
+Linux with IPv6 and tap interface support.
 
 Binaries:
 
- * brctl
  * groupadd
  * ip
  * useradd

slapos/format.py

@@ -289,7 +289,7 @@ class Computer(object):
   def __getinitargs__(self):
     return (self.reference, self.interface)
 
-  def getAddress(self, allow_tap=False):
+  def getAddress(self):
     """
     Return a list of the interface address not attributed to any partition (which
     are therefore free for the computer itself).
@@ -311,13 +311,6 @@ class Computer(object):
       if address_dict['addr'] not in computer_partition_address_list:
         return address_dict
 
-    if allow_tap:
-      # all addresses on interface are for partition, so let's add new one
-      computer_tap = Tap('compdummy')
-      computer_tap.createWithOwner(User('root'), attach_to_tap=True)
-      self.interface.addTap(computer_tap)
-      return self.interface.addAddr()
-
     # Can't find address
     raise NoAddressOnInterface('No valid IPv6 found on %s.' % self.interface.name)
 
@@ -606,17 +599,9 @@ class Computer(object):
           owner = User('root')
 
         if alter_network and create_tap:
-          # In case it has to be  attached to the TAP network device, only one
-          # is necessary for the interface to assert carrier
-          if self.interface.attach_to_tap and partition_index == 0:
-            partition.tap.createWithOwner(owner, attach_to_tap=True)
-          else:
           partition.tap.createWithOwner(owner)
-          # If tap_gateway_interface is specified, we don't add tap to bridge
-          # but we create route for this tap
-          if not self.tap_gateway_interface and self.interface.attach_to_tap:
-            self.interface.addTap(partition.tap)
-          else:
+
+          # add addresses and create route for this tap
           next_ipv4_addr = '%s' % tap_address_list.pop(0)
           if not partition.tap.ipv4_addr:
             # define new ipv4 address for this tap
@@ -677,12 +662,6 @@ class Computer(object):
             else:
               raise ValueError('Address %r is incorrect' % address['addr'])
     finally:
-      if alter_network and create_tap and self.interface.attach_to_tap:
-        try:
-          self.partition_list[0].tap.detach()
-        except IndexError:
-          pass
-
       for manager in self._manager_list:
         manager.formatTearDown(self)
 
@@ -700,7 +679,7 @@ class Partition(object):
       path: String, the path to the partition folder.
       user: User, the user linked to this partition.
       address_list: List of associated IP addresses.
-      tap: Tap, the tap interface linked to this partition e.g. used as a bridge for kvm
+      tap: Tap, the tap interface linked to this partition e.g. used as a gateway for kvm
       tun: Tun interface used for special apps simulating ethernet connections
       external_storage_list: Base path list of folder to format for data storage
     """
@@ -842,7 +821,7 @@ class Tap(object):
         tap_name: String, the name of the tap interface.
         ipv4_address: String, local ipv4 to route to this tap
         ipv4_network: String, netmask to use when configure route for this tap
-        gateway_ipv4: String, ipv4 of gateway to be used to reach local network
+        ipv4_gateway: String, ipv4 of gateway to be used to reach local network
     """
 
     self.name = str(tap_name)
@@ -859,59 +838,7 @@ class Tap(object):
   def __getinitargs__(self):
     return (self.name,)
 
-  def attach(self):
-    """
-    Attach to the TAP interface, meaning  that it just opens the TAP interface
-    and waits for the caller to notify that it can be safely detached.
-
-    Linux  distinguishes administrative  and operational  state of  an network
-    interface.  The  former can be set  manually by running ``ip  link set dev
-    <dev> up|down'', whereas the latter states that the interface can actually
-    transmit  data (for  a wired  network interface,  it basically  means that
-    there is  carrier, e.g.  the network  cable is plugged  into a  switch for
-    example).
-
-    In case of bridge:
-    In order  to be able to check  the uniqueness of IPv6  address assigned to
-    the bridge, the network interface  must be up from an administrative *and*
-    operational point of view.
-
-    However,  from  Linux  2.6.39,  the  bridge  reflects  the  state  of  the
-    underlying device (e.g.  the bridge asserts carrier if at least one of its
-    ports has carrier) whereas it  always asserted carrier before. This should
-    work fine for "real" network interface,  but will not work properly if the
-    bridge only binds TAP interfaces, which, from 2.6.36, reports carrier only
-    and only if an userspace program is attached.
-    """
-    tap_fd = os.open("/dev/net/tun", os.O_RDWR)
-
-    try:
-      # Attach to the TAP interface which has previously been created
-      fcntl.ioctl(tap_fd, self.TUNSETIFF,
-                  struct.pack("16sI", self.name, self.IFF_TAP))
-
-    except IOError as error:
-      # If  EBUSY, it  means another  program is  already attached,  thus just
-      # ignore it...
-      logger.warning("Cannot create interface " + self.name + ". Does it exist already?")
-      if error.errno != errno.EBUSY:
-        os.close(tap_fd)
-    else:
-      # Block until the  caller send an event stating that  the program can be
-      # now detached safely,  thus bringing down the TAP  device (from 2.6.36)
-      # and the bridge at the same time (from 2.6.39)
-      self.KEEP_TAP_ATTACHED_EVENT.wait()
-    finally:
-      os.close(tap_fd)
-
-  def detach(self):
-    """
-    Detach to the  TAP network interface by notifying  the thread which attach
-    to the TAP and closing the TAP file descriptor
-    """
-    self.KEEP_TAP_ATTACHED_EVENT.set()
-
-  def createWithOwner(self, owner, attach_to_tap=False):
+  def createWithOwner(self, owner):
     """
     Create a tap interface on the system if it doesn't exist yet.
     """
@@ -936,9 +863,6 @@ class Tap(object):
                  self.MODE, 'user', owner.name])
     callAndRead(['ip', 'link', 'set', self.name, 'up'])
 
-    if attach_to_tap:
-      threading.Thread(target=self.attach).start()
-
   def createRoutes(self):
     """
     Configure ipv4 route to reach this interface from local network
@@ -1020,11 +944,6 @@ class Interface(object):
     self.ipv4_local_network = ipv4_local_network
     self.ipv6_interface = ipv6_interface
 
-    # Attach to TAP  network interface, only if the  interface interface does not
-    # report carrier
-    _, result = callAndRead(['ip', 'addr', 'list', self.name], raise_on_error=False)
-    self.attach_to_tap = self.isBridge() and ('DOWN' in result.split('\n', 1)[0])
-
   # XXX no __getinitargs__, as instances of this class are never deserialized.
 
   def getIPv4LocalAddressList(self):
@@ -1082,49 +1001,6 @@ class Interface(object):
     # local addresses or anything which does not exists in RFC!
     return address_list
 
-  def isBridge(self):
-    try:
-      _, result = callAndRead(['brctl', 'show'])
-      return any(line.startswith(self.name) for line in result.split("\n"))
-    except Exception as e:
-      # the binary "brctl" itself does not exist - bridge is imposible to exist
-      logger.warning(str(e))
-      return False
-
-  def getInterfaceList(self):
-    """Returns list of interfaces already present on bridge"""
-    interface_list = []
-    _, result = callAndRead(['brctl', 'show'])
-    in_interface = False
-    for line in result.split('\n'):
-      if len(line.split()) > 1:
-        if self.name in line:
-          interface_list.append(line.split()[-1])
-          in_interface = True
-          continue
-        if in_interface:
-          break
-      elif in_interface:
-        if line.strip():
-          interface_list.append(line.strip())
-
-    return interface_list
-
-  def addTap(self, tap):
-    """
-    Add the tap interface tap to the bridge.
-
-    Args:
-      tap: Tap, the tap interface.
-    """
-    if tap.name not in self.getInterfaceList():
-      if self.isBridge():
-        callAndRead(['brctl', 'addif', self.name, tap.name])
-      else:
-        logger.warning("Interface slapos.cfg:interface_name={} is not a bridge. "
-                       "TUN/TAP interface {} might not have internet connection."
-                       "".format(self.name, tap.name))
-
   def _addSystemAddress(self, address, netmask, ipv6=True, tap=None):
     """Adds system address to interface
 
@@ -1456,7 +1332,7 @@ def do_format(conf):
 
   computer.instance_storage_home = conf.instance_storage_home
   conf.logger.info('Updating computer')
-  address = computer.getAddress(conf.create_tap)
+  address = computer.getAddress()
   computer.address = address['addr']
   computer.netmask = address['netmask']
 
@@ -1545,17 +1421,12 @@ class FormatConfig(object):
       if getattr(self, parameter, None) is None:
         setattr(self, parameter, None)
 
-    # Backward compatibility
-    if not getattr(self, "interface_name", None) \
-          and getattr(self, "bridge_name", None):
-      setattr(self, "interface_name", self.bridge_name)
-      self.logger.warning('bridge_name option is deprecated and should be '
-          'replaced by interface_name.')
-    if not getattr(self, "create_tap", None) \
-          and getattr(self, "no_bridge", None):
-      setattr(self, "create_tap", not self.no_bridge)
-      self.logger.warning('no_bridge option is deprecated and should be '
-          'replaced by create_tap.')
+    # deprecated options raise an error
+    for option in ['bridge_name', 'no_bridge']:
+      if getattr(self, option, None):
+        message = 'Option %r is totally deprecated, please update your config file' % (option)
+        self.logger.error(message)
+        raise UsageError(message)
 
     # Convert strings to booleans
     for option in ['alter_network', 'alter_user', 'create_tap', 'create_tun', 'use_unique_local_address_block']:
@@ -1578,10 +1449,6 @@ class FormatConfig(object):
       if self.create_tap or self.alter_network:
         self.checkRequiredBinary(['ip'])
 
-    # Required, even for dry run
-    if self.alter_network and self.create_tap:
-      self.checkRequiredBinary(['brctl'])
-
     # Check mandatory options
     for parameter in ('computer_id', 'instance_root', 'master_url',
                       'software_root', 'computer_xml'):
@@ -1630,9 +1497,6 @@ def tracing_monkeypatch(conf):
   os = OS(conf)
   if conf.dry_run:
     def dry_callAndRead(argument_list, raise_on_error=True):
-      if argument_list == ['brctl', 'show']:
-        return real_callAndRead(argument_list, raise_on_error)
-      else:
       return 0, ''
     callAndRead = dry_callAndRead
 

slapos/tests/slapformat.py

@@ -116,11 +116,6 @@ class FakeCallAndRead:
       retval = 0, 'OK'
     elif argument_list[:3] == ['route', 'add', '-host']:
       retval = 0, 'OK'
-    elif argument_list[:2] == ['brctl', 'show']:
-      retval = 0, "\n".join(("bridge name bridge id   STP enabled interfaces",
-                             "bridge bridge bridge b001   000:000 1 fakeinterface",
-                             "                                      fakeinterface2"
-                             ""))
     self.external_command_list.append(' '.join(argument_list))
     return retval
 
@@ -351,10 +346,7 @@ class TestComputer(SlapformatMixin):
       "makedirs('/software_root', 493)",
       "chmod('/software_root', 493)"],
       self.test_result.bucket)
-    self.assertEqual([
-        'ip addr list bridge',
-        'brctl show',
-      ],
+    self.assertEqual([],
       self.fakeCallAndRead.external_command_list)
 
   @unittest.skip("Not implemented")
@@ -391,10 +383,7 @@ class TestComputer(SlapformatMixin):
       "makedirs('/software_root', 493)",
       "chmod('/software_root', 493)"],
       self.test_result.bucket)
-    self.assertEqual([
-        'ip addr list bridge',
-        'brctl show',
-      ],
+    self.assertEqual([],
       self.fakeCallAndRead.external_command_list)
 
   @unittest.skip("Not implemented")
@@ -431,11 +420,8 @@ class TestComputer(SlapformatMixin):
       'useradd -d /software_root -g slapsoft slapsoft -r',
       'groupadd testuser',
       'useradd -d /instance_root/partition -g testuser -G slapsoft testuser -r',
-      'brctl show',
       'ip tuntap add dev tap mode tap user testuser',
       'ip link set tap up',
-      'brctl show',
-      'brctl addif bridge tap',
       'ip addr add ip/255.255.255.255 dev bridge',
       'ip addr list bridge',
       'ip addr add ip/ffff:ffff:ffff:ffff:: dev bridge',
@@ -476,13 +462,8 @@ class TestComputer(SlapformatMixin):
     ],
       self.test_result.bucket)
     self.assertEqual([
-        'ip addr list bridge',
-        'brctl show',
         'ip tuntap add dev tap mode tap user testuser',
         'ip link set tap up',
-        #'brctl show',
-        #'brctl show',
-        #'brctl addif bridge tap',
         'ip addr add ip/ffff:ffff:ffff:ffff:ffff:ffff:: dev tap',
         'ip -6 addr list tap',
         'ip route show 10.0.0.2',
@@ -533,8 +514,6 @@ class TestComputer(SlapformatMixin):
     ],
       self.test_result.bucket)
     self.assertEqual([
-        'ip addr list iface',
-        'brctl show',
         'ip tuntap add dev tap mode tap user testuser',
         'ip link set tap up',
         'ip addr add ip/ffff:ffff:ffff:ffff:ffff:ffff:: dev tap',
@@ -622,8 +601,6 @@ class TestComputer(SlapformatMixin):
       ],
       self.test_result.bucket)
     self.assertEqual([
-        'ip addr list bridge',
-        'brctl show',
         'ip addr add ip/255.255.255.255 dev bridge',
         # 'ip addr list bridge',
         'ip addr add ip/ffff:ffff:ffff:ffff:: dev bridge',
@@ -664,8 +641,6 @@ class TestComputer(SlapformatMixin):
       ],
       self.test_result.bucket)
     self.assertEqual([
-        'ip addr list myinterface',
-        'brctl show',
         'ip address add dev myinterface fd00::1/64',
         'ip addr add ip/255.255.255.255 dev myinterface',
         'ip addr add ip/ffff:ffff:ffff:ffff:: dev myinterface',