Support for installing/configuring CUSTOM_VALIDATORS

README.adoc

@@ -390,6 +390,33 @@ You may need to use this file for deploying certain NetBox plugins.
 
 NOTE: Commenting or removing this role variable from your playbook will remove `local_settings.py` from your NetBox deployment.
 
+[source,yaml]
+----
+netbox_custom_validators_enabled: true
+netbox_custom_validators_file: netbox_custom_validators.py
+----
+
+Toggle `netbox_custom_validators_enabled` to `true` to create a custom validator file for
+NetBox. `netbox_custom_validators_file` should be the path to your custom validator file - by
+default, Ansible will search your playbook's `files/` directory for this.
+You can find an example in `examples/`. You will also need to set
+`netbox_config.CUSTOM_VALIDATORS` to
+
+```
+CUSTOM_VALIDATORS: |
+    {
+        "dcim.device": (
+            'custom_validators.DeviceValidator',
+        ),
+        "virtualization.virtualmachine": (
+            'custom_validators.VirtualMachineValidator',
+        )
+    }
+```
+
+TIP: By default, a local (non-LDAP) superuser will still be created by this
+role. If this is undesirable, consider toggling `netbox_superuser_enabled`.
+
 [source,yaml]
 ----
 netbox_napalm_enabled: false

defaults/main.yml

@@ -76,6 +76,9 @@ netbox_ldap_config_template: netbox_ldap_config.py.j2
 
 # netbox_local_settings_file: "{{ playbook_dir }}/files/netbox/local_settings.py"
 
+netbox_custom_validators_enabled: false
+netbox_custom_validators_file: 
+
 netbox_napalm_enabled: false
 netbox_napalm_packages:
   - napalm

tasks/deploy_netbox.yml

@@ -169,6 +169,30 @@
   notify:
     - reload netbox.service
 
+# custom validators
+- name: Copy NetBox custom validators into shared 
+  ansible.builtin.copy:
+    src: "{{ netbox_custom_validators_file }}"
+    dest: "{{ netbox_shared_path }}/custom_validators.py"
+    owner: "{{ netbox_user }}"
+    group: "{{ netbox_group }}"
+  ignore_errors: yes
+  when:
+    - netbox_custom_validators_file is defined and netbox_custom_validators_enabled
+  notify:
+    - reload netbox.service
+
+- name: Symlink/Remove NetBox local_settings.py file into/from the active NetBox release
+  file:
+    src: "{{ netbox_shared_path + '/custom_validators.py' if netbox_custom_validators_enabled else omit }}"
+    dest: "{{ netbox_current_path }}/netbox/custom_validators.py"
+    owner: "{{ netbox_user }}"
+    group: "{{ netbox_group }}"
+    state: "{{ 'link' if netbox_custom_validators_enabled else 'absent' }}"
+  notify:
+    - reload netbox.service
+
+
 - name: Copy NetBox scripts into SCRIPTS_ROOT
   copy:
     src: "{{ item.src }}"

templates/configuration.py.j2

@@ -100,6 +100,8 @@ METRICS_ENABLED = True
 {% for setting, value in _netbox_config.items() %}
 {%      if value in [True, False] %}
 {{ setting }} = {{ 'True' if value else 'False' }}
+{%      elif setting == 'CUSTOM_VALIDATORS' %}
+{{ setting }} = {{ value | safe }}
 {%      elif value is string or value is number %}
 {{ setting }} = {{ value | to_nice_json }}
 {%      else %}