Memo/Jenkins

Jenkins

Jenkins †

http://jenkins-ci.org/
- CI(continuous integration 継続的インテグレーション - Wikipedia)ツール
- Jenkins日本語wiki

記事

バックアップ/リストア †

Backing-up/Restoring Jenkins
- 基本はJenkins HOME(/var/lib/jenkins/)等を丸ごとバックアップで良い

jobの実行履歴のファイルサイズが非常に大きい。それらが不要なら小さくなる

JENKINS_HOME=/var/lib/jenkins
HOSTNAME_SHORT=$(hostname -s)
TMP_DIR="$(mktemp -d /ext/ebs1/${SCRIPT_NAME}.tmpXXXXXX)"
DATE_EXT="$(date +%w)"

nice tar --ignore-failed-read -zcf $TMP_DIR/${HOSTNAME_SHORT}.jenkins.$DATE_EXT.tar.gz $JENKINS_HOME/*.xml $JENKINS_HOME/jobs/*/*.xml $JENKINS_HOME/nodes/* $JENKINS_HOME/plugins/*.jpi $JENKINS_HOME/secrets/* $JENKINS_HOME/users/*

記事:

Jenkinsの設定などを雑にバックアップする「jenkins-backup-script」 #Bash - Qiita

↑

GitHub actionsでjenkins jobを動作させる †

記事:

Jenkins ジョブを GitHub Actions 上で動かせるようになりました

↑

書籍 †

↑

jobの管理 †

Import/Export
- Jenkins APIを通してジョブを登録する - Qiita

Jobcopy Builder plugin - Jenkins - Jenkins Wiki GUIからjobをテンプレート化できる。
- jenkins本体/pluginをアップデートすると、権限の問題なのか、他pluginの干渉なのかで、コピーに失敗するようになった。
- jenkins jobcopy builder plugin not working - Stack Overflow

↑

ansibleでのjob管理 †

記事
- Jenkinsのジョブをまじめにいい感じに管理してみた（Ansible編） - Qiita
- jenkins_job – Manage jenkins jobs — Ansible Documentation python-jenkins, lxmlが必要。
- Web Infrastructure modules に、jenkins_job_info, jenkins_plugin, jenkins_script もあった。

jenkins crumbの取得

- name: jenkins crumb
  uri:
    url: '{{ jenkins_host }}/crumbIssuer/api/json'
    method: GET
    user: "{{ jenkins_user }}"
    password: "{{ jenkins_password }}"
    force_basic_auth: yes
    status_code:
      - 200
    return_content: yes
  register: jenkins_crumb

job xmlのexport

- name: Get config.xml
  uri:
    url: '{{ jenkins_host }}/job/{{ job_name }}/config.xml'
    method: GET
    user: "{{ jenkins_user }}"
    password: "{{ jenkins_password }}"
    force_basic_auth: yes
    headers:
      Jenkins-Crumb: "{{ jenkins_crumb.json.crumb }}"
      Cookie: "{{ jenkins_crumb.set_cookie }}"
    status_code:
      - 200
      - 201
    return_content: yes
  register: result_job

- name: Export job
  copy:
    dest: "{{ dest_path }}/{{ job_name }}.config.xml"
    content: "{{ result_job.content }}"

job xmlからjobの作成: jenkins_jobと違いpip moduleに依存しない。

- name: createItem
  uri:
    url: '{{ jenkins_host }}/createItem?name={{ job_name }}'
    method: POST
    user: "{{ jenkins_user }}"
    password: "{{ jenkins_password }}"
    force_basic_auth: yes
    headers:
      Jenkins-Crumb: "{{ jenkins_crumb.json.crumb }}"
      Cookie: "{{ jenkins_crumb.set_cookie }}"
      Content-type: "text/xml"
    body_format: raw
    body: "{{ lookup('file','/tmp/ansible-tmp.{{ job_name  }}.xml') }}"
    status_code:
      - 200
      - 201

↑

トラブルシューティング †

↑

pluginを無効化したら起動しなくなった場合 †

GUIからpluginを無効化して、jenkinsが起動しなくなった場合、「<plugin>.disabled」ファイルを消すと、pluginが有効になる。

jenkins 2.204.x

jenkins_plugin=<plugin name>
rm $JENKINS_HOME/plugins/${jenkins_plugin}.jpi.disabled
sudo service jenkins restart

↑

job毎に権限を設定する †

特定のユーザは特定のjobの実行のみできる等の権限を絞りたい。

Role Strategy Plugin - Jenkins - Jenkins Wiki

記事
- Jenkinsでジョブごとに権限を設定する | 株式会社CONFRAGE ITソリューション事業部

↑

API †

Remote access API - Jenkins - Jenkins Wiki
CSRF対策が有効な場合
- HTTPヘッダに「Jenkins-Crumb:****」を付ける
- 2.176.2+: CookieにJSESSIONIDを設定する

記事
- Jenkins APIでジョブ情報を取得する - Qiita
- JenkinsジョブをAPI経由でパラメータ付きビルドする - Qiita

curlでjob単体の状態を得る。jqでjsonの整形。

Jenkins 1.384まではcrumbの指定が必須だった。

jenkins_url=https://jenkins.example.com:8080/jenkins
cookie_jar=/tmp/cookies
jenkins_job=test01
jenkins_user=user01
read -sp 'jenkins_password: ' jenkins_password

# clumbの取得
jenkins_clumb=$(curl -s -u "${jenkins_user}:${jenkins_password}" -c $cookie_jar ${jenkins_url}/crumbIssuer/api/json | jq -r '.crumb')

# job単体の取得
curl -s -u "${jenkins_user}:${jenkins_password}" -H "Jenkins-Crumb:${jenkins_clumb}" ${jenkins_url}/job/${jenkins_job}/api/json | jq

curlでjobの実行:

「--data-urlencode json='{"parameter": [{"name":"id", "value":"123"}]}'」では、パラメータが上書きされなかった。「buildWithParameters?id=123」だとOK
Jenkins (2.176.2+)ではCSRF対策が有効な場合、cookieにJSESSIONIDの設定が必須になっている。
- POST API calls '403 No valid crumb was included in the request' Issue #67 cdancy/jenkins-rest
- Jenkins (2.176.2+) - requests using CSRF require sessionid Issue #3 PlagueHO/jenkins

jenkins_clumbの取得までは上と同じ

curl -s -u "${jenkins_user}:${jenkins_password}" \
-H "Jenkins-Crumb:${jenkins_clumb}" \
-b $cookie_jar ${jenkins_url}/job/${jenkins_job}/buildWithParameters?id=123 \
--data-urlencode json='{}'

↑

ユーザの権限管理 †

記事
- Jenkinsでユーザーに権限を付与してアクションを制限する - Qiita

指定ユーザがjobの実行だけできるように

↑

v1からv2への移行 †

記事
- Jenkinsをver.1.533(AWS EC2)からver. 2.17(AWS ECS)に移行した - Qiita

↑

コードで管理 †

記事
- Jenkins Configuration as Code：最初の一歩（ママ見て、すごいでしょ） | Cloudbees Jenkins Solutions

configuration-as-code-plugin/README.md at master · jenkinsci/configuration-as-code-plugin
- yamlファイルでjenkinsの設定をできるようにするプロジェクト

Ansible module に幾つかある
- jenkins_job - Manage jenkins jobs
- jenkins_job_facts - Get facts about Jenkins jobs
- jenkins_plugin - Add or remove Jenkins plugin
- jenkins_script - Executes a groovy script in the jenkins instance

↑