ソフトウェアエンジニアリング - 機能 #14

Transcription

1 ソフトウェアエンジニアリング 機能 #14 GitBucket 2.1 の RPM を作成する 2014/07/ 高橋徹 ステータス 終了開始日 2014/07/20 優先度 通常期日 担当者 高橋徹進捗率 100% カテゴリ 予定工数 0.00 時間 対象バージョン 作業時間 0.00 時間 説明 GitBucket 2.1 の RPM を作成します GitBucket の入手先 (GitHub) は次の URL です https//github.com/takezoe/gitbucket このリポジトリの contrib には Red Hat Enterprise Linux 用の RPM 作成に使う SPEC ファイル サービス起動の init ファイル 設定ファイルが登録されていますが root ユー仕様となっています そこで Jenkins のように root ではなく特定のユーザー権限で動くように RPM を作成します 関連するチケット 関連している機能 #54 GitBucket 3.11のRPMを H2 database 却下 migration 2016/02/28 ツ... 履歴 #1 2014/07/ 高橋徹 ステータスを新規から進行中に変更 進捗率を 0 から 50 に変更 まずは GitHub リポジトリより次のファイルを入手します gitbucket.war (Java バイトコード ) gitbucket2.1.tar.gz ( ソースファイル ) gitbucket.spec (RPM ビルド用定義ファイル ) gitbucket.conf (GitBucket 実行時の設定ファイル ) gitbucket.init (GitBucket を service 起動するためのスクリプトファイル ) それぞれ RPM ビルド用に配置します $HOME/rpm SPECS gitbucket.spec SOURCES gitbucket.war gitbucket2.1.tar.gz gitbucket.conf gitbucket.ini GitBucketのcontribをほぼそのままでRPM 作成 (rootユーザー実行) gitbucket.spec rpm/specs/gitbucket.spec ,6@@ 1,6 Name gitbucket Summary GitHub clone written with Scala. Version 1.7 Version 2.1 Release 1%{?dist} License Apache URL 40,6@@ 40,9 2018/11/01 1/10

2 %changelog * Sun Jul Toru Takahashi <torutk at gmail.com> Version bump to v2.1. * Mon Oct Jiri Tyr <jiri_dot_tyr at gmail.com> Version bump to v1.7. RPM ビルドを実行します ~$ rpmbuild ba rpm/specs/gitbucket.spec RPM および SRPM が生成されます $HOME/rpm RPMS noarch gitbucket2.11.el6.noarch.rpm SRPMS gitbucket2.11.el6.src.rpm 生成された RPM をインストールします ~$ sudo rpm Uvh rpm/rpms/noarch/gitbucket2.11.el6.noarch.rpm 準備中... ########################################### [100% 1gitbucket ########################################### ~$ 次のファイルがインストールされました ~$ rpm ql gitbucket /etc/init.d/gitbucket /etc/sysconfig/gitbucket /usr/share/gitbucket/lib/gitbucket.war /var/log/gitbucket/run.log ~$ 手動で gitbucket を実行します ~$ sudo service gitbucket start gitbucket のログは /var/log/gitbucket/run.log に生成されます gitbucket のプロセス ID は /var/run/gitbucket.pid に生成されます gitbucket のデータは /var/lib/gitbucket/ に生成されます data.h2.db, data.lock.db, ve 2018/11/01 2/10

3 #2 2014/07/ 高橋徹 gitbucket を root ユーザーではなく gitbucket ユーザーで動かすために必要なことを調べる root で動く gitbucket をインストールした後 これを gitbucket ユーザーで動かすために必要な修正をしていきます 修正が完了した時点で gitbucket.spec ファイルほかを修正していきます #3 2014/07/ 高橋徹 gitbucket を root ユーザーではなく gitbucket ユーザーで動かすために必要なことを調べる Jenkins が同じく war ファイルを java で実行するタイプですが root ユーザーではなく jenkins ユーザーで実現しているので Jen を参考にします https//github.com/jenkinsci/jenkins/blob/master/rpm/sources/jenkins.in root で動く gitbucket をインストールした後 これを gitbucket ユーザーで動かすために必要な修正をしていきます 修正が完了した時点で gitbucket.spec ファイルほかを修正していきます gitbucket ユーザー / グループの作成 ~$ sudo groupadd r gitbucket ~$ sudo useradd g gitbucket s /bin/false r c "GitBucket SCM Server" jenkins の設定に倣ってユーザーのシェルを /bin/false にしたけど su gitbucket c " コマンド " がスカって起動し /bin/false はシェルを通じて一切の操作ができない偽シェル (su < ユーザー > c " コマンド " も操作できない模様 ) daemon で起動する場合はシェルを通じないかも (jenkins の init スクリプトでは daemo ドを実行していた ) gitbucket のログディレクトリ / ファイルの所有者変更 ~$ sudo chown R gitbucket.gitbucket /var/log/gitbucket gitbucket 起動スクリプト (/etc/init.d/gitbucket) でコマンドを gitbucket 41,7@@ 41,7 fi # Run the Java process daemon user gitbucket pidfile ${PID_FILE} "GITBUCKET_HOME=${GITBUCK FILE $START_OPTS >>$LOG_FILE 2>&1 &" GITBUCKET_HOME="${GITBUCKET_HOME}" java $GITBUCKET_JVM_OPTS jar $GITBU # Store PID of the Java process into a file 最初 su gitbucket c "..." で実行しようとしましたが gitbucket ユーザーのシェルが偽シェル (/sbin/false) だと駄目だったので daemon 関数で実行し 起動しましたが service から stop ができません PID ファイルが空です gitbucket 起動スクリプト (/etc/init.d/gitbucket) で daemon 関数で起動した java プロセスの PID 46,13 # Store PID of the Java process into a file echo $! > $PID_FILE /bin/ps hww u gitbucket o sess,ppid,pid,cmd \ while read sess ppid pid cmd; do [ "$ppid" = 1 ] continue echo "$cmd" grep $GITBUCKET_WAR_FILE > /dev/null [ $? = 0 ] continue echo $pid > "$PID_FILE" done 2018/11/01 3/10

4 if [ $RETVAL eq 0 ] ; then success "GitBucket startup" gitbucket のデータは /var/lib/gitbucket の下に作成されます ここの所有権を gitbucket ユーザーに変更します ~$ sudo chown R gitbucket.gitbucket /var/lib/gitbucket #4 2014/07/ 高橋徹 実効ユーザーを変更した RPM を作成するための修正 SPEC ファイルに gitbucket ユーザー 1,7@@ 1,7 Name gitbucket Summary GitHub clone written with Scala. Version 2.1 Release 1%{?dist} Release 2%{?dist} License Apache URL https//github.com/takezoe/gitbucket Group 26,25 %{ install} m 0644 %{SOURCE2} %{buildroot}%{_sysconfdir}/sysconfig/% touch %{buildroot}%{_localstatedir}/log/%{name}/run.log %pre /usr/sbin/groupadd r gitbucket &> /dev/null /usr/sbin/useradd g gitbucket s /bin/false r c "GitBucket GitHub c %post /sbin/chkconfig add gitbucket %preun if [ "$1" = 0 ]; then /sbin/service gitbucket stop > /dev/null 2>&1 /sbin/chkconfig del gitbucket fi exit 0 %postun if [ "$1" ge 1 ]; then /sbin/service gitbucket restart > /dev/null 2>&1 fi exit 0 %clean [ "%{buildroot}"!= / ] && %{ rm} rf 53,16 %files %defattr(,root,root,) %{_datarootdir}/%{name}/lib/%{name}.war %{_sysconfdir}/init.d/%{name} %config %{_sysconfdir}/sysconfig/%{name} %{_localstatedir}/log/%{name}/run.log %config %{_sysconfdir}/init.d/%{name} %config(noreplace) %{_sysconfdir}/sysconfig/%{name} 2018/11/01 4/10

