network-formula/README.rst

=========================
saltstack-network-formula
=========================

.. image:: https://api.flattr.com/button/flattr-badge-large.png
    :target: https://flattr.com/submit/auto?user_id=bechtoldt&url=https%3A%2F%2Fgithub.com%2Fbechtoldt%2Fsaltstack-network-formula

Salt Stack Formula to set up and configure a host's network configuration

NOTICE BEFORE YOU USE
=====================

* This formula aims to follow the conventions and recommendations described at http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#conventions-formula and http://docs.saltstack.com/en/latest/topics/best_practices.html

TODO
====

* Use more of the available options in interfaces.sls of network.managed
* interfaces: configure broadcast if set

Instructions
============

1. Add this repository as a `GitFS <http://docs.saltstack.com/topics/tutorials/gitfs.html>`_ backend in your Salt master config.

2. Configure your Pillar top file (``/srv/pillar/top.sls``) and your pillars, see pillar.example.sls

3. Include this Formula within another Formula or simply define your needed states within the Salt top file (``/srv/salt/top.sls``).

Available states
================

.. contents::
    :local:

``network.hosts``
-----------------
Sets the static lookup table for hostnames

``network.interfaces``
----------------------
Sets the network interfaces configuration

``network.resolver``
--------------------
Sets the resolver configuration

``network.routes``
------------------
Manages network routes

Additional resources
====================

None

Formula Dependencies
====================

None

Contributions
=============

Contributions are always welcome. All development guidelines you have to know are

* write clean code (proper YAML+Jinja syntax, no trailing whitespaces, no empty lines with whitespaces, LF only)
* set sane default settings
* test your code
* update README.rst doc

Salt Compatibility
==================

Tested with:

* 2014.1
* 2014.7

OS Compatibility
================

Tested with:

* GNU/ Linux Debian Wheezy
* CentOS 6 (not completly tested)

AUTHORS
=======

Please add yourself too when contributing (sorted alphabetically)!

* Arnold Bechtoldt <mail@arnoldbechtoldt.com>