Skip to content
This repository was archived by the owner on Nov 4, 2024. It is now read-only.

Commit ec9a41a

Browse files
tszczyptszczyp
committed
Common Jenkins libs and scripts
Adding scripts and libraries from pmem/pmemkv Modified directories and files structure, updated README, updated scripts. Signed-off-by: Tomasz Szczypiorowski <[email protected]>
1 parent a8a1087 commit ec9a41a

File tree

7 files changed

+950
-1
lines changed

7 files changed

+950
-1
lines changed

‎LICENSE

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
SPDX-License-Identifier: BSD-3-Clause
2+
Copyright 2021, Intel Corporation
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions
6+
are met:
7+
8+
* Redistributions of source code must retain the above copyright
9+
notice, this list of conditions and the following disclaimer.
10+
11+
* Redistributions in binary form must reproduce the above copyright
12+
notice, this list of conditions and the following disclaimer in
13+
the documentation and/or other materials provided with the
14+
distribution.
15+
16+
* Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived
18+
from this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31+

‎README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
# dev-utils-kit
1+
# dev-utils-kit
2+
3+
## Overview
4+
The content of this repository consists of scripts and functions meant to be used within other repositories.
5+
Currently, you can use the following functionalities:
6+
- Jenkins's shared scripts and functions
7+

