Versions Compared

Old Version 6

changes.mady.by.user Eric Ball

Saved on

compared with

New Version 7

changes.mady.by.user Eric Ball

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replace "slave" with current term "agent"

Jenkins

...

Agents

Slaves Agents are computers that are set up to build projects for a Jenkins Master. 

Jenkins runs a separate agent program called “slave agent” on slaveson build nodes. When slaves agents are registered to a master, the master starts distributing load to slaves agents by scheduling jobs to run on slaves agents if the jobs are set to run on them. 

Term Node is used to refer to all machines that are part of Jenkins grid, slaves agents and master. 

Two types of slaves agents are currently connected to Akraino Jenkins and handling different tasks depending on the purpose of connecting the slaveagent.

  • Slaves Agents hosted in Community Lab.
  • Slaves Agents hosted in Validation Lab.

Slaves Agents without red cross next to computer icon are fully functional.

Connecting

...

Agents to Akraino Jenkins

The method that is normally used for connecting slaves agents to Jenkins requires direct SSH access to servers. This is the method that is used for connecting slaves agents hosted in LF Lab.

Connecting slaves agents using direct SSH access can become a challenge given that Akraino has number of different Validation labs provided by community as mentioned in previous section. All these labs have different security requirements which can increase the effort and the time needed for connecting slaves agents to Jenkins. In order to reduce the effort and the time needed for connecting slaves agents and streamline the process, it has been decided to connect slaves agents using Java Network Launch Protocol (JNLP).

Connecting

...

Agents from LF Lab to Akraino Jenkins

Slaves Agents hosted in LF handled by LF. All the requests and questions regarding these slaves agents should be submitted to Jira Support Desk.

Connecting

...

Agents from Community Labs to Akraino Jenkins

As noted in corresponding section, slaves agents from Community Lab are connected using JNLP. Via JNLP, slaves agents open connection towards Jenkins Master instead of Jenkins Master accessing to them directly.

...

Please follow below steps to connect a slave an agent to Akraino Jenkins.

  1. Create a user named Jenkins on the machine you want to connect to Akraino Jenkins and give the user sudo rights.
  2. Install needed software on the machine you want to connect to Akraino Jenkins as slavean agent.
    1. openjdk 8
    2. monit
  3. If the slave agent will be used for running virtual deployments, Functest, and Yardstick, install below software and make Jenkins user the member of the groups.
    1. docker
    2. libvirt

  4.  Create slave agent root in Jenkins user home directory.

    Code Block
    languagebash
    mkdir -p /home/jenkins/akraino/slaveagent_root


  5. Clone Akraino ci-management repository.

    Code Block
    languagebash
    mkdir -p /home/jenkins/akraino/repos
cd /home/jenkins/akraino/repos
git clone https://gerrit.akraino.org/r/ci-management


  6. Contact LF by submitting a ticket to the LF Support Desk and request creation of a slave an agent on Akraino Jenkins. Include below information in your mail.

    1. Slave Remote root directory (/home/jenkins/akraino/slaveagent_root)

    2. Number of executors (the number of concurrent jobs to allow on the slaveagent).
    3. Label(s). The label(s) define what jobs can be run on a particular slaveagent. Each job should have a slavebuild-label defined node defined in its JJB definition.
    4. A slave An agent name. This has generally followed the convention of "<OS>-dev-<CPUs>c-<RAM>g", though this is not a strict rule. The important thing is that the name is a unique and useful identifier. Other elements, such as "prd" or "snd" to identify the environment or numbering at the end, will be added by LF.
  7. You will receive a confirmation from LF containing the complete slave agent name and a secret token.

  8. Run the following script in order to make sure there is no problem connecting. You should see INFO: Connected in the console log.

    Code Block
    languagebash
    cp /home/jenkins/akraino/repos/ci-management/utils/jenkins-jnlp-connect.sh /home/jenkins/
cd /home/jenkins
sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave<agent name on Akraino Jenkins> -s <the token you received from LF> -t


    1. If you receive a connectivity error, then you need to check your firewall and allow outgoing connections for the port.

  9. Kill the Java slaveagent.jar process.

  10. Run the same script normally without test (-t) in order to get monit script created.

    Code Block
    languagebash
    sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n <slave<agent name on Akraino Jenkins> -s <the token you received from LF>


  11. Edit monit configuration and enable http interface. The file to edit is /etc/monit/monitrc on Ubuntu systems. Uncomment below lines.

    Code Block
    # set httpd port 2812 and
#     use address localhost  # only accept connection from localhost
#     allow localhost        # allow localhost to connect to the server and


  12. Restart monit service.

    1. Without systemd:
      sudo service monit restart

    2. With systemd: you have to enable monit service first and then restart it.
      sudo systemctl enable monit
      sudo systemctl restart monit

  13. Check to see if Jenkins comes up as managed service in monit.
    sudo monit status

  14. Connect slave agent to Akraino Jenkins using monit.
    sudo monit start jenkins

  15. Check slave agent on Akraino Jenkins to verify the slave agent is reported as connected. The slave agent on Akraino Jenkins should have some executors in “Idle” state if the connection is successful.