タグ: Jenkins

Jenkinsの起動構成をカスタマイズする

前提

  • Ubuntu 24.04.1
  • aptでインストール

問題点

jenkins.service内で、port番号などを変更していると、apt upgradeで更新するたびに、元に戻ってしまう。

解決策

sudo systemctl edit jenkins
又は、
sudo vi /etc/systemd/system/jenkins.service.d/override.conf
を使う。

参考手順

以下の手順でJenkinsをインストールする。

sudo wget -O /usr/share/keyrings/jenkins-keyring.asc https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key

echo "deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc]" https://pkg.jenkins.io/debian-stable binary/ | sudo tee /etc/apt/sources.list.d/jenkins.list > /dev/null

sudo apt update
sudo apt upgrade
sudo apt install jenkins

Apacheと連携するように設定する。

sudo a2enmod proxy
sudo a2enmod proxy_http
sudo vi /etc/apache2/sites-available/jenkins.conf

ProxyPass         /jenkins  http://localhost:8080/jenkins nocanon
ProxyPassReverse  /jenkins  http://localhost:8080/jenkins
ProxyRequests     Off
AllowEncodedSlashes NoDecode

<Proxy http://localhost:8080/jenkins*>
  Order deny,allow
  Allow from all
</Proxy>

jenkins.confを有効にして、Apacheを再起動する。

sudo a2ensite jenkins.conf
sudo systemctl restart apache2

Jenkinsの起動構成を変更する。

sudo systemctl edit jenkins

又は、

sudo vi /etc/systemd/system/jenkins.service.d/override.conf

先ほど設定したApacheのURLと合うように、JENKINS_PREFIX=/jenkinsとする。

[Unit]
Description=Jenkins Controller

[Service]
Environment="JENKINS_PREFIX=/jenkins"

Jenkinsを再起動する。

sudo systemctl restart jenkins

JenkinsをJava 21で動かす

JenkinsでビルドしていたプロジェクトをJava 21に変更したため、JenkinsもJava 21で起動する必要がある。

前提

Ubuntu上で既にJenkinsがJava 17で稼働しているものとする。
Jenkinsは最新版を使用している。

Java 21のインストール

下記からLinux用JDKをダウンロードして、任意のフォルダに解凍する。
https://adoptium.net/temurin/releases/

$ cd /opt
$ sudo wget https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21%2B35/OpenJDK21U-jdk_x64_linux_hotspot_21_35.tar.gz
$ sudo tar -xvf OpenJDK21U-jdk_x64_linux_hotspot_21_35.tar.gz
$ sudo ln -s /opt/jdk-21+35 /opt/jdk-21

Javaの設定

$ sudo update-alternatives --install /usr/bin/java java /opt/jdk-21/bin/java 1
$ sudo update-alternatives --install /usr/bin/javac javac /opt/jdk-21/bin/javac 1
$ sudo update-alternatives --install /usr/bin/javadoc javadoc /opt/jdk-21/bin/javadoc 1

インストールしたJDKをデフォルトに設定する。

$ sudo update-alternatives --config java
$ sudo update-alternatives --config javac
$ sudo update-alternatives --config javadoc

Java 21に切り替わっていることを確認する。

$ java -version
openjdk version "21" 2023-09-19 LTS
OpenJDK Runtime Environment Temurin-21+35 (build 21+35-LTS)
OpenJDK 64-Bit Server VM Temurin-21+35 (build 21+35-LTS, mixed mode, sharing)

Jenkinsの起動と動作確認

Jenkinsを起動する。

$ sudo systemctl start jenkins
$ sudo systemctl status jenkins
● jenkins.service - Jenkins Continuous Integration Server
・・・
10月 19 04:37:40 systemd[1]: Started Jenkins Continuous Integration >

Java 21のプロジェクトをビルドし、正常終了することを確認する。

JenkinsでwarファイルをTomcatにデプロイする

前提

ビルドが成功して、warファイルが作成されること。

プラグインのインストール

JenkinsのPlugin ManagerでDeploy to container Pluginをインストールする。

ビルド後の処理の追加

Deploy war/ear to a containerを追加する。

Warファイルのパス、コンテキスト名を設定する。

Built-in Tomcat manager rolesで、manager-scriptに設定した、ユーザー名、パスワードをCredentialsに設定する。

JenkinsでMavenの実行結果のレポートを作成する

Mavenのインストール

sudo apt install maven
mvn --version

