1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. (c) Open Platform for NFV Project, Inc. and its contributors
5 .. _connect-to-jenkins:
7 ================================================
8 Connecting OPNFV Community Labs to OPNFV Jenkins
9 ================================================
11 .. contents:: Table of Contents
17 This document describes how to connect resources (servers) located in Linux Foundation (LF) lab
18 and labs provided by the OPNFV Community to OPNFV Jenkins.
22 Connecting OPNFV Community Labs to OPNFV Jenkins (c) by Fatih Degirmenci (Ericsson AB) and others.
24 Connecting OPNFV Labs to OPNFV Jenkins document is licensed under a Creative Commons
25 Attribution 4.0 International License.
27 You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
33 +------------+-------------+------------------+---------------------------------------+
34 | **Date** | **Version** | **Author** | **Comment** |
36 +------------+-------------+------------------+---------------------------------------+
37 | 2015-05-05 | 0.1.0 | Fatih Degirmenci | First draft |
39 +------------+-------------+------------------+---------------------------------------+
40 | 2015-09-25 | 1.0.0 | Fatih Degirmenci | Instructions for the |
41 | | | | Arno SR1 release |
42 +------------+-------------+------------------+---------------------------------------+
43 | 2016-01-25 | 1.1.0 | Jun Li | Change the format for |
44 | | | | new doc toolchain |
45 +------------+-------------+------------------+---------------------------------------+
46 | 2016-01-27 | 1.2.0 | Fatih Degirmenci | Instructions for the |
47 | | | | Brahmaputra release |
48 +------------+-------------+------------------+---------------------------------------+
49 | 2016-05-25 | 1.3.0 | Julien | Add an additional step after step9 to |
50 | | | | output the correct monit config file |
51 +------------+-------------+------------------+---------------------------------------+
56 Jenkins is an extensible open source Continuous Integration (CI) server. [1]
58 Linux Foundation (LF) hosts and operates `OPNFV Jenkins <https://build.opnfv.org/ci/>`_.
63 **Slaves** are computers that are set up to build projects for a **Jenkins Master**. [2]
65 Jenkins runs a separate program called "**slave agent**" on slaves.
66 When slaves are registered to a master, the master starts distributing load to slaves by
67 scheduling jobs to run on slaves if the jobs are set to run on them. [2]
69 Term **Node** is used to refer to all machines that are part of Jenkins grid, slaves and
72 Two types of slaves are currently connected to OPNFV Jenkins and handling
73 different tasks depending on the purpose of connecting the slave.
75 * Slaves hosted in `LF Lab <https://wiki.opnfv.org/get_started/lflab_hosting#hardware_setup>`_
76 * Slaves hosted in `Community Test Labs <https://wiki.opnfv.org/pharos#community_test_labs>`_
78 The slaves connected to OPNFV Jenkins can be seen using this link:
79 https://build.opnfv.org/ci/computer/
81 Slaves without red cross next to computer icon are fully functional.
83 Connecting Slaves to OPNFV Jenkins
84 ==================================
86 The method that is normally used for connecting slaves to Jenkins requires direct SSH access to
88 [3] This is the method that is used for connecting slaves hosted in LF Lab.
90 Connecting slaves using direct SSH access can become a challenge given that OPNFV Project
91 has number of different labs provided by community as mentioned in previous section.
92 All these labs have different security requirements which can increase the effort
93 and the time needed for connecting slaves to Jenkins.
94 In order to reduce the effort and the time needed for connecting slaves and streamline the
95 process, it has been decided to connect slaves using
96 `Java Network Launch Protocol (JNLP) <https://docs.oracle.com/javase/tutorial/deployment/deploymentInDepth/jnlp.html>`_.
98 Connecting Slaves from LF Lab to OPNFV Jenkins
99 ----------------------------------------------
101 Slaves hosted in LF Lab are handled by LF. All the requests and questions regarding
102 these slaves should be submitted to `OPNFV LF Helpdesk <opnfv-helpdesk@rt.linuxfoundation.org>`_.
104 Connecting Slaves from Community Labs to OPNFV Jenkins
105 ------------------------------------------------------
107 As noted in corresponding section, slaves from Community Labs are connected using JNLP. Via JNLP,
108 slaves open connection towards Jenkins Master instead of Jenkins Master accessing to them directly.
110 Servers connecting to OPNFV Jenkins using this method must have access to internet.
112 Please follow below steps to connect a slave to OPNFV Jenkins.
114 #. Create a user named **jenkins** on the machine you want to connect to
115 OPNFV Jenkins and give the user sudo rights.
117 #. Install needed software on the machine you want to connect to OPNFV
123 #. If the slave will be used for running virtual deployments, Functest,
124 and Yardstick, install below software and make jenkins user the
125 member of the groups.
130 #. Create slave root in Jenkins user home directory.
132 ``mkdir -p /home/jenkins/opnfv/slave_root``
134 5. Clone OPNFV Releng Git repository.
138 mkdir -p /home/jenkins/opnfv/repos
139 cd /home/jenkins/opnfv/repos
140 git clone https://gerrit.opnfv.org/gerrit/p/releng.git
142 #. Contact LF by creating a ticket to `Connect my 3rd party CI/Lab
143 <https://jira.linuxfoundation.org/servicedesk/customer/portal/2/create/135>`_
144 Include the following information in your ticket.
146 - Slave root (/home/jenkins/opnfv/slave_root)
147 - Public IP of the slave (You can get the IP by executing ``curl http://icanhazip.com/``)
148 - PGP Key (attached to the mail or exported to a key server)
150 #. Once you get confirmation from LF stating that your slave is created
151 on OPNFV Jenkins, check if the firewall on LF is open for the server
152 you are trying to connect to Jenkins.
156 cp /home/jenkins/opnfv/repos/releng/utils/jenkins-jnlp-connect.sh /home/jenkins/
158 sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave name on OPNFV Jenkins> -s <the token you received from LF> -f
160 - If you receive an error, follow the steps listed on the command output.
162 #. Run the same script with test(-t) on foreground in order to make sure
163 no problem on connection. You should see **INFO: Connected** in the
166 ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave name on OPNFV Jenkins> -s <the token you received from LF> -t``
168 - If you receive an error similar to the one shown `on this link
169 <http://hastebin.com/ozadagirax.avrasm>`_, you need to check your
170 firewall and allow outgoing connections for the port.
172 #. Kill the Java slave.jar process.
174 #. Run the same script normally without test(-t) in order to get monit
177 ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave name on OPNFV Jenkins> -s <the token you received from LF>``
179 #. Edit monit configuration and enable http interface. The file to edit
180 is /etc/monit/monitrc on Ubuntu systems. Uncomment below lines.
184 set httpd port 2812 and
185 use address localhost # only accept connection from localhost
186 allow localhost # allow localhost to connect to the server and
188 #. Restart monit service.
192 ``sudo service monit restart``
194 - With systemd: you have to enable monit service first and then restart it.
198 sudo systemctl enable monit
199 sudo systemctl restart monit
201 #. Check to see if jenkins comes up as managed service in monit.
203 ``sudo monit status``
205 #. Connect slave to OPNFV Jenkins using monit.
207 ``sudo monit start jenkins``
209 #. Check slave on OPNFV Jenkins to verify the slave is reported as connected.
211 - The slave on OPNFV Jenkins should have some executors in “Idle”
212 state if the connection is successful.
220 Public PGP Key can be uploaded to public key server so it can be taken from
221 there using your mail address. Example command to upload the key to key server is
223 ``gpg --keyserver hkp://keys.gnupg.net:80 --send-keys XXXXXXX``
225 The Public PGP Key can also be attached to the email by storing the key in a file and then
226 attaching it to the email.
228 ``gpg --export -a '<your email address>' > pgp.pubkey``
233 * `What is Jenkins <https://wiki.jenkins-ci.org/display/JENKINS/Meet+Jenkins>`_
234 * `Jenkins Terminology <https://wiki.jenkins-ci.org/display/JENKINS/Terminology>`_
235 * `Jenkins SSH Slaves Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin>`_