Merge pull request #79 from kdhlab/feature/remote-file-system

Remote file storage support

Author: lae

.gitignore

@@ -2,3 +2,4 @@
 .vscode/
 .history
 *.retry
+*.code-workspace

tasks/deploy_netbox.yml

@@ -38,15 +38,18 @@
   register: _netbox_virtualenv_setup
   until: _netbox_virtualenv_setup is succeeded
 
-- name: Install django-rq
+- name: Install selected optional Python dependencies
   pip:
-    name: "django-rq"
+    name: "{{ item }}"
+    state: present
     virtualenv: "{{ netbox_virtualenv_path }}"
   become: True
   become_user: "{{ netbox_user }}"
   retries: 2
-  register: _netbox_django_rq_install
-  until: _netbox_django_rq_install is succeeded
+  register: _netbox_pip_additional_install
+  until: _netbox_pip_additional_install is succeeded
+  when: (_netbox_python_deps | length) > 0
+  loop: "{{ _netbox_python_deps }}"
 
 - name: Generate NetBox configuration file
   template:
@@ -61,44 +64,21 @@
   notify:
     - reload netbox.service
 
-- block:
-  - name: Install django-auth-ldap if LDAP is enabled
-    pip:
-      name: django-auth-ldap
-      virtualenv: "{{ netbox_virtualenv_path }}"
-    become: True
-    become_user: "{{ netbox_user }}"
-    retries: 2
-    register: _netbox_django_auth_ldap_install
-    until: _netbox_django_auth_ldap_install is succeeded
-
-  - name: Generate LDAP configuration for NetBox if enabled
-    template:
-      src: "{{ netbox_ldap_config_template }}"
-      dest: "{{ netbox_shared_path }}/ldap_config.py"
-      owner: "{{ netbox_user }}"
-      group: "{{ netbox_group }}"
-      mode: 0640
-      validate: "{{ netbox_virtualenv_path }}/bin/python -c \"import py_compile,os; f=r'%s';\
-                 c='/tmp/' + os.path.basename(os.path.dirname(f)) + '-' + os.path.basename(f) + 'c';\
-                 py_compile.compile(f, c); os.remove(c)\""
-    notify:
-      - reload netbox.service
+- name: Generate LDAP configuration for NetBox if enabled
+  template:
+    src: "{{ netbox_ldap_config_template }}"
+    dest: "{{ netbox_shared_path }}/ldap_config.py"
+    owner: "{{ netbox_user }}"
+    group: "{{ netbox_group }}"
+    mode: 0640
+    validate: "{{ netbox_virtualenv_path }}/bin/python -c \"import py_compile,os; f=r'%s';\
+                c='/tmp/' + os.path.basename(os.path.dirname(f)) + '-' + os.path.basename(f) + 'c';\
+                py_compile.compile(f, c); os.remove(c)\""
+  notify:
+    - reload netbox.service
   when:
     - netbox_ldap_enabled
 
-- name: Install napalm if NAPALM integration is enabled
-  pip:
-    name: "{{ netbox_napalm_packages }}"
-    virtualenv: "{{ netbox_virtualenv_path }}"
-  when:
-    - netbox_napalm_enabled
-  become: True
-  become_user: "{{ netbox_user }}"
-  retries: 2
-  register: _netbox_napalm_install
-  until: _netbox_napalm_install is succeeded
-
 - name: Symlink NetBox configuration file into the active NetBox release
   file:
     src: "{{ netbox_shared_path }}/configuration.py"

tasks/load_variables.yml

@@ -27,6 +27,18 @@
     netbox_ldap_packages: "{{ _netbox_ldap_packages | list }}"
   when: netbox_ldap_packages is not defined
 
+- name: Generate list of optional Python dependencies
+  set_fact:
+    _netbox_python_deps:
+      - "{{ netbox_napalm_packages if netbox_napalm_enabled else [] }}"
+      - "{{ 'django-auth-ldap' if netbox_ldap_enabled else [] }}"
+      - "{{ 'django-storages' if _netbox_storages_module is defined else [] }}"
+      - "{{ _netbox_storages_map[_netbox_storages_module] if _netbox_storages_module is defined else [] }}"
+
+- name: Flatten that list of dependencies
+  set_fact:
+    _netbox_python_deps: "{{ _netbox_python_deps | flatten }}"
+
 - name: Identify current execution PATH
   shell: "echo $PATH"
   register: _path_exec

tasks/validate_variables.yml

@@ -56,3 +56,15 @@
       - "(netbox_scripts | map(attribute='name') | map('regex_search', '^[a-z][a-z0-9_]*$') | select('string') | list | length) == (netbox_scripts | length)"
       - "(netbox_reports | map(attribute='name') | map('regex_search', '^[a-z][a-z0-9_]*$') | select('string') | list | length) == (netbox_reports | length)"
     msg: "Please ensure that your script/report module names start with a lowercase letter and contain only lowercase letters, numbers, and underscores."
+
+- block:
+  - name: Identify selected storage module
+    set_fact:
+      _netbox_storages_module: "{{ netbox_config.STORAGE_BACKEND | regex_search('(?<=storages\\.backends\\.).*(?=\\.)') }}"
+
+  - name: Ensure storage module is a valid option
+    assert:
+      that:
+        - _netbox_storages_module in _netbox_storages_map
+      msg: "Please ensure your STORAGE_BACKEND is correct."
+  when: "'STORAGE_BACKEND' in netbox_config"

vars/main.yml

@@ -3,6 +3,15 @@
 netbox_config_path: "{{ netbox_current_path }}/netbox/netbox"
 netbox_virtualenv_path: "{{ netbox_current_path }}/venv-py3"
 
+_netbox_storages_map:
+  s3boto3: boto3
+  apache_libcloud: "apache-libcloud"
+  azure_storage: "django-storages[azure]"
+  dropbox: "django-storages[dropbox]"
+  gcloud: "django-storages[google]"
+  ftp: []
+  sftpstorage: []
+
 netbox_superuser_script: |
   from django.contrib.auth.models import User
   from base64 import b64decode