docs/infra/jenkins/connect-to-jenkins.rst

   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
   4
   5 .. _connect-to-jenkins:
   6
   7 ================================================
   8 Connecting OPNFV Community Labs to OPNFV Jenkins
   9 ================================================
  10
  11 .. contents:: Table of Contents
  12    :backlinks: none
  13
  14 Abstract
  15 ========
  16
  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.
  19
  20 License
  21 =======
  22 Connecting OPNFV Community Labs to OPNFV Jenkins (c) by Fatih Degirmenci (Ericsson AB) and others.
  23
  24 Connecting OPNFV Labs to OPNFV Jenkins document is licensed under a Creative Commons
  25 Attribution 4.0 International License.
  26
  27 You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
  28
  29
  30 Version History
  31 ===============
  32
  33 +------------+-------------+------------------+---------------------------------------+
  34 | **Date**   | **Version** | **Author**       | **Comment**                           |
  35 |            |             |                  |                                       |
  36 +------------+-------------+------------------+---------------------------------------+
  37 | 2015-05-05 | 0.1.0       | Fatih Degirmenci | First draft                           |
  38 |            |             |                  |                                       |
  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 +------------+-------------+------------------+---------------------------------------+
  52
  53 Jenkins
  54 =======
  55
  56 Jenkins is an extensible open source Continuous Integration (CI) server. [1]
  57
  58 Linux Foundation (LF) hosts and operates `OPNFV Jenkins <https://build.opnfv.org/ci/>`_.
  59
  60 Jenkins Slaves
  61 ==============
  62
  63 **Slaves** are computers that are set up to build projects for a **Jenkins Master**.  [2]
  64
  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]
  68
  69 Term **Node** is used to refer to all machines that are part of Jenkins grid, slaves and
  70 master. [2]
  71
  72 Two types of slaves are currently connected to OPNFV Jenkins and handling
  73 different tasks depending on the purpose of connecting the slave.
  74
  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>`_
  77
  78 The slaves connected to OPNFV Jenkins can be seen using this link:
  79 https://build.opnfv.org/ci/computer/
  80
  81 Slaves without red cross next to computer icon are fully functional.
  82
  83 Connecting Slaves to OPNFV Jenkins
  84 ==================================
  85
  86 The method that is normally used for connecting slaves to Jenkins requires direct SSH access to
  87 servers.
  88 [3] This is the method that is used for connecting slaves hosted in LF Lab.
  89
  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>`_.
  97
  98 Connecting Slaves from LF Lab to OPNFV Jenkins
  99 ----------------------------------------------
 100
 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>`_.
 103
 104 Connecting Slaves from Community Labs to OPNFV Jenkins
 105 ------------------------------------------------------
 106
 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.
 109
 110 Servers connecting to OPNFV Jenkins using this method must have access to internet.
 111
 112 Please follow below steps to connect a slave to OPNFV Jenkins.
 113
 114   1. Create a user named **jenkins** on the machine you want to connect to OPNFV Jenkins and give the user sudo rights.
 115   2. Install needed software on the machine you want to connect to OPNFV Jenkins as slave.
 116     - openjdk 8
 117     - monit
 118   3. If the slave will be used for running virtual deployments, Functest, and Yardstick, install below software and make jenkins user the member of the groups.
 119     - docker
 120     - libvirt
 121   4. Create slave root in Jenkins user home directory.
 122     ``mkdir -p /home/jenkins/opnfv/slave_root``
 123   5. Clone OPNFV Releng Git repository.
 124     ``mkdir -p /home/jenkins/opnfv/repos``
 125
 126     ``cd /home/jenkins/opnfv/repos``
 127
 128     ``git clone https://gerrit.opnfv.org/gerrit/p/releng.git``
 129   6. Contact LF by sending mail to `OPNFV LF Helpdesk <opnfv-helpdesk@rt.linuxfoundation.org>`_ and request creation of a slave on OPNFV Jenkins. Include below information in your mail.
 130     - Slave root (/home/jenkins/opnfv/slave_root)
 131     - Public IP of the slave (You can get the IP by executing ``curl http://icanhazip.com/``)
 132     - PGP Key (attached to the mail or exported to a key server)
 133   7. Once you get confirmation from LF stating that your slave is created on OPNFV Jenkins, check if the firewall on LF is open for the server you are trying to connect to Jenkins.
 134     ``cp /home/jenkins/opnfv/repos/releng/utils/jenkins-jnlp-connect.sh /home/jenkins/``
 135     ``cd /home/jenkins/``
 136     ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n  <slave name on OPNFV Jenkins> -s <the token you received from LF> -f``
 137
 138      - If you receive an error, follow the steps listed on the command output.
 139   8. Run the same script with test(-t) on foreground in order to make sure no problem on connection. You should see **INFO: Connected** in the console log.
 140     ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave name on OPNFV Jenkins> -s <the token you received from LF> -t``
 141
 142      - If you receive an error similar to the one shown `on this link <http://hastebin.com/ozadagirax.avrasm>`_, you need to check your firewall and allow outgoing connections for the port.
 143   9. Kill the Java slave.jar process.
 144   10. Run the same script normally without test(-t) in order to get monit script created.
 145     ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave name on OPNFV Jenkins> -s <the token you received from LF>``
 146   11. Edit monit configuration and enable http interface. The file to edit is /etc/monit/monitrc on Ubuntu systems. Uncomment below lines.
 147     set httpd port 2812 and
 148         use address localhost  # only accept connection from localhost
 149         allow localhost        # allow localhost to connect to the server and
 150   12. Restart monit service.
 151     - Without systemd:
 152
 153       ``sudo service monit restart``
 154     - With systemd: you have to enable monit service first and then restart it.
 155
 156       ``sudo systemctl enable monit``
 157
 158       ``sudo systemctl restart monit``
 159   13. Check to see if jenkins comes up as managed service in monit.
 160     ``sudo monit status``
 161   14. Connect slave to OPNFV Jenkins using monit.
 162     ``sudo monit start jenkins``
 163   15. Check slave on OPNFV Jenkins to verify the slave is reported as connected.
 164     - The slave on OPNFV Jenkins should have some executors in “Idle” state if the connection is successful.
 165
 166 Notes
 167 ==========
 168
 169 PGP Key Instructions
 170 --------------------
 171
 172 Public PGP Key can be uploaded to public key server so it can be taken from
 173 there using your mail address. Example command to upload the key to key server is
 174
 175     ``gpg --keyserver hkp://keys.gnupg.net:80  --send-keys XXXXXXX``
 176
 177 The Public PGP Key can also be attached to the email by storing the key in a file and then
 178 attaching it to the email.
 179
 180     ``gpg --export -a '<your email address>' > pgp.pubkey``
 181
 182 References
 183 ==========
 184
 185 * `What is Jenkins <https://wiki.jenkins-ci.org/display/JENKINS/Meet+Jenkins>`_
 186 * `Jenkins Terminology <https://wiki.jenkins-ci.org/display/JENKINS/Terminology>`_
 187 * `Jenkins SSH Slaves Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin>`_