Difference between revisions of "Localyzer Jenkins Configure System"
(→Environment Variables) |
(→Next Step) |
||
| (32 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | This section assumes that the Jenkins home directory is '''/home/jenkins'''. On some systems, the Jenkins home directory is set to '''/var/lib/jenkins''' instead. Verify your home directory to follow the instructions below. For generality, '''<HOME>''' will be used in place of the actual directory. |
|
| − | |||
| − | To set the environment variables, select '''Jenkins''' and '''Manage Jenkins''' on the left. From there, select '''Configure System'''. On the configuration page, scroll down to the '''Global properties''' section and select '''Environmental variables'''. The following are the name value pairs to add. For example, DASHBOARD_HOME is the name and its value is /home/jenkins/lingoport/dashboard-client-2.0. |
||
== Environment Variables == |
== Environment Variables == |
||
| + | To set the environment variables, select '''Jenkins''' and '''Manage Jenkins''' on the left. From there, select '''Configure System'''. On the configuration page, scroll down to the '''Global properties''' section and select '''Environmental variables'''. |
||
| − | Go to Configure (Configure System) and set the following environment variables: |
||
| − | * LRM_HOME (e.g.: /home/jenkins/lingoport/lrm-server-2.0) |
||
| − | * DASHBOARD_HOME (e.g.: /home/jenkins/lingoport/dashboard-client-2.0) |
||
| − | * DASHBOARD_URL (e.g.: http://10.1.10.xxx:9090) |
||
| + | The following are the name value pairs to add: |
||
| − | == Throttle == |
||
| + | * '''LRM_HOME''' (e.g.: <HOME>/lingoport/lrm-server-x.x) |
||
| − | Go to Configure (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. |
||
| + | * '''DASHBOARD_HOME''' (e.g.: <HOME>/lingoport/dashboard-client-x.x) |
||
| + | If you are using '''TFS''', add the TFS command line executable location to the PATH: |
||
| − | Every Jenkins job MUST have this throttle setup. |
||
| + | * '''$PATH''' (e.g.: PATH:/home/jenkins/team_foundation_server/TEE-CLC-12.0.2/ ) |
||
| + | |||
| + | == Rebasing == |
||
| + | |||
| + | If you are using '''Git''', rebasing is used to keep the branch of an LRM project with a specified branch, such as master. To do so, an LRM project '''config_vcs.properties''' file must end up with the following property: |
||
| + | |||
| + | VCS_GIT_REBASE_BRANCH=master |
||
| + | |||
| + | |||
| + | * '''If the LRM plugin is used,''' the <code>config_vcs.properties</code> gets overwritten. Add at the same location a file called '''<code>config_vcs.properties_rebase</code>''' with the above line in it, it will be '''appended''' to the <code>config_vcs.properties</code> files |
||
| + | |||
| + | |||
| + | * If using a special script, the <code>config_vcs.properties</code> may persist from one invocation to another. In that case, simply add the <code>VCS_GIT_REBASE_BRANCH=master</code> line at the end of the <code>config_vcs.properties</code> file. |
||
== Configure Global Security == |
== Configure Global Security == |
||
| − | The minimal configuration would be to setup |
+ | The minimal configuration would be to setup the configuration with: |
| + | * Jenkins' own user database and |
||
| − | * anonymous have a set of very few privileges, if any, signed, |
||
| + | * a matrix based security, |
||
| + | |||
| + | with the following privileges: |
||
| + | * anonymous have a set of very few privileges, if any. |
||
* 'authenticated' the ability to run builds, and |
* 'authenticated' the ability to run builds, and |
||
* a few administration accounts with all privileges |
* a few administration accounts with all privileges |
||
| + | |||
| + | Note: If you want to continue the configuration using scripts, you need to allow the Job/Read permission on anonymous users. |
||
| + | |||
| + | == Next Step == |
||
| + | [[Localyzer Jenkins Plugins]] |
||
Latest revision as of 15:22, 30 November 2021
This section assumes that the Jenkins home directory is /home/jenkins. On some systems, the Jenkins home directory is set to /var/lib/jenkins instead. Verify your home directory to follow the instructions below. For generality, <HOME> will be used in place of the actual directory.
Environment Variables
To set the environment variables, select Jenkins and Manage Jenkins on the left. From there, select Configure System. On the configuration page, scroll down to the Global properties section and select Environmental variables.
The following are the name value pairs to add:
- LRM_HOME (e.g.: <HOME>/lingoport/lrm-server-x.x)
- DASHBOARD_HOME (e.g.: <HOME>/lingoport/dashboard-client-x.x)
If you are using TFS, add the TFS command line executable location to the PATH:
- $PATH (e.g.: PATH:/home/jenkins/team_foundation_server/TEE-CLC-12.0.2/ )
Rebasing
If you are using Git, rebasing is used to keep the branch of an LRM project with a specified branch, such as master. To do so, an LRM project config_vcs.properties file must end up with the following property:
VCS_GIT_REBASE_BRANCH=master
- If the LRM plugin is used, the
config_vcs.propertiesgets overwritten. Add at the same location a file calledconfig_vcs.properties_rebasewith the above line in it, it will be appended to theconfig_vcs.propertiesfiles
- If using a special script, the
config_vcs.propertiesmay persist from one invocation to another. In that case, simply add theVCS_GIT_REBASE_BRANCH=masterline at the end of theconfig_vcs.propertiesfile.
Configure Global Security
The minimal configuration would be to setup the configuration with:
- Jenkins' own user database and
- a matrix based security,
with the following privileges:
- anonymous have a set of very few privileges, if any.
- 'authenticated' the ability to run builds, and
- a few administration accounts with all privileges
Note: If you want to continue the configuration using scripts, you need to allow the Job/Read permission on anonymous users.
