Make netbox_local_settings_file optional and include explanation

Author: lae

README.adoc

@@ -401,16 +401,16 @@ role. If this is undesirable, consider toggling `netbox_superuser_enabled`.
 
 [source,yaml]
 ----
-netbox_local_settings_file: netbox_local_settings.py
+# netbox_local_settings_file: "{{ playbook_dir }}/files/netbox/local_settings.py"
 ----
 
-Add the `netbox_local_settings_file` var with the name of the local settings 
-file in your ansible repository to deploy local_settings.py to NetBox. 
-Ansible will search your playbook's `files/` directory for this when using a 
-relative path.
+If you need to override any settings or extend the functionality in NetBox' `settings.py`
+in a way that is not supported by the `configuration.py` (i.e. the `netbox_config` role variable),
+you can set `netbox_local_settings_file` to a local file path in your playbook to deploy a `local_settings.py` file within NetBox.
+This feature was https://github.com/netbox-community/netbox/issues/16127[introduced in NetBox v4.0.2].
+You may need to use this file for deploying certain NetBox plugins.
 
-NOTE: The destination file will always be `local_settings.py`, the source file name
-can be unique to allow for different deployments from the one ansible repository.
+NOTE: Commenting or removing this role variable from your playbook will remove `local_settings.py` from your NetBox deployment.
 
 [source,yaml]
 ----

defaults/main.yml

@@ -74,7 +74,7 @@ netbox_requests_log: "file:{{ netbox_shared_path }}/requests.log"
 netbox_ldap_enabled: false
 netbox_ldap_config_template: netbox_ldap_config.py.j2
 
-netbox_local_settings_file:
+# netbox_local_settings_file: "{{ playbook_dir }}/files/netbox/local_settings.py"
 
 netbox_napalm_enabled: false
 netbox_napalm_packages:

tasks/deploy_netbox.yml

@@ -140,15 +140,14 @@
     dest: "{{ netbox_shared_path }}/local_settings.py"
     owner: "{{ netbox_user }}"
     group: "{{ netbox_group }}"
-  ignore_errors: yes
   when:
     - netbox_local_settings_file is defined
   notify:
     - reload netbox.service
 
 - name: Symlink/Remove NetBox local_settings.py file into/from the active NetBox release
-  file:
-    src: "{{ netbox_shared_path + '/local_settings.py' if netbox_local_settings_file is defined else omit }}"
+  ansible.builtin.file:
+    src: "{{ netbox_shared_path }}/local_settings.py"
     dest: "{{ netbox_config_path }}/local_settings.py"
     owner: "{{ netbox_user }}"
     group: "{{ netbox_group }}"