Support a more flexible configuration file. (#15)

Merge branch 'feature/flexible-config' into master

Author: lae

README.md

@@ -4,7 +4,7 @@
 lae.netbox
 =========
 
-Installs and configures DigitalOcean's [NetBox](https://github.com/digitalocean/netbox).
+Installs and configures DigitalOcean's [NetBox]().
 
 This role deploys NetBox inside of a virtualenv, uses uWSGI as its frontend
 (can be used standalone or behind a load balancer), works with both Python 2/3
@@ -38,11 +38,15 @@ order to use Python 2.
 
 See the *Example Playbook* section for more information on configuring the DB.
 
-`netbox_secret_key`, if left undefined, will be generated by this role and (by
-default) stored in `/srv/netbox/shared/generated_secret_key`. This will then be
-used by the role to configure NetBox unless `netbox_secret_key` is later defined.
+`netbox_config` should contain a dictionary of of settings to configure
+NetBox with. See [Mandatory Settings]() and [Optional Settings]() from the
+NetBox documentation for more information, as well as `examples/netbox_config.yml`
+in this repository.
 
-`netbox_allowed_hosts` is a list defining `ALLOWED_HOSTS`.
+If `netbox_config.SECRET_KEY` is left undefined, this role will automatically
+generate one for you and store it in `/srv/netbox/shared/generated_secret_key`
+(by default). The SECRET_KEY will be read from this file on subsequent runs,
+unless you override it by defining `netbox_config.SECRET_KEY`.
 
 To load the initial data shipped by NetBox, set `netbox_load_initial_data` to
 true. Otherwise, this role will deploy NetBox with an empty slate.
@@ -79,8 +83,9 @@ socket to authenticate with the Postgres server.
          netbox_stable: true
          netbox_database_socket: "{{ postgresql_unix_socket_directories[0] }}"
          netbox_uwsgi_socket: "0.0.0.0:80"
-         netbox_allowed_hosts:
-           - netbox.idolactiviti.es
+         netbox_config:
+           ALLOWED_HOSTS:
+             - netbox.idolactiviti.es
          postgresql_users:
            - name: "{{ netbox_database_user }}"
              role_attr_flags: CREATEDB,NOSUPERUSER
@@ -96,11 +101,15 @@ installing NetBox on to authenticate with it over TCP:
       vars:
          netbox_stable: true
          netbox_uwsgi_socket: "0.0.0.0:80"
-         netbox_allowed_hosts:
-           - "{{ inventory_hostname }}"
+         netbox_config:
+           ALLOWED_HOSTS:
+             - "{{ inventory_hostname }}"
          netbox_database_host: pg-netbox.idolactiviti.es
          netbox_database_port: 15432
          netbox_database_name: netbox_prod
          netbox_database_user: netbox_prod_user
          netbox_database_password: "very_secure_password_for_prod"
 
+[NetBox]: https://github.com/digitalocean/netbox
+[Mandatory Settings]: http://netbox.readthedocs.io/en/stable/configuration/mandatory-settings/
+[Optional Settings]: http://netbox.readthedocs.io/en/stable/configuration/optional-settings/

defaults/main.yml

@@ -17,15 +17,11 @@ netbox_database_user: netbox
 netbox_database_port: 5432
 #netbox_database_socket: /var/run/postgresql
 
-#netbox_secret_key:
-netbox_allowed_hosts:
-  - localhost
-  - 127.0.0.1
-netbox_login_required: false
-netbox_base_path:
-netbox_paginate_count: 50
-netbox_timezone: UTC
-netbox_prefer_ipv4: false
+netbox_config:
+  #SECRET_KEY:
+  ALLOWED_HOSTS:
+    - localhost
+    - 127.0.0.1
 
 netbox_user: netbox
 netbox_group: netbox

examples/netbox_config.yml

@@ -0,0 +1,41 @@
+---
+netbox_config:
+  #SECRET_KEY: "hLk3ED%o#P0teb&UjKN)Quvr=SW$HcM^Z(Rzy_sBXFfpY+5TVC" # let this be generated by the role so you don't have to store it
+  ALLOWED_HOSTS:
+    - 127.0.0.1
+    - localhost
+  ADMINS:
+    -
+      - Hank Hill
+      - [email protected]
+    -
+      - Dale Gribble
+      - [email protected]
+  # note that the array is nested above
+  BANNER_TOP: &BANNER_TOP 'Your banner text'
+  BANNER_BOTTOM: *BANNER_TOP
+  # you probably won't need this, but you can reference other variables like above
+  BASE_PATH: netbox/
+  CORS_ORIGIN_ALLOW_ALL: false
+  DEBUG: yes
+  # yes, no, false, true, False, True are all valid booleans in Ansible - they will be inserted correctly in configuration.py
+  EMAIL:
+    SERVER: localhost
+    PORT: 25
+    USERNAME: user@localhost
+    PASSWORD: password
+    TIMEOUT: 10
+    FROM_EMAIL: notifications@localhost
+  LOGIN_REQUIRED: yes
+  MAINTENANCE_MODE: False
+  MAX_PAGE_SIZE: 500
+  PAGINATE_COUNT: 100
+  PREFER_IPV4: False
+  TIME_ZONE: UTC
+  DATE_FORMAT: N j, Y
+  # quotes aren't necessary as you can see - but in my opinion quotes make this more readable
+  SHORT_DATE_FORMAT: 'Y-m-d'
+  TIME_FORMAT: 'g:i a'
+  SHORT_TIME_FORMAT: 'H:i:s'
+  DATETIME_FORMAT: 'N j, Y g:i a'
+  SHORT_DATETIME_FORMAT: 'Y-m-d H:i'

tasks/deploy_netbox.yml

@@ -11,7 +11,7 @@
 
 - include: generate_secret_key.yml
   when:
-    - netbox_secret_key is not defined
+    - netbox_config.SECRET_KEY is not defined
 
 - name: Create NetBox virtualenv and install needed Python dependencies
   pip:

tasks/generate_secret_key.yml

@@ -9,6 +9,6 @@
     src: "{{ netbox_shared_path }}/generated_secret_key"
   register: __netbox_secret_key_file
 
-- name: Set netbox_secret_key to generated SECRET_KEY
+- name: Set netbox_config.SECRET_KEY to generated SECRET_KEY
   set_fact:
-    netbox_secret_key: "{{ __netbox_secret_key_file['content'] | b64decode }}"
+    netbox_config: "{{ netbox_config | combine({'SECRET_KEY': __netbox_secret_key_file['content'] | b64decode}) }}"

templates/configuration.py.j2

@@ -1,21 +1,22 @@
 # {{ ansible_managed }}
-ALLOWED_HOSTS = {{ netbox_allowed_hosts | to_json }}
 DATABASE = {
     'NAME': '{{ netbox_database }}',
     'USER': '{{ netbox_database_user }}',
 {% if netbox_database_host is defined %}
     'PASSWORD': '{{ netbox_database_password }}',
     'HOST':  '{{ netbox_database_host }}',
     'PORT': '{{ netbox_database_port }}',
-{% else %} 
+{% else %}
     'HOST': '{{ netbox_database_socket }}',
 {% endif %}
 }
-SECRET_KEY = '{{ netbox_secret_key }}'
-LOGIN_REQUIRED = {{ "True" if netbox_login_required else "False" }}
-BASE_PATH = '{{ netbox_base_path }}'
-PAGINATE_COUNT = '{{ netbox_paginate_count }}'
-TIME_ZONE = '{{ netbox_timezone }}'
-PREFER_IPV4 = '{{ "True" if netbox_prefer_ipv4 else "False" }}'
+
+{% for setting, value in netbox_config.iteritems() %}
+{% if value in [True, False] %}
+{{ setting }} = {{ 'True' if value else 'False' }}
+{% else %}
+{{ setting }} = {{ value | to_nice_json }}
+{% endif %}
+{% endfor %}
 
 # vim: ft=python

tests/group_vars/netbox

@@ -1,8 +1,9 @@
 ---
 ansible_ssh_user: root
 netbox_uwsgi_socket: "0.0.0.0:8080"
-netbox_allowed_hosts:
-  - "{{ inventory_hostname }}"
+netbox_config:
+  ALLOWED_HOSTS:
+    - "{{ inventory_hostname }}"
 netbox_database_socket: "{{ postgresql_unix_socket_directories[0] }}"
 postgresql_users:
   - name: "{{ netbox_database_user }}"

tests/test.yml

@@ -14,11 +14,10 @@
             url: "http://{{ inventory_hostname }}:8080"
         - name: uWSGI/NetBox service status
           shell: "systemctl status netbox.service"
-          changed_when: false
         - name: uWSGI/NetBox service journal
           shell: "journalctl --no-pager -xu netbox.service"
-          changed_when: false
         - name: NetBox application log
           shell: cat /srv/netbox/shared/application.log
-          changed_when: false
+        - name: NetBox configuration
+          shell: cat /srv/netbox/shared/configuration.py
       ignore_errors: yes