Provided by: ubuntu-fan_0.9.0_all bug

NAME

       fanatic - fan bridge configuration and test wizard

SYNOPSIS

       fanatic [<cmd> [<arg> ...]]
       fanatic configure
       fanatic deconfigure
       fanatic test

DESCRIPTION

       fanatic is a configuration and test wizard for the Fan.  It is designed
       to simplify the process of configuring persistant Fan bridges.  It will
       also configure both LXD and Docker to use those bridges as required.

       A  network  Fan  is a mechanism for expanding the range of IP addresses
       available to a system.  It is most useful for containers such as Docker
       and  LXC/LXD,  but  it  can  be  used  in other contexts as well.  (See
       fanctl(8) for more details of Fan bridges and their use.)

COMMAND SYNTAX

       Running fanatic with no arguments  is  equivalent  to  running  fanatic
       configure.

       fanatic [configure]
              Interactivly  configure  the  local system for Fan.  This action
              will identify the interface to be used and offer to configure an
              appropriate  Fan  over the addresses on that interface.  It will
              further offer  to  configure  LXD  and/or  Docker  to  use  this
              interface.   Finally  it  will offer to test the configration as
              applied both locally and with an optional remote host.

       fanatic deconfigure
              Reverses  the  interactive   configuration   above.    It   will
              deconfigure  both  LXD  and  Docker  (if  configured)  and  then
              deconfigure the Fan.  These steps  are  only  performed  if  the
              configuration was generated by fanatic.

       fanatic test
              Runs  the  testing  phase of the interactive setup.  This action
              enables retesting of a previously configured system.  Only those
              pieces configured will be tested.

       See  ADVANCED  USAGE  for  details  of  how  to  run  sub-phases of the
       configure, deconfigure, or test phases of fanatic.

ADVANCED USAGE

       It is possible to run any sub-phase of the  configure,  deconfigure  or
       test  phases implemented by fanatic individually to redo or undo any of
       those sub-phases:

       fanatic enable-fan -u <underlay> -o <overlay>
              Configure a Fan over the specified interface.

       fanatic disable-fan -u <underlay> -o <overlay>
              Deconfigure a Fan over the specified interface.

       fanatic enable-lxd -u <underlay> -o <overlay>
              Configure LXD for use on the Fan over the specified interface.

       fanatic disable-lxd -u <underlay> -o <overlay>
              Deconfigure LXD for use on the Fan over the specified interface.

       fanatic enable-docker -u <underlay> -o <overlay>
              Configure  docker  for  use  on  the  Fan  over  the   specified
              interface.

       fanatic disable-docker -u <underlay> -o <overlay>
              Deconfigure  docker  for  use  on  the  Fan  over  the specified
              interface.

       test-host -u <underlay> -o <overlay> -r <remote host IP>
              Test host-to-host Fan functionality.  This requires  you  to  be
              running the same test script on both hosts in the test.

       test-local-lxd -u <underlay> -o <overlay>
              Test  the  local  LXD  configuration by creating a container and
              running host-to-host testing against that container.

       test-local-docker -u <underlay> -o <overlay>
              Test the local Docker configuration by creating a container  and
              running host-to-host testing against that container.

LIMITATIONS

       Because of the way in which Docker allocates addresses internally it is
       not possible to safely mix LXD and Docker containers on the same  slice
       of  the  Fan.   It  is  possible  to mix them safely on the same Fan on
       different slices or different hosts.

SEE ALSO

       fanctl(8) /usr/share/doc/ubuntu-fan/README
       http://www.ubuntu.com/fan

AUTHOR

       Andy Whitcroft <apw@canonical.com>

                                January 7, 2015                     FANATIC(8)