‎jenkins/README.md

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Jenkins shared functions and scripts
2+
3+
## Overview
4+
This directory contains shared functions and scripts meant to be used with jenkins pipelines. Jenkinsfile and pipeline are required beforehand to start a job.
5+
6+
## Jenkins Configuration
7+
8+
### Overview
9+
Jenkins is a self-contained, open sourced automation server that can automate tasks related to building and testing. Its functionality can be expanded by installing plugins.
10+
11+
Jenkins main function is to launch jobs. Jobs are scripts that cover managing repositories, building and testing. Jenkins pipeline is a script that is launched by Jenkins job. Each pipeline consists of build stages that follow one another, for example: download repository, build, test, etc. Each stage consists of steps that are actual commands ran on device under a test - which is called: Node.
12+
13+
## Quick access to Jenkins
14+
To gain access to a working Jenkins instance quickly, use the links provided below and follow instructions contained therein:
15+
- https://hub.docker.com/r/jenkins/jenkins
16+
- https://github.com/jenkinsci/docker/blob/master/README.md
17+
18+
## Requirements
19+
To run tests it is required to install these plugins first:
20+
- Branch API
21+
- Command Agent Launcher
22+
- Configuration as Code
23+
- Email Extension
24+
- External Monitor Job Type
25+
- Folders
26+
- Git
27+
- Git client
28+
- GitLab
29+
- Job DSL
30+
- Multijob
31+
- Oracle Java SE Development Kit Installer
32+
- PAM Authentication
33+
- Pipeline Utility Steps
34+
- Pipeline: Build Step
35+
- Pipeline: Multibranch
36+
- Pipeline: REST API
37+
- Pipeline: Stage View
38+
- SSH Agent
39+
- SSH Build Agents
40+
41+
Optional but recommended plugins for graphical and security improvements:
42+
- Blue Ocean
43+
- Dashboard View
44+
- JUnit
45+
- LDAP
46+
- Matrix Authorization Strategy
47+
- Matrix Combinations
48+
- OWASP Markup Formatter
49+
- Timestamper
50+
51+
## Managing Jenkins
52+
53+
### Overview
54+
Jenkins can be configured and managed "as a code" - it means that actual jobs and pipelines can be downloaded from a remote repository. But first, it is needed to add a job that downloads jobs definitions from the remote repository and configures Jenkins. The instructions below allow to manually trigger creating/updating jobs, but it is possible to trigger this job automatically with each push to the target repository.
55+
56+
### Add master executor
57+
Before running any job, it is needed to add an executor which will run a Jenkins job. First, it is required to add an executor on the master node - which is a server containing the Jenkins instance. This executor will lunch the job and then the pipeline will be executed on the node with a label matching the "LABEL" field in the job params.
58+
59+
To add master executor:
60+
61+
- Select: "Manage Jenkins".
62+
- Select: "Manage Nodes and Clouds".
63+
- Select: "master" node.
64+
- Select: "Configure".
65+
- In the field "# of executors" type "4".
66+
- Select: "Save".
67+
68+
### Add job-generating jobs
69+
To add a Job that generates jobs from Jenkinsfile:
70+
71+
- Select: "New item".
72+
- Enter jobs name, e.g. "job_creator".
73+
- Select: "Pipeline".
74+
- Click OK.
75+
- In tab "General", select "GitHUB Project", enter project url, e.g.: "https://github.com/pmem/pmemkv".
76+
- In the "Pipeline" tab, set fields as below:
77+
- Definition: Pipeline script from SCM
78+
- SCM: Git
79+
- Repositories:
80+
- Repository URL: Enter github repository with jenkins job, e.g.: "https://github.com/pmem/pmemkv".
81+
- Credentials: none
82+
- Branches to build:
83+
- Branch Specifier (blank for 'any'): master (or any other branch containing jenkinsfile).
84+
- Script Path: Enter path with the Jenkinsfile, relative to the root folder of the repository: "utils/jenkins/Jenkinsfile"
85+
- Lightweight checkout: yes
86+
- Save.
87+
- Enter the newly created job from the main dashboard.
88+
- Click on the "Build Now".
89+
90+
### In-process Script Approval
91+
By default, Jenkins will prevent running new groovy scripts which will cause our job to fail. After each fail caused by an unapproved script, it is needed to accept this script. Unfortunately, this will be necessary to repeat several times, by launching this job repeatedly (when running the job for the first time).
92+
93+
To approve scripts:
94+
95+
- Select: "Manage Jenkins".
96+
- Select: "In-process Script Approval".
97+
- Click "Approve".
98+
99+
### Test nodes
100+
To run Jenkins jobs, it will be needed to add additional Nodes (beside of master Node) which are servers prepared to run tests. Each Node is required to have:
101+
102+
- Installed Java Runtime Environment.
103+
- Installed and running an SSH server, open ssh port (22).
104+
- The added user that Jenkins can log on, with appropriate credentials needed to run tests, e.g. "test-user".
105+
106+
#### Adding test nodes
107+
In this case, we will be using a server with Fedora31 installed and user "test-user" created.
108+
109+
- Select: "Manage Jenkins".
110+
- Select: "Manage Nodes and Clouds".
111+
- Select: "New Node".
112+
- Type name in the "Node name" field, "Server_001(fedora31)".
113+
- Select "Permanent Agent" (after creating a node, it is possible to copy an existing configuration by selecting "Copy Existing Node").
114+
- Click "OK".
115+
- In the field "# of executors" type "1".
116+
- In the field "Remote root directory" type directory that Jenkins user has credentials to access to. In our case: /home/test-user
117+
- In the field "Labels" type an actual OS installed on the server - in our case type "fedora fedora31" NOTE: There can be multiple labels assigned to the server.
118+
- In the field "Usage" select "Use this node as much as possible".
119+
- In the field "Launch method" select "Launch agent agents via SSH".
120+
- In the field "Host" type IP address of the server, in format x.x.x.x
121+
- In the field "Credentials" click "Add" and then "Jenkins" to create new credentials:
122+
- In the field "Domain" select "Global credentials (unrestricted)".
123+
- In the field "Kind" select "Username with password".
124+
- In the field "Scope" select "System (Jenkins and nodes only)".
125+
- In the field "Username" type username - in our case: "test-user".
126+
- In the field "Password" enter password.
127+
- In the field "ID" enter username - in our case "test-user".
128+
- Click "Add"
129+
- In the field "Credentials" select newly created credentials - in our case: "test-user".
130+
- In the field "Host Key Verification Strategy" select "Manually trusted key Verification Strategy".
131+
- In the field "Availability" select "Keep this agent online as much as possible".
132+
- Click "Save"
133+
134+
### Job overview
135+
Jenkins jobs can be accessed from the main dashboard. To select a job click on the name of that job. To run the job, click "Build with Parameters". To access the finished job, click on the Build name in the "Build History" section or in the "Stage view" section. In the build view "Build Artifacts" can be accessed, containing "console.log". NOTE: console logs are available also by clicking on "Console Output" or "View as plain text", which is useful when a pipeline was unable to generate logs, or job failed from script errors, or Jenkins related errors, e.g. unapproved scripts.
136+
137+
### Running a Job
138+
Enter the Job view and click "Build with Parameters". Some build configuration can be made. To run the job, click "Build".
139+

0 commit comments

Comments
 (0)