Skip to main content

Converts NetJSON DeviceConfiguration objects to real router configurations

Project description

https://travis-ci.org/openwisp/netjsonconfig.svg https://coveralls.io/repos/openwisp/netjsonconfig/badge.svg Requirements Status https://badge.fury.io/py/netjsonconfig.svg https://img.shields.io/pypi/dm/netjsonconfig.svg

Converts NetJSON DeviceConfiguration objects to real router configurations.

Currently we are working only on OpenWRT support.

Install stable version from pypi

Install from pypi:

pip install netjsonconfig

Install development version

Install tarball:

pip install https://github.com/openwisp/netjsonconfig/tarball/master

Alternatively you can install via pip using git:

pip install -e git+git://github.com/openwisp/netjsonconfig#egg=netjsonconfig

If you want to contribute, install your cloned fork:

git clone git@github.com:<your_fork>/netjsonconfig.git
cd netjsonconfig
python setup.py develop

Basic Usage Example

from netjsonconfig import OpenWrt

o = OpenWrt({
    "type": "DeviceConfiguration",
    "interfaces": [
        {
            "name": "eth0.1",
            "type": "ethernet",
            "addresses": [
                {
                    "address": "192.168.1.1",
                    "mask": 24,
                    "proto": "static",
                    "family": "ipv4"
                },
                {
                    "address": "192.168.2.1",
                    "mask": 24,
                    "proto": "static",
                    "family": "ipv4"
                },
                {
                    "address": "fd87::1",
                    "mask": 128,
                    "proto": "static",
                    "family": "ipv6"
                }
            ]
        }
    ]
})
print(o.render())

Will print:

package network

config interface 'eth0_1'
    option ifname 'eth0.1'
    option proto 'static'
    option ipaddr '192.168.1.1/24'

config interface 'eth0_1_2'
    option ifname 'eth0.1'
    option proto 'static'
    option ipaddr '192.168.2.1/24'

config interface 'eth0_1_3'
    option ifname 'eth0.1'
    option proto 'static'
    option ip6addr 'fd87::1/128'

The OpenWrt backend has a generate method which generates a compressed archive containing an OpenWRT configuration:

o.generate()

Will generate an archive named openwrt-config.tar.gz with the following directory structure:

/etc/
    config/
        network

Including additional files

netjsonconfig supports adding arbitrary text files to the generated configuration archive.

N.B.: The files won’t be included in the output of the render method because that would make it invalid.

The following example code will generate an archive with one file in /etc/crontabs/root:

from netjsonconfig import OpenWrt

o = OpenWrt({
    "files": [
        {
            "path": "/etc/crontabs/root",
            "contents": '* * * * * echo "test" > /etc/testfile'
        }
    ]
})
o.generate()

New lines must be escaped using \n, or alternatively, the contents can be represented as an array of lines:

o = OpenWrt({
    "files": [
        {
            "path": "/etc/crontabs/root",
            "contents": [
                '* * * * * echo "test" > /etc/testfile',
                '* * * * * echo "test2" > /etc/testfile2'
            ]
        }
    ]
})
o.generate()

Templates

If you have devices with very similar configurations you can store the shared blocks in one or more reusable templates which will be used as a base to build the final configuration.

Let’s illustrate this with a practical example, we have two devices both having an eth0 interface in DHCP mode (our template) but Router2 also has an eth1 interface with a statically assigned ipv4 address:

template = {
    "interfaces": [
        {
            "name": "eth0",
            "type": "ethernet",
            "addresses": [
                {
                    "proto": "dhcp",
                    "family": "ipv4"
                }
            ]
        }
    ]
}

router1_config = {
    "general": {"hostname": "Router1"}
}

router2_config = {
    "general": {"hostname": "Router2"},
    "interfaces": [
        {
            "name": "eth1",
            "type": "ethernet",
            "addresses": [
                {
                    "address": "192.168.1.1",
                    "mask": 24,
                    "proto": "static",
                    "family": "ipv4"
                }
            ]
        }
    ]
}

Generating the resulting configuration for Router1 and Router2 is straightforward:

from netjsonconfig import OpenWrt

router1 = OpenWrt(router1_config, templates=[template])
print(router1.render())

router2 = OpenWrt(router2_config, templates=[template])
print(router2.render())

Rendered configuration for Router1:

package system

config system
        option hostname 'Router1'
        option timezone 'UTC'

package network

config interface 'eth0'
        option ifname 'eth0'
        option proto 'dhcp'

Rendered configuration for Router2:

package system

config system
        option hostname 'Router2'
        option timezone 'UTC'

package network

config interface 'eth0'
        option ifname 'eth0'
        option proto 'dhcp'

config interface 'eth1'
        option ifname 'eth1'
        option ipaddr '192.168.1.1/24'
        option proto 'static'

Using multiple templates

You might have noticed that the templates argument is a list; that’s because it’s possible to pass multiple templates that will be added one on top of the other to build the resulting configuration, allowing to reduce or even eliminate repetitions.

Command line utility

netjsonconfig ships a command line utility that can be used from the interactive shell or in bash scripts:

netjsonconfig --help

Here’s the common use cases explained:

# generate tar.gz from a NetJSON DeviceConfiguration object
netjsonconfig --backend openwrt config.json

# see output of OpenWrt render method
netjsonconfig --backend openwrt --method render config.json

# abbreviated options
netjsonconfig -b openwrt -m render config.json

# passing a JSON string instead of a file path
netjsonconfig -b openwrt -m render '{"general": { "hostname": "example" }}'

Using templates:

netjsonconfig config.json -t template1.json template2.json -b openwrt -m render

Running tests

Install your forked repo:

git clone git://github.com/<your_fork>/netjsonconfig
cd netjsonconfig/
python setup.py develop

Install test requirements:

pip install -r requirements-test.txt

Run tests with:

./runtests.py

Alternatively, you can use the nose command (which has a ton of available options):

nosetests

See test coverage with:

coverage run --source=netjsonconfig runtests.py && coverage report

Contributing

  1. Announce your intentions in the issue tracker

  2. Fork this repo and install it

  3. Follow PEP8, Style Guide for Python Code

  4. Write code

  5. Write tests for your code

  6. Ensure all tests pass

  7. Ensure test coverage is not under 90%

  8. Document your changes

  9. Send pull request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netjsonconfig-0.2.tar.gz (41.1 kB view hashes)

Uploaded source

Built Distribution

netjsonconfig-0.2-py2.py3-none-any.whl (24.9 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page