レポート作成でよく使うプラグインをインストールする

JaCoCo plugin: JaCoCoコードカバレッジレポートをJenkinsに統合する。

Warnings Next Generation Plugin: 静的分析ツールによって報告されたコンパイラの警告または問題を収集し、結果を視覚化する。（自分はspotbugs、checkstyleで使用）

Jenkinsの設定

ビルドにMavenの呼び出しを追加する。

package site

ビルド後の処理に以下の項目を追加する。

１．JUnitテスト結果の集計
target/surefire-reports/*.xml


２．JaCoCoカバレッジレポートを記録


３．Javadocの保存


４．CheckStyleとSpotBugsの解析結果を保存

GithubにコミットしたらJenkinsで自動的にビルドされるようにする

Jenkins側の設定

グローバルセキュリティの設定

ログインしていない場合でも、jenkinsにリードオンリーでアクセスできるように設定する。

ジョブを作成する

GitHub projectにチェックし、GitHub上のプロジェクトのURLを設定する。同時にソースコード管理にもURLを設定する。公開レポジトリであれば認証情報は入力不要。

GitHub hook trigger for GITScm pollingにチェックを入れる。

上記でジョブを作成する。これでジョブを自動的に起動する準備が出来たので、後はプロジェクトの要件に合わせてビルドやテストが起動するように、カスタマイズすれば良い。

GitHub側の設定

連携するプロジェクトのSettingsを開きWebhookを作成する。Payload URLにはJenkinsのURL+「/github-webhook/」を指定する。Content typeにはJSONを指定する。

動作確認

GitHubに変更がpushされると、Jenkinsのジョブが起動することが確認できる。

Mavenでのビルド、そのビルド後の処理について

Mavenのビルド、Mavenのビルド処理で作成したJavadoc等をJenkinsプロジェクトのメニューに表示されるようにする方法はこちら。

Ubuntu Server 22.04 LTSをインストールする

目的

開発用のサーバーをUbuntu Server 22.04で再構築する。

Ubuntu Serverのインストール

下記からISOファイルをダウンロードして、USBフラッシュドライブに書き込む。
https://jp.ubuntu.com/download

SSHのインストールのチェックを入れるのを忘れずに、他はインストーラーの指示通りに入力する。

MariaDBのインストール

ここではインストールのみ行い、設定は後程行う。

sudo apt install mariadb-server
sudo mysql_secure_installation

Apache、phpのインストール

phpを使用することを前提としたインストールと、設定を行う。

sudo apt install apache2
sudo a2enmod rewrite
sudo a2enmod ssl
sudo a2ensite default-ssl
sudo apt install php libapache2-mod-php php-fpm php-common php-mbstring php-xmlrpc php-gd php-xml php-mysql php-cli php-zip php-curl php-imagick php-intl

.htaccesによる、設定の上書きを有効にする。

sudo vi /etc/apache2/apache2.conf

<Directory /var/www/>
	Options Indexes FollowSymLinks
	AllowOverride all
	Require all granted
</Directory>

sudo service apache2 restart

Webminのインストール

sudo apt install wget apt-transport-https software-properties-common

wget https://download.webmin.com/jcameron-key.asc
cat jcameron-key.asc | gpg --dearmor >jcameron-key.gpg
sudo cp jcameron-key.gpg /etc/apt/trusted.gpg.d/jcameron-key.gpg

sudo apt update
sudo apt install webmin
sudo /usr/share/webmin/changepass.pl /etc/webmin ユーザー名 パスワード

日本語設定

sudo apt install language-pack-ja
localectl list-locales | grep ja
sudo localectl set-locale LANG=ja_JP.UTF-8

Tomcat 9のインストール

sudo apt install tomcat9 tomcat9-admin

Jenkins運用のため、/etc/tomcat9/context.xmlに下記を追記する。

    <Resources cacheMaxSize="102400" />

/etc/tomcat9/server.xmlのAJP/1.3の設定を下記の通り変更する。

    <Connector protocol="AJP/1.3"
               address="localhost"
               port="8009"
               redirectPort="8443"
               secretRequired="false" />

/etc/tomcat9/tomcat-users.xmlに下記を追記する。

  <role rolename="manager-script"/>
  <user username="ユーザー名" password="パスワード" roles="manager-script"/>

/usr/lib/systemd/system/tomcat9.serviceに下記を追記する。

Environment="CATALINA_OPTS=-DJENKINS_HOME=/opt/jenkins/"
ReadWritePaths=/opt/jenkins/

/etc/tomcat9/policy.d/50local.policyに下記を追記する。

grant codeBase "file:${catalina.base}/webapps/jenkins/-" {
    permission java.security.AllPermission;
};
grant codeBase "file:/opt/jenkins/-" {
    permission java.security.AllPermission;
};

sudo systemctl daemon-reload
sudo service tomcat9 restart

Jenkinsのインストール

/opt/jenkinsフォルダを作成し、フォルダにTomcatから書き込み可能な権限を付与する。

jenkins.warファイルをダウンロードし、/var/lib/tomcat9/webapps/に配置する。

ApacheとTomcatの連携の設定

sudo a2enmod proxy
sudo a2enmod proxy_ajp

/etc/apache2/conf-enabled/tomcat.confを作成し、下記の通り記載する。

ProxyPass /jenkins/ ajp://localhost:8009/jenkins/
ProxyPassReverse /jenkins/ ajp://localhost:8009/jenkins/

sudo service apache2 restart

Postfixのインストール

こちらのページにインストールと設定方法を記載した。

Token authentication requirements for Git operations

Githubから以下のようなメールが届いた。どうやら、2021/8/13でパスワードによる認証が出来なくなるらしい。

[GitHub] Deprecation Notice
Basic authentication using a password to Git is deprecated and will soon no longer work.
※詳しくはこちらのURLを参照。

当方ではEclipseでpush/pullするときにパスワード認証を使用しているので、Token authenticationを使用するように変更する。（Jenkinsでパスワード認証を使用している場合も同様の設定が必要になる）

Github側の設定

  1. Settings > Developer settingsのPersonal access tokensを開き、Generate new tokenをクリックする。
  2. 必要な権限にチェックを入れ、Generate tokenをクリックする。
  3. 作成されたtokenをコピーしておく。

Jenkins側の設定

  1. プロジェクトの設定画面を開き、認証情報の追加をクリックする。
  2. 先ほどコピーしたTokenをパスワードに入力する。

Eclipse側の設定

  1. 先ほど生成したTokenをパスワードに入力する。

Jenkinsで自動デプロイ

※2022/05/05追記：Mavenでデプロイするのではなく、Jenkinsのプラグインを使用してデプロイする方法はこちら。

Jenkinsから自動的にTomcatへデプロイする。

  • Tomcat側の設定
    1. apache-tomcat-8.5.28/conf/tomcat-users.xmlを以下の通り編集する。
<tomcat-users xmlns="http://tomcat.apache.org/xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://tomcat.apache.org/xml tomcat-users.xsd" version="1.0">
    <role rolename="manager-script">
        <user username="任意のユーザ名" password="パスワード" roles="manager-script">
        </user>
    </role>
</tomcat-users>
  • Jenkins側の設定
    1. 実行ユーザの/.m2/settings.xmlを以下の通り編集する。
    2. プロジェクトの設定を開き、Mavenのゴールの設定に「tomcat7:redeploy」を追記する。
<settings>
    <servers>
        <server>
            <id>tomcat-localhost</id>
            <username>任意のユーザ名</username>
            <password>パスワード</password>
        </server>
    </servers>
</settings>

ユーザ名、パスワードはTomcatの設定と合わせること。

  • Maven側の設定
    1. pom.xmlに以下を追記する。
<plugin>
    <groupid>org.apache.tomcat.maven</groupid>
    <artifactid>tomcat7-maven-plugin</artifactid>
    <version>2.2</version>
    <configuration>
        <path>/common</path>
        <server>tomcat-localhost</server>
        <url>http://localhost:8080/manager/text</url>
    </configuration>
</plugin>

serverはsettings.xmlのidと合わせること。

JenkinsとGithubの連携

※2022/05/05追記：jenkinsの設定方法も含めた、2022年現在の連携方向を参照したい場合はこちら。

Githubにpushされたら、Jenkinsのビルドを起動したい。

  • Github側の設定
    1. SettingsのIntegrations & servicesを開き、
      Add ServiceからJenkins (Git plugin)を選択する。

    2. 表示された「Jenkins url」に「http://～ホスト名～/jenkins/github-webhook/」と入力する。

  • Jenkins側の設定
    1. GitHub pluginをインストールする。
      （GitHub plugin）

    2. ジョブの設定の「GitHub hook trigger for GITScm polling」にチェックを入れる。