5 %attr(0755,gitbucket,gitbucket) %{_sharedstatedir}/%{name} %attr(0750,gitbucket,gitbucket) %{_localstatedir}/log/%{name} %changelog * Mon Jul Toru Takahashi <torutk at gmail.com> execute as gitbucket user * Sun Jul Toru Takahashi <torutk at gmail.com> Version bump to v2.1. #5 2014/07/ 高橋徹 ステータスを進行中から解決に変更 進捗率を 50 から 80 に変更 本作業の成果物は GitBucket ページに上げています #6 2014/10/ 高橋徹 Gitbucket がリリースされたので RPM パッケージを作成しました https//github.com/takezoe/gitbucket/releases からソースコードとwarをダウンロードし ~/rpm/sourcesにコピー 2.1のSPECファイルをバージョンを2.4.1に修正ソースコードを作業ディレクトリに展開し contrib/gitbucket.{conf,init} を取り出し ~/rpm/sourcesにk rpmbuild 実行出来たRPMをインストールサービス実行 ~$ sudo service gitbucket start ~$ あれ なにもメッセージが出ません おかしい /etc/init.d/gitbucket を直接実行 ~$ cd /etc/init.d inti.d$ sudo./gitbucket start init.d$ 同じく gitbucket に片っ端から echo 文を埋めてみると 13 set e [ f /etc/rc.d/init.d/functions ] && source /etc/rc.d/init.d/func 15 行目より後に入れた echo 文が出ない set e について調べてみた set e での動作を想定していないライブラリを. ( ドット ) コマンドや source コマンドで読み込んだときに使えない http//qa.atmarkit.co.jp/q/2813 とあった set e を削除するとメッセージが出るようになった 現状は java プロセスが root で実行される gitbucket ユーザーで実行するために /etc/rc.d/init.d/functions 用してみました 2018/11/01 5/10

6 GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java $GITBUC >>$LOG_FILE 2>&1 & /var/lib/gitbucket のパーミッションが root だと動かないので gitbucket に変更したら動きました #7 2014/11/ 高橋徹 service gitbucket stop で停止しない /etc/init.d/gitbucket の起動部分を抜粋 60 GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java $ RT_OPTS >>$LOG_FILE 2>&1 & echo $! > $PID_FILE 起動するプロセスを ps aux から抜粋 ~$ ps aux grep gitbucket root 1194 /bin/bash /etc/rc3.d/s60gitbucket start root 1203 runuser s /bin/bash gitbucket c ulimit S c 0 >/dev/ /lib/gitbucket.war port=8080 host= bash c ulimit S c 0 >/dev/null 2>&1 ; java Dmail.sm 8080 host= java Dmail.smtp.starttls.enable=true jar /usr/share/g このとき /var/run/gitbucket の中は 1194 となっていた これは gitbucket プロセスではなく gitbucket プロセスを起動するシェルスクリプトの PID となっている daemon function に渡す pidfile オプションは参照用でそのファイルを生成して PID 60,8@@ 60,6 GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java _OPTS >>$LOG_FILE 2>&1 & echo $! > $PID_FILE if [ $RETVAL eq 0 ] ; then success "Success" 75,10 echo n $"Stopping GitBucket server " # Run the Java process kill $(cat $PID_FILE >>$LOG_FILE 2>/dev/null) 2>&1 pkill f $GITBUCKET_WAR_FILE >>$LOG_FILE 2>&1 if [ $RETVAL eq 0 ] ; then rm f $PID_FILE success "GitBucket stopping" else failure "GitBucket stopping" 2018/11/01 6/10

7 #8 2014/11/ 高橋徹 GitBucket の起動制御スクリプトの再構築 CentOS 6 で GitBucket の起動制御スクリプトを使えるようにするため リポジトリの元ネタから再度修正を開始します https//github.com/takezoe/gitbucket/blob/master/contrib/gitbucket.init これを CentOS 6 で動かすと次の行でエラーとなりました if [ `ismac` ]; then CentOS 6 には ismac というコマンドがないためです gitbucket.init はこのスクリプトは RedHat/Ubuntu/Mac X 共用になっています ファイル先頭のコメント部分を抜き出します # RedHat /etc/rc.d/init.d/gitbucket # Ubuntu /etc/init.d/gitbucket # Mac OS/X /Library/StartupItems/GitBucket しかし スクリプト中に if 文で切り分けを入れる作りでは 3 つの環境を持っていてすべてで確認しながら修正作業をする必要があります すべての環境を持っていることは稀で 持っていたとしても甚だ手間がかかります 実際 上述のように RedHat 系の CentOS にはないコマンドを実行するコードが入ってしまっています スクリプトは環境ごとに分けるべきでしょう ということで まず RedHat 系専用のスクリプトにします gitbucket のリポジトリを見ると gitbuckt contrib linux redhat gitbucket.spec macosx makeplist README.md gitbucket.conf gitbucket.init install となっているので RedHat 専用にする起動制御スクリプトは contrib/linux/redhat/ に置くのが好ましいでしょう そこで c を contrib/linux/redhat/gitbucket.init にコピーしこれを変更していきます Ubuntu/MacOS 用コードの削除 # Ubuntu /etc/init.d/gitbucket # Mac OS/X /Library/StartupItems/GitBucket [ f /etc/rc.common ] && source /etc/rc.common # Mac OS/X ## MacOS proxies for System V service hooks StartService() { start } StopService() { stop } RestartService() { restart } if [ `ismac` ]; then RunService "$1" else fi set e の削除 ( 前に述べた source /etc/rc.d/init.d/functions を機能させるための修正 ) 2018/11/01 7/10

8 set e gitbucket ユーザーで実行 ( 前に述べた修正 ) GITBUCKET_HOME="${GITBUCKET_HOME}" java $GITBUCKET_JVM_OPTS 2>&1 & GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java $GITBUCKET_JVM_OPTS jar $GITBUCKET_WAR_FILE $START_OPTS >>$LOG_ pid ファイルによるサービス ( プロセス ) 終了の制御ができないため代替方法 PID_FILE=/var/run/gitbucket.pid echo $! > $PID_FILE kill $(cat $PID_FILE >>$LOG_FILE 2>/dev/null) 2>&1 pkill f gitbucket.war >>$LOG_FILE 2>&1 rm f $PID_FILE status) status p $PID_FILE java pgrep f gitbucket.war >> $LOG_FILE 2>&1 if [ $RETVAL eq 0 ]; then echo $"GitBucket is running..." else echo $"GitBucket is stopped" ;; ここまでの修正でサービス起動制御スクリプトを実行すると次のようになります ~$ sudo service gitbucket status which no success in (/sbin/usr/sbin/bin/usr/bin) which no failure in (/sbin/usr/sbin/bin/usr/bin) GitBucket is stopped これは 次のスクリプト記述が原因です if [ z "$(which success)" ]; then function success { printf "%b\n" "$GREEN $* $OFF" } fi if [ z "$(which failure)" ]; then function failure { printf "%b\n" "$RED $* $OFF" } fi success と failure は /etc/rc.d/init.d/functions スクリプトで定義されるシェル関数です which コマンド このスクリプト記述は success と failure がコマンドである想定で書かれています RedHat 系専用スクリプトでは ばっさり削除してし if [ z "$(which success)" ]; then function success { printf "%b\n" "$GREEN $* $OFF" } fi if [ z "$(which failure)" ]; then 2018/11/01 8/10

9 function failure { printf "%b\n" "$RED $* $OFF" } fi 起動に失敗しても スクリプト上は成功として表示されてしまいます 次のスクリプト部分が課題です GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java $GITBUC _JVM_OPTS jar $GITBUCKET_WAR_FILE $START_OPTS >>$LOG_FILE 2>&1 & if [ $RETVAL eq 0 ] ; then success "Success" else failure "Exit code $RETVAL" fi バックグラウンド実行 ( 末尾に '&' をつけて実行 ) した場合 コマンド実行結果 ('$?') は常に0( 成功 ) となります そこで daemonでバックグラウンド実行後 一定時間経過待ち 1 してからpgrepでプロセスを探して結果を判定することにします GITBUCKET_HOME="${GITBUCKET_HOME}" daemon user=gitbucket java $GI _OPTS >>$LOG_FILE 2>&1 & sleep 3 pgrep f $GITBUCKET_WAR_FILE >> $LOG_FILE 2>&1 1 本当はプロセスが立ち上がったことを確認したかったのですが うまいやり方が見つからず sleep にしてしまいました #9 2015/02/ 高橋徹 ステータスを解決から終了に変更 進捗率を 80 から 100 に変更 2018/11/01 9/10

10 Powered by TCPDF ( 棚卸し この修正を gitbucket の github リポジトリからフォークを作成して ブランチにコミット https//github.com/torutk/gitbucket/commit/676670e9e3a bedb4cccf5 プルリクエストを発行して その後取り込んでいただきました # /02/ 高橋徹 関連している機能 #54 GitBucket 3.11 の RPM を H2 database migration ツールを含めて作成するを 2018/11/01 10/10