From 10ed113d9e0581a9e9b5afddd1a3b924e6b81e2d Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Mon, 23 Apr 2018 13:23:44 -0700 Subject: [PATCH] Fix docs build errors This fixes the two error types being output by a Sphinx docs build: - numbered - This is already included in the root toctree (docs/index.rst) and doesn't need to be repeated - List spacing - Only in infra/jenkins/connect-to-jenkins.rst, the enumerated list of steps was missing spaces after each item Change-Id: I55555821a35a3d248f3a347e8e4d9c851254cf08 Signed-off-by: Trevor Bramwell --- docs/ci/index.rst | 1 - docs/infra/index.rst | 2 +- docs/infra/jenkins/connect-to-jenkins.rst | 26 ++++++++++++++++++++++++++ docs/release/index.rst | 1 - 4 files changed, 27 insertions(+), 3 deletions(-) diff --git a/docs/ci/index.rst b/docs/ci/index.rst index da6fc7de1..08f23ac2f 100644 --- a/docs/ci/index.rst +++ b/docs/ci/index.rst @@ -11,7 +11,6 @@ OPNFV CI TBD .. toctree:: - :numbered: :maxdepth: 2 user-guide diff --git a/docs/infra/index.rst b/docs/infra/index.rst index 50c971e75..248e8230c 100644 --- a/docs/infra/index.rst +++ b/docs/infra/index.rst @@ -70,7 +70,7 @@ Issue and Bug Tracking JIRA .. toctree:: - :maxdepth: + :maxdepth: 1 jira/user-guide diff --git a/docs/infra/jenkins/connect-to-jenkins.rst b/docs/infra/jenkins/connect-to-jenkins.rst index e83cadada..ddf345fa3 100644 --- a/docs/infra/jenkins/connect-to-jenkins.rst +++ b/docs/infra/jenkins/connect-to-jenkins.rst @@ -113,54 +113,80 @@ Please follow below steps to connect a slave to OPNFV Jenkins. 1. Create a user named **jenkins** on the machine you want to connect to OPNFV Jenkins and give the user sudo rights. 2. Install needed software on the machine you want to connect to OPNFV Jenkins as slave. + - openjdk 8 - monit + 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. + - docker - libvirt + 4. Create slave root in Jenkins user home directory. + ``mkdir -p /home/jenkins/opnfv/slave_root`` + 5. Clone OPNFV Releng Git repository. + ``mkdir -p /home/jenkins/opnfv/repos`` ``cd /home/jenkins/opnfv/repos`` ``git clone https://gerrit.opnfv.org/gerrit/p/releng.git`` + 6. Contact LF by sending mail to `OPNFV LF Helpdesk `_ and request creation of a slave on OPNFV Jenkins. Include below information in your mail. + - Slave root (/home/jenkins/opnfv/slave_root) - Public IP of the slave (You can get the IP by executing ``curl http://icanhazip.com/``) - PGP Key (attached to the mail or exported to a key server) + 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. + ``cp /home/jenkins/opnfv/repos/releng/utils/jenkins-jnlp-connect.sh /home/jenkins/`` ``cd /home/jenkins/`` ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n -s -f`` - If you receive an error, follow the steps listed on the command output. + 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. + ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n -s -t`` - If you receive an error similar to the one shown `on this link `_, you need to check your firewall and allow outgoing connections for the port. + 9. Kill the Java slave.jar process. 10. Run the same script normally without test(-t) in order to get monit script created. + ``sudo ./jenkins-jnlp-connect.sh -j /home/jenkins -u jenkins -n -s `` + 11. Edit monit configuration and enable http interface. The file to edit is /etc/monit/monitrc on Ubuntu systems. Uncomment below lines. + 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. + - Without systemd: ``sudo service monit restart`` + - 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 to OPNFV Jenkins using monit. + ``sudo monit start jenkins`` + 15. Check slave on OPNFV Jenkins to verify the slave is reported as connected. + - The slave on OPNFV Jenkins should have some executors in “Idle” state if the connection is successful. Notes diff --git a/docs/release/index.rst b/docs/release/index.rst index 49cd00bdb..e814bec02 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -9,7 +9,6 @@ Releasing OPNFV =============== .. toctree:: - :numbered: :maxdepth: 2 release-process -- 2.16.6