Difference between revisions of "Localyzer Jenkins Plugins"
(→Setup Environment Variables) |
(→Next Step) |
||
| (15 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == Install Jenkins== |
||
| − | |||
| − | Download Jenkins from [https://jenkins-ci.org/ jenkins-ci.org], install it, and run it. Must be <b>version 1.609</b> or later. |
||
| − | Otherwise, the location of the 'workspace' may vary, causing real problems! Jobs created by this version <b>must</b> have the workspace located under <b>$JENKINS_HOME/jobs/$JOBNAME/workspace</b>. |
||
== Set up Jenkins Plugins== |
== Set up Jenkins Plugins== |
||
| − | You |
+ | You setup the plugins used by LRM by installing the plugins from the Jenkins interface. |
| − | * Run the setup script using jenkins-cli.jar at the command line |
||
| − | * Install the plugins from the Jenkins interface |
||
| − | |||
| − | Both ways are fine, use either. |
||
| − | |||
| − | === Execute <code>install-lingoport-plugins.sh </code> === |
||
| − | This way to setup involves downloading the <code>jenkins-cli.jar</code> file, setting some variables, and running the script. |
||
| − | (Note: this is available in LRM 2.2) |
||
| − | |||
| − | ==== Download <code>jenkins-cli.jar</code> ==== |
||
| − | * Navigate to your Jenkins URL followed by cli, for example <code>http://localhost:8080/cli</code> |
||
| − | * Click on the download link and copy the downloaded jenkins-cli.jar to a location you have access to |
||
| − | * Click on the Login command: An example is given on how to login Jenkins using jenkins-cli.jar. This will be useful soon. |
||
| − | ==== Setup Environment Variables ==== |
||
| − | Two global variables need to be setup: |
||
| − | * Set JENKINS_CLI to the absolute location of the downloaded jenkins-cli.jar file, for example <code>export JENKINS_CLI=/home/jenkins/jenkins-cli.jar</code> |
||
| − | * Set JENKINS_URL to the URL for Jenkins, for example <code>export JENKINS_URL=http://locahost:8080/</code> |
||
| − | |||
| − | ==== Login using <code>jenkins-cli.jar</code> ==== |
||
| − | The login command example you saw above should help you login with an account with administrative privileges. It should look like: |
||
| − | <code>java -jar $JENKINS_CLI -s $JENKINS_URL login --username admin --password adminPassword</code> |
||
| − | ==== Execute the <code>install-lingoport-plugins.sh </code> ==== |
||
| − | Go to the directory where the script is located and execute the script. For example: |
||
| − | * <code>cd /home/jenkins/lingoport/lrm-server-2.2/jenkins/plugins </code> |
||
| − | * <code>./install-lingoport-plugins.sh</code> |
||
| − | ==== Restart Jenkins ==== |
||
| − | You may be able to do so with a browser URL such as <code>http://localhost:8080/restart</code> |
||
| − | ==== Verify the Plugins are Installed ==== |
||
| − | * Navigate to the Jenkins URL for plugins, such as <code>http://localhost:8080/pluginManager/installed</code> |
||
| − | === |
+ | === The Jenkins interface === |
| − | If executing the script does not work for you, an alternative is to setup all the plugins via the Jenkins interface. |
||
The following Jenkins plugins are required. To see what plugins are installed, go to '''Jenkins -> Manage Jenkins -> Manage Plugins''' and select the '''Installed''' tab. |
The following Jenkins plugins are required. To see what plugins are installed, go to '''Jenkins -> Manage Jenkins -> Manage Plugins''' and select the '''Installed''' tab. |
||
| Line 50: | Line 16: | ||
* [https://wiki.jenkins-ci.org/display/JENKINS/Github+Plugin GitHub Plugin] |
* [https://wiki.jenkins-ci.org/display/JENKINS/Github+Plugin GitHub Plugin] |
||
| − | * [https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Authorization+Strategy+ |
+ | * [https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Authorization+Strategy+Plugin Matrix Authorization Strategy Plugin] (Or another authentication/authorization plugin) |
* [https://wiki.jenkins-ci.org/display/JENKINS/Throttle+Concurrent+Builds+Plugin Throttle Concurrent Builds Plugin] |
* [https://wiki.jenkins-ci.org/display/JENKINS/Throttle+Concurrent+Builds+Plugin Throttle Concurrent Builds Plugin] |
||
* [https://wiki.jenkins-ci.org/display/JENKINS/Build+User+Vars+Plugin Build User Vars Plugin] |
* [https://wiki.jenkins-ci.org/display/JENKINS/Build+User+Vars+Plugin Build User Vars Plugin] |
||
| + | ** Select ''Set Jenkins user build variables'' when configuring the jenkins job |
||
* [https://wiki.jenkins-ci.org/display/JENKINS/Discard+Old+Build+plugin Discard Old Build Plugin] |
* [https://wiki.jenkins-ci.org/display/JENKINS/Discard+Old+Build+plugin Discard Old Build Plugin] |
||
== Throttle == |
== Throttle == |
||
| − | Go to |
+ | Go to '''Jenkins -> Manage Jenkins -> Configure System''' and under the '''Throttle Concurrent Builds''', add a category (MAIN for instance) with 1 Maximum Total Concurrent Builds and 1 Maximum Concurrent Builds Per Node. |
| − | Every Jenkins job MUST have this throttle setup. |
+ | Every Jenkins job MUST have this throttle setup. |
==Note== |
==Note== |
||
| Line 73: | Line 40: | ||
2) Make sure security is set. The typical one is first set under Configure Global Security in Manage Jenkins for 'Matrix Security' and 'Using Jenkins Own Database'. |
2) Make sure security is set. The typical one is first set under Configure Global Security in Manage Jenkins for 'Matrix Security' and 'Using Jenkins Own Database'. |
||
Once this is set (as opposed to anonymous everything), one can then use the Build Authorization Token Root in the lingotekcall job: Set the Token to 'LINGOSQUARE' |
Once this is set (as opposed to anonymous everything), one can then use the Build Authorization Token Root in the lingotekcall job: Set the Token to 'LINGOSQUARE' |
||
| + | |||
| + | == Next Step == |
||
| + | [[Localyzer Jenkins Jobs]] |
||
Latest revision as of 15:21, 30 November 2021
Set up Jenkins Plugins
You setup the plugins used by LRM by installing the plugins from the Jenkins interface.
The Jenkins interface
The following Jenkins plugins are required. To see what plugins are installed, go to Jenkins -> Manage Jenkins -> Manage Plugins and select the Installed tab.
- Matrix Authorization Strategy Plugin (Or another authentication/authorization plugin)
- Build User Vars Plugin
- Select Set Jenkins user build variables when configuring the jenkins job
Throttle
Go to Jenkins -> Manage Jenkins -> Configure System and under the Throttle Concurrent Builds, add a category (MAIN for instance) with 1 Maximum Total Concurrent Builds and 1 Maximum Concurrent Builds Per Node.
Every Jenkins job MUST have this throttle setup.
Note
A quick note for the relationship between the TOKEN necessary for the lingotekcall back and security:
1) The plugin is Build Authorization Token Root Plugin, https://wiki.jenkins-ci.org/display/JENKINS/Build+Token+Root+Plugin It must be installed. However, if no security is set, jobs cannot be triggered remotely using a TOKEN!!! So ...
2) Make sure security is set. The typical one is first set under Configure Global Security in Manage Jenkins for 'Matrix Security' and 'Using Jenkins Own Database'. Once this is set (as opposed to anonymous everything), one can then use the Build Authorization Token Root in the lingotekcall job: Set the Token to 'LINGOSQUARE'
