A configuration generation tool for networking devices. Written in python with Django as web framework and ORM. Define network information like ports, addressing, and routing neighborships, then generate network device configurations based on templates. Examples for IOS, JunOS, BIRD and Quagga included.
Built with:
Django==1.11.13 django-bootstrap4==0.0.6 django-stronghold==0.3.0 djangorestframework==3.8.2 Jinja2==2.9.5 MarkupSafe==0.23 psycopg2==2.7.4 psycopg2-binary==2.7.4 pytz==2018.4
Public docker images now available: https://hub.docker.com/r/slothlogistics/gtools/
You only need one variable to start gtools, GTOOLS_SECRET_KEY. This assumes we can resolve the db host as "postgres" and a user "gtools" has grant all on a database "gtools" with the password "gtools_password." Most people will want to set a better password at least.
host$ docker run --name gtools -d \
-e GTOOLS_SECRET_KEY="really-long-secret-key-here" \
slothlogistics/gtools
You can set all the database variables as well, the defaults are the values below.
host$ docker run --name gtools -d \
-e GTOOLS_SECRET_KEY="really-long-secret-key-here" \
-e GTOOLS_DB_HOST="postgres" \
-e GTOOLS_DB_NAME="gtools" \
-e GTOOLS_DB_USER="gtools" \
-e GTOOLS_DB_PASS="gtools_password" \
slothlogistics/gtools
After that, you should be up and running! Please report any issues. If you don't already have a postgres installation or container running, you can use the two steps below to get going super quick.
host$ docker run --name gtools-db -d \
-e POSTGRES_DB=gtools \
-e POSTGRES_USER=gtools \
-e POSTGRES_PASSWORD="gtools_password" \
postgres:latest
host$ docker run -d --name gtools --link gtools-db:postgres \
-e GTOOLS_SECRET_KEY="really-long-secret-key-here" \
slothlogistics/gtools
This will start two containers, one for gtools the app, and one for postgres. Docker compose may come in the future.
To get a basic copy running with the built in httpd, there should just be a few steps from a clean system:
Virtualenv is a good idea, but I leave that up to you. You'll want to have python, django, and the database libraries of your choice. (postgreSQL by default in this project.)
- Example for Debian/Ubuntu:
apt-get install python-pip python-dev libpq-dev - Check out the code:
git clone https://github.com/lkmhaqer/gtools-python.git - Move to your new directory:
cd gtools-python - Install Python libraries:
pip install -r requirements.txt
Setup a database, and user with permissions to it, then update gtools/settings.py with these details. Now you're ready to run django's migrate command. Alternatively, set the backend to sqlite3 in gtools/settings.py (see example below "SQLite Settings") and specifiy a file instead of using postgres, then migrate.
- Django's migrate command:
python manage.py migrate - Create an admin user:
python manage.py createsuperuser - Start the webserver on all IPs:
python manage.py runserver 0.0.0.0:8000
Now you should be able to navigate to your host on port 8000 and see your new gtools install!
So, you have all your data in gtools, now to generate router configs! All device configs are located in $INSTALL_DIR/config_gen/templates/config_gen/, some examples are included for JunOS, BIRD, Quagga, IOS, and a YAML dictionary. Feel free to open an issue for a template on a new network platform. If you've created your own templates, and are able to share, feel free to submit them to me, or just a pull request.
If you would like to get going quick, and don't want to use postgreSQL, there is SQLite. The data will be saved to a file db.sqlite3, in your $INSTALL_DIR. To use it, instead of postgres, just replace the DATABASE variable block in gtools/settings.py with the following:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR , 'db.sqlite3'),
}
}