#network

####Table of Contents

1. Overview
2. Module Description
3. Setup
   • Resources managed by network module
   • Setup requirements
   • Beginning with module network
4. Usage
5. Operating Systems Support
6. Development

##Overview

This module configures network interfaces and parameters.

##Module Description

The module is based on stdmod naming standards version 0.9.0.

Refer to https://github.com/stdmod/ for complete documentation on the common parameters.

##Setup

###Resources managed by network module

• This module enables the network service
• Can manage any configuration file in the config_dir_path with network::conf
• Can manage interfaces with network::interfaces

###Setup Requirements

• PuppetLabs stdlib module
• PuppetLabs concat module
• StdMod stdmod module
• Puppet version >= 2.7.x
• Facter version >= 1.6.2

###Beginning with module network

The main class arguments can be provided either via Hiera (from Puppet 3.x) or direct parameters:

    class { 'network':
      parameter => value,
    }

The module provides a generic network::conf define to manage any file in the config_dir_path which is:

On 'Debian' osfamily: '/etc/network',

On 'Redhat' osfamily: '/etc/sysconfig/network-scripts',

On 'Suse' osfamily: '/etc/sysconfig/network',

    network::conf { 'if-up.d/my_script':
      template => 'site/network/my_script',
    }

The module provides as cross OS complaint define to manage single interfaces: network::interface

IMPORTANT NOTICE: On Debian if you use network::interface once you must provide ALL the network::interface defines for all your interfaces

To configure a dhcp interface

    network::interface { 'eth0':
      enable_dhcp => true,
    }

To configure a static interface with basic parameters

    network::interface { 'eth1':
      ipaddress => '10.42.42.50',
      netmask   => '255.255.255.0',
    }

##Usage

You have different possibile approaches in the usage of this module. Use the one you prefer.

• Just use the network::interface defines:

    network::interface { 'eth0':
      enable_dhcp => true,
    }
  
    network::interface { 'eth1':
      ipaddress => '10.42.42.50',
      netmask   => '255.255.255.0',
    }
  

• Use the main network class and the interfaces_hash to configure all the interfaces (ideal with Hiera, here the parameter is explicitely passed):

    class { 'network':
      interfaces_hash => {
        'eth0' => {
          enable_dhcp => true,
        },
        'eth1' => {
          ipaddress => '10.42.42.50',
          netmask   => '255.255.255.0',
        },
      },
    }
  

• Use the main network class and the usual stdmod parameters to manage the (main) network configuration file

  On 'Debian' osfamily: '/etc/network/interfaces',

  On 'Redhat' osfamily: '/etc/sysconfig/network-scripts/ifcfg.eth0' # Yes, quite opinionated, you can change it with config_file_path.

  On 'Suse' osfamily: '/etc/sysconfig/network/ifcfg-eth0'

    class { 'network':
      config_file_template => 'site/network/network.conf.erb',
    }
  

• Manage the whole configuration directory

    class { 'network':
      config_dir_source  => 'puppet:///modules/site/network/conf/',
    }
  

• DO NOT automatically restart the network service after configuration changes (either via the main network class or via network::interfaces)

    class { 'network':
      config_file_notify => '',
    }
  

• The network::interface exposes, and uses in the default templates, network configuration parameters available on Debian (most), RedHat (some), Suse (most) so it's flexible, easily expandable and should adapt to any need, but you may still want to provide a custom template with:

    network::interface { 'eth0':
      enable_dhcp => true,
      template    => "site/network/interface/${::osfamily}.erb",
    }
  

• The network::route can be used to define static routes on Debian and RedHat systems. The following example manage a static route on eth0

    network::route { 'eth0':
      ipaddress => [ '192.168.17.0', ],
      netmask   => [ '255.255.255.0', ],
      gateway   => [ '192.168.17.250', ],
    }
  

  On 'Debian' osfamily: it will create 2 files: '/etc/network/if-up.d/z90-route-eth0' and '/etc/network/if-down.d/z90-route-eth0',

  On 'RedHat' osfamily: it will create the file '/etc/sysconfig/network-scripts/route-eth0'

  You can provide to the main network class the routes_hash parameter to manage all your routes via an hash.

• This example add 2 static routes on the interface bond2

    network::route { 'bond2':
      ipaddress => [ '192.168.2.0', '10.0.0.0', ],
      netmask   => [ '255.255.255.0', '255.0.0.0', ],
      gateway   => [ '192.168.1.1', '10.0.0.1', ],
    }
  

• To configure network routes on Suse, use the routes_hash parameter, like in the following example:

    class { 'network':
      routes_hash => {
        'default' => {
          destination => 'default',
          gateway     => '192.168.0.1',
          netmask     => '255.255.255.0',
          interface   => 'eth0',
          type        => 'unicast',
        }
      }
    }
  

The parameters netmask, interface and type are optional.

##Operating Systems Support

This is tested on these OS:

• RedHat osfamily 5 and 6
• Debian 6 and 7
• Ubuntu 10.04, 12.04 and 14.04
• OpenSuse 12, SLES 11SP3

##Development

Pull requests (PR) and bug reports via GitHub are welcomed.

When submitting PR please follow these quidelines:

• Provide puppet-lint compliant code
• If possible provide rspec tests
• Follow the module style and stdmod naming standards

When submitting bug report please include or link:

• The Puppet code that triggers the error
• The output of facter on the system where you try it
• All the relevant error logs
• Any other information useful to undestand the context