Add docs for Python XC CLM
[releng/global-jjb.git] / docs / configuration.rst
1 .. _global-jjb-configuration:
2
3 #############
4 Configuration
5 #############
6
7 Jenkins Files
8 =============
9
10 global-jjb makes use of the Jenkins Config File Provider plugin to provide some
11 default configurations for certain tools. This section details the files to
12 define in Jenkins' **Manage Files** configuration.
13
14 npmrc
15 -----
16
17 This file contains default npmrc configuration and lives in $HOME/.npmrc.
18 Documentation for npmrc is available via the `npm project
19 <https://docs.npmjs.com/files/npmrc>`_.
20
21 :Required: This file MUST exist. An empty file is acceptable if a
22     proxy is not available for the project.
23 :type: Custom file
24
25 Create a "Custom file" with contents:
26
27 .. code::
28
29    registry = https://nexus.opendaylight.org/content/repositories/npmjs/
30
31 pipconf
32 -------
33
34 This file contains default configuration for the python-pip tool and lives
35 in $HOME/.config/pip/pip.conf. Documentation for pip.conf is available via the
36 `pip project <https://pip.readthedocs.io/en/stable/user_guide/#configuration>`_.
37
38 :Required: This file MUST exist. An empty file is acceptable if a
39     proxy is not available for the project.
40 :type: Custom file
41
42 Create a "Custom file" with contents:
43
44 .. code::
45
46    [global]
47    timeout = 60
48    index-url = https://nexus3.opendaylight.org/repository/PyPi/simple
49
50
51 Jenkins CI Jobs
52 ===============
53
54 jenkins-cfg-merge
55 -----------------
56
57 This job manages Jenkins Global configuration. Refer to
58 the :ref:`CI Documentation <lf-global-jjb-jenkins-cfg-merge>` for job
59 configuration details.