From fc00439357256a05f1b56220c64eee0acb81315f Mon Sep 17 00:00:00 2001
From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Fri, 2 Feb 2018 15:46:58 -0500
Subject: [PATCH] Add pip.conf to wrappers

This is a global-jjb breaking change as it now causes us to require
the pipconf file configured in Config File Provider. This allows us
to configure for projects that have Nexus 3 a PyPi proxy for faster
local downloads.

Contents of pip.conf should look something like:

[global]
timeout = 60
index-url = https://nexus3.opendaylight.org/repository/PyPi/simple

Change-Id: I4ac816f1b78f09c101e6d614bdd3c459fe0e133a
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---
 docs/configuration.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst         |  1 +
 jjb/lf-macros.yaml     |  2 ++
 3 files changed, 51 insertions(+)
 create mode 100644 docs/configuration.rst

diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100644
index 00000000..af98c6e2
--- /dev/null
+++ b/docs/configuration.rst
@@ -0,0 +1,48 @@
+.. _global-jjb-configuration:
+
+#############
+Configuration
+#############
+
+Jenkins Files
+=============
+
+global-jjb makes use of the Jenkins Config File Provider plugin to provide some
+default configurations for certain tools. This section details the files to
+define in Jenkins' **Manage Files** configuration.
+
+npmrc
+-----
+
+This file contains default npmrc configuration and lives in $HOME/.npmrc.
+Documentation for npmrc is available via the `npm project
+<https://docs.npmjs.com/files/npmrc>`_.
+
+:Required: This file MUST exist. An empty file is acceptable if a
+proxy is not available for the project.
+:type: Custom file
+
+Create a "Custom file" with contents:
+
+.. code::
+
+   registry = https://nexus.opendaylight.org/content/repositories/npmjs/
+
+pip.conf
+--------
+
+This file contains default configuration for the python-pip tool and lives
+in $HOME/.config/pip/pip.conf. Documentation for pip.conf is available via the
+`pip project <https://pip.readthedocs.io/en/stable/user_guide/#configuration>`_.
+
+:Required: This file MUST exist. An empty file is acceptable if a
+proxy is not available for the project.
+:type: Custom file
+
+Create a "Custom file" with contents:
+
+.. code::
+
+   [global]
+   timeout = 60
+   index-url = https://nexus3.opendaylight.org/repository/PyPi/simple
diff --git a/docs/index.rst b/docs/index.rst
index bce1ed9a..19b6380c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,6 +15,7 @@ Guides
    :maxdepth: 2
 
    best-practices
+   configuration
 
 Global JJB Templates
 --------------------
diff --git a/jjb/lf-macros.yaml b/jjb/lf-macros.yaml
index 14c23933..fb179926 100644
--- a/jjb/lf-macros.yaml
+++ b/jjb/lf-macros.yaml
@@ -470,3 +470,5 @@
           files:
             - file-id: npmrc
               target: '$HOME/.npmrc'
+            - file-id: pipconf
+              target: '$HOME/.config/pip/pip.conf'
-- 
2.16.6