Merge branch 'release/0.6.0'

Author: lae

README.md

@@ -31,6 +31,14 @@ ansible-playbook -i your.server.fqdn, ~/.ansible/roles/lae.netbox/examples/playb
 This will deploy NetBox and PostgreSQL on `your.server.fqdn`; once complete it
 should be accessible on port 80. Modify if needed. Read below for more insight.
 
+You can also use Vagrant, if you prefer, to bring up NetBox at `localhost:8080`:
+
+```
+ansible-galaxy install geerlingguy.postgresql lae.netbox
+cd ~/.ansible/roles/lae.netbox/
+vagrant up
+```
+
 Prerequisites
 -------------
 

Vagrantfile

@@ -0,0 +1,8 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "generic/debian9"
+  config.vm.network "forwarded_port", guest: 80, host: 8080, auto_correct: true
+
+  config.vm.provision "ansible" do |ansible|
+    ansible.playbook = "examples/playbook_single_host_deploy.yml"
+  end
+end

examples/playbook_single_host_deploy.yml

@@ -11,6 +11,9 @@
     netbox_config:
       ALLOWED_HOSTS:
         - "{{ inventory_hostname }}"
+        # The following should not be used in production, probably.
+        # This playbook gets used by Vagrant where we don't know the actual hostname.
+        - "*"
       MEDIA_ROOT: "{{ netbox_shared_path }}/media"
       REPORTS_ROOT: "{{ netbox_shared_path }}/reports"
     netbox_database_socket: "{{ postgresql_unix_socket_directories[0] }}"

meta/main.yml

@@ -1,9 +1,8 @@
 galaxy_info:
-  role_name: netbox
   author: Musee Ullah
   description: Installs and configures NetBox, a DCIM suite, in a production setting.
   license: MIT
-  min_ansible_version: 2.4
+  min_ansible_version: 2.5
   platforms:
     - name: Ubuntu
       versions:

tasks/deploy_netbox.yml

@@ -5,7 +5,7 @@
     state: directory
     owner: "{{ netbox_user }}"
     group: "{{ netbox_group }}"
-  with_items:
+  loop:
     - "{{ netbox_releases_path }}"
     - "{{ netbox_shared_path }}"
     - "{{ netbox_shared_path }}/media/image-attachments"
@@ -101,8 +101,8 @@
 
   - name: Create a super user for NetBox
     shell: "printf '{{ netbox_superuser_script }}' | {{ netbox_virtualenv_path }}/bin/python {{ netbox_current_path }}/netbox/manage.py shell"
-    register: __netbox_superuser_result
-    changed_when: "'changed' in __netbox_superuser_result.stdout"
+    register: _netbox_superuser_result
+    changed_when: "'changed' in _netbox_superuser_result.stdout"
     when:
       - not netbox_ldap_enabled
 

tasks/generate_secret_key.yml

@@ -1,6 +1,6 @@
 ---
 - name: Generate a SECRET_KEY for NetBox if unspecified
-  shell: "{{ netbox_current_path }}/netbox/generate_secret_key.py | tr -d $'\n' > {{ netbox_shared_path }}/generated_secret_key"
+  shell: "{{ netbox_python_binary }} {{ netbox_current_path }}/netbox/generate_secret_key.py | tr -d $'\n' > {{ netbox_shared_path }}/generated_secret_key"
   args:
     creates: "{{ netbox_shared_path }}/generated_secret_key"
   become: True
@@ -9,8 +9,8 @@
 - name: Load saved SECRET_KEY
   slurp:
     src: "{{ netbox_shared_path }}/generated_secret_key"
-  register: __netbox_secret_key_file
+  register: _netbox_secret_key_file
 
 - name: Set netbox_config.SECRET_KEY to generated SECRET_KEY
   set_fact:
-    netbox_config: "{{ netbox_config | combine({'SECRET_KEY': __netbox_secret_key_file['content'] | b64decode}) }}"
+    netbox_config: "{{ netbox_config | combine({'SECRET_KEY': _netbox_secret_key_file['content'] | b64decode}) }}"

tasks/install_packages_apt.yml

@@ -4,7 +4,7 @@
     repo: "{{ item }}"
     state: present
     update_cache: yes
-  with_items:
+  loop:
     - "deb http://in.archive.ubuntu.com/ubuntu/ {{ ansible_distribution_release }} main universe"
     - "deb http://in.archive.ubuntu.com/ubuntu/ {{ ansible_distribution_release }}-updates main universe"
     - "deb http://in.archive.ubuntu.com/ubuntu/ {{ ansible_distribution_release }}-backports main universe"
@@ -13,13 +13,14 @@
 
 - name: Install required packages for selected NetBox configuration
   apt:
-    name: "{{ item }}"
-    state: latest
+    name: "{{ _netbox_apt_packages | flatten }}"
+    state: present
     cache_valid_time: 3600
     update_cache: yes
-  with_items:
-    - "{{ netbox_python_packages }}"
-    - "{{ netbox_packages }}"
-    - "{{ netbox_ldap_packages if netbox_ldap_enabled else [] }}"
-    - "{{ 'git' if netbox_git else [] }}"
-    - "{{ 'acl' if ('SUDO_USER' in ansible_env and ansible_env.SUDO_USER != 'root') else [] }}"
+  vars:
+    _netbox_apt_packages:
+      - "{{ netbox_python_packages }}"
+      - "{{ netbox_packages }}"
+      - "{{ netbox_ldap_packages if netbox_ldap_enabled else [] }}"
+      - "{{ 'git' if netbox_git else [] }}"
+      - "{{ 'acl' if ('SUDO_USER' in ansible_env and ansible_env.SUDO_USER != 'root') else [] }}"

tasks/install_packages_yum.yml

@@ -6,12 +6,13 @@
 
 - name: Install required packages for selected NetBox configuration
   yum:
-    name: "{{ item }}"
+    name: "{{ _netbox_yum_packages | flatten }}"
     state: latest
     update_cache: yes
-  with_items:
-    - "{{ netbox_python_packages }}"
-    - "{{ netbox_packages }}"
-    - "{{ netbox_ldap_packages if netbox_ldap_enabled else [] }}"
-    - "{{ 'git' if netbox_git else [] }}"
-    - "{{ 'acl' if ('SUDO_USER' in ansible_env and ansible_env.SUDO_USER != 'root') else [] }}"
+  vars:
+    _netbox_yum_packages:
+      - "{{ netbox_python_packages }}"
+      - "{{ netbox_packages }}"
+      - "{{ netbox_ldap_packages if netbox_ldap_enabled else [] }}"
+      - "{{ 'git' if netbox_git else [] }}"
+      - "{{ 'acl' if ('SUDO_USER' in ansible_env and ansible_env.SUDO_USER != 'root') else [] }}"

tasks/install_via_git.yml

@@ -4,7 +4,7 @@
     repo: "{{ netbox_git_uri }}"
     dest: "{{ netbox_git_repo_path }}"
     version: "{{ netbox_git_version }}"
-  register: __netbox_git_repo
+  register: _netbox_git_repo
   become: True
   become_user: "{{ netbox_user }}"
 
@@ -19,9 +19,9 @@
   shell: 'git log --format=%H "{{ netbox_git_version }}" | grep ^1fb67b791f1a91c624dae4a1cd256e4cf3ddbb77'
   args:
     chdir: "{{ netbox_git_repo_path }}"
-  register: __netbox_git_contains_issue_2239_fix
+  register: _netbox_git_contains_issue_2239_fix
   changed_when: False
-  failed_when: "__netbox_git_contains_issue_2239_fix.rc not in [0, 1]"
+  failed_when: "_netbox_git_contains_issue_2239_fix.rc not in [0, 1]"
 
 - name: Archive and extract snapshot of git repository
   shell: 'git archive "{{ netbox_git_version }}" | tar -x -C "{{ netbox_git_deploy_path }}"'
@@ -30,7 +30,7 @@
   notify:
     - reload netbox.service
   when:
-    - __netbox_git_repo is changed
+    - _netbox_git_repo is changed
   become: True
   become_user: "{{ netbox_user }}"
 

tasks/main.yml

@@ -87,6 +87,6 @@
     name: "{{ item }}"
     state: started
     enabled: yes
-  with_items:
+  loop:
     - netbox.socket
     - netbox.service