code.grnet.gr Git - snf-network/blob - README.md

   1 snf-network
   2 ===========
   3
   4 Overview
   5 --------
   6
   7 This is snf-network, a set of scripts that handle the network configuration of
   8 an instance inside a [Ganeti](http://code.google.com/p/ganeti) cluster.
   9 It takes advantage of the variables that Ganeti exports to their execution
  10 environment and issues all the necessary commands to ensure network
  11 connectivity to the instance, based on the requested setup.
  12
  13 This package provides the following scripts:
  14
  15 * mac2eui64: Script for obtaining an EUI-64 address based on its 48-bit
  16   MAC address and an IPv6 prefix
  17 * kvm-ifup-custom: Script invoked when an interface goes up (KVM version)
  18 * kvm-ifdown-custom: Script invoked when an interface goes down (KVM version)
  19 * vif-custom: Script invoked when an interface goes up (Xen version)
  20 * snf-network-hook: The part of snf-network's functionality which is
  21   implemented as a Ganeti hook
  22 * snf-network-log: Simple script for logging actions from inside Ganeti
  23   scripts/hooks
  24 * snf-network-dnshook: Ganeti hook for updating dynamic DNS entries
  25 * ifup-extra: Example script for extra, deployment-specific functionality
  26 * common.sh: Common library, sourced by all above scripts.
  27 * runlocked: Helper script which serializes the execution of commands
  28   on a host machine
  29
  30 Project Page
  31 ------------
  32
  33 Please see the [official Synnefo site](http://www.synnefo.org) and the
  34 [latest snf-network docs](http://www.synnefo.org/docs/snf-network/latest/index.html)
  35 for more information.
  36
  37
  38 Copyright and license
  39 =====================
  40
  41 Copyright 2012-2014 GRNET S.A. All rights reserved.
  42
  43 Redistribution and use in source and binary forms, with or
  44 without modification, are permitted provided that the following
  45 conditions are met:
  46
  47   1. Redistributions of source code must retain the above
  48      copyright notice, this list of conditions and the following
  49      disclaimer.
  50
  51   2. Redistributions in binary form must reproduce the above
  52      copyright notice, this list of conditions and the following
  53      disclaimer in the documentation and/or other materials
  54      provided with the distribution.
  55
  56 THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  57 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  58 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  59 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  60 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  61 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  62 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  63 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  64 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  65 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  66 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  67 POSSIBILITY OF SUCH DAMAGE.
  68
  69 The views and conclusions contained in the software and
  70 documentation are those of the authors and should not be
  71 interpreted as representing official policies, either expressed
  72 or implied, of GRNET S.A.