Merge pull request #201 from tyler-8/pip_cache_option

Add support for custom pip extra args

Author: lae

README.adoc

@@ -325,6 +325,17 @@ NOTE: If you specify any plugins here, be sure to include the appropriate plugin
 You may also need to configure `netbox_local_settings_file` in some situations.
 Read https://netbox.readthedocs.io/en/stable/plugins/[Plugins] for more info.
 
+[source,yaml]
+----
+netbox_pip_extra_args: []
+----
+
+This variable controls the pip installation behavior:
+
+- `netbox_pip_extra_args`: List of additional arguments passed to all `pip` commands in NetBox's virtualenv (e.g., `['-i', 'https://pypi.example.com/simple', '--trusted-host', 'pypi.example.com']`)
+
+Note: Constraint files (`-c constraints.txt`) are automatically included for all pip operations in the NetBox virtualenv.
+
 [source,yaml]
 ----
 netbox_user: netbox

defaults/main.yml

@@ -81,6 +81,7 @@ netbox_napalm_enabled: false
 netbox_napalm_packages:
   - napalm
 
+netbox_pip_extra_args: []  # Additional pip arguments (e.g., ['--no-cache-dir', '-i', 'https://pypi.example.com/simple'])
 netbox_pip_packages: []
 netbox_pip_constraints:
   # Blacklist pynacl 1.3.0 due to https://github.com/pyca/pynacl/issues/479

tasks/deploy_netbox.yml

@@ -21,7 +21,7 @@
     - _netbox_config.SECRET_KEY is not defined
 
 - name: Create NetBox virtualenv
-  pip:
+  ansible.builtin.pip:
     name:
       - pip
       - setuptools
@@ -62,7 +62,10 @@
 - name: Install needed Python dependencies
   ansible.builtin.pip:
     requirements: "{{ netbox_shared_path }}/requirements.txt"
-    extra_args: "-c {{ netbox_shared_path }}/constraints.txt"
+    extra_args: >-
+      {{ (['-c', netbox_shared_path + '/constraints.txt']
+         + (netbox_pip_extra_args | default([])))
+         | join(' ') }}
     virtualenv: "{{ netbox_virtualenv_path }}"
   become: true
   become_user: "{{ netbox_user }}"
@@ -75,6 +78,10 @@
     name: "{{ item }}"
     state: present
     virtualenv: "{{ netbox_virtualenv_path }}"
+    extra_args: >-
+      {{ (['-c', netbox_shared_path + '/constraints.txt']
+         + (netbox_pip_extra_args | default([])))
+         | join(' ') }}
   become: true
   become_user: "{{ netbox_user }}"
   retries: 2
@@ -92,7 +99,7 @@
     content: |
       {% for dep in _netbox_python_deps %}
       {{ dep }}
-      {% endfor %}  
+      {% endfor %}
     dest: "{{ netbox_current_path }}/local_requirements.txt"
     owner: "{{ netbox_user }}"
     group: "{{ netbox_group }}"

tasks/main.yml

@@ -74,6 +74,9 @@
     state: "{{ 'latest' if netbox_keep_uwsgi_updated else 'present' }}"
     umask: "0022"
     virtualenv: "{{ omit if not netbox_uwsgi_in_venv else netbox_virtualenv_path }}"
+    extra_args: >-
+      {{ netbox_pip_extra_args | default([])
+         | join(' ') }}
   environment:
     PATH: "/usr/local/bin:{{ _path }}"
   notify: