* 目次 [#i097eb1f]
#contents
** JHipsterのCI/CDのページ [#x83b0348]
https://www.jhipster.tech/setting-up-ci/
** GitLabのCI/CDのページ [#ofc55fbb]
dockerで動かす際の説明
https://docs.gitlab.com/runner/install/docker.html
https://about.gitlab.com/features/continuous-integration/
** .gitlab-ci.yml ファイルとは [#e450d961]
.gitlab-ci.yml ファイルはパイプラインの構造と順序を定義し、以下のことを決めます。
- GitLab Runnerを使って実行する内容。
- 特定の状況において、どのような判断をするか。例えば、処理が成功した場合と失敗した場合。
** .gitlab-ci.ymlのリファレンス [#h1cf516a]
https://gitlab-docs.creationline.com/ee/ci/yaml/
*** GitLabのクイックスタート [#xee0cfc6]
https://gitlab-docs.creationline.com/ee/ci/quick_start/README.html
** GitLabの設定サンプル [#dd8c86af]
https://gitlab-docs.creationline.com/ee/ci/examples/README.html
*** mavenを使った例 [#z4fd2745]
https://gitlab-docs.creationline.com/ee/ci/examples/artifactory_and_gitlab/index.html
*** spring-bootを使った例 [#pa163e7d]
https://gitlab-docs.creationline.com/ee/ci/examples/deploy_spring_boot_to_cloud_foundry/index.html
** jhipster ci-cdをためす [#bcee8a31]
jhipster ci-cd
を実行してみる
選択枝でGitLabを選ぶ
In GitLab CI, perform the build in a docker container
となる。
y
を選ぶ
.gitlab-ci.yml
が変更になる
** .gitlab-ci.yml に追加されたコード [#z53e08e5]
追加のタスクは何もなしで進むと以下のコードが追加された
image: jhipster/jhipster:v7.9.3
cache:
key: '$CI_COMMIT_REF_NAME'
paths:
- .maven/
stages:
- check
- build
- test
- analyze
- package
- release
- deploy
before_script:
- export MAVEN_USER_HOME=`pwd`/.maven
nohttp:
stage: check
script:
- ./mvnw -ntp checkstyle:check -Dmaven.repo.local=$MAVEN_USER_HOME
maven-compile:
stage: build
script:
- ./mvnw -ntp compile -P-webapp -Dmaven.repo.local=$MAVEN_USER_HOME
artifacts:
paths:
- target/classes/
- target/generated-sources/
expire_in: 1 day
maven-test:
services:
- docker:dind
variables:
# Instruct Testcontainers to use the daemon of DinD.
DOCKER_HOST: 'tcp://docker:2375'
# Improve performance with overlayfs.
DOCKER_DRIVER: overlay2
stage: test
script:
- ./mvnw -ntp verify -P-webapp -Dmaven.repo.local=$MAVEN_USER_HOME
artifacts:
reports:
junit:
- target/surefire-reports/TEST-*.xml
- target/failsafe-reports/TEST-*.xml
paths:
- target/surefire-reports
- target/failsafe-reports
- target/site
expire_in: 1 day
frontend-test:
stage: test
script:
- npm install
- npm test
artifacts:
reports:
junit: target/test-results/TESTS-results-jest.xml
paths:
- target/test-results
- target/jacoco
expire_in: 1 day
maven-package:
stage: package
script:
- ./mvnw -ntp verify -Pprod -DskipTests -Dmaven.repo.local=$MAVEN_USER_HOME
artifacts:
paths:
- target/*.jar
- target/classes
expire_in: 1 day
# Uncomment the following line to use gitlabs container registry. You need to adapt the REGISTRY_URL in case you are not using gitlab.com
#docker-push:
# stage: release
# variables:
# REGISTRY_URL: registry.gitlab.com
# IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-$CI_COMMIT_SHA
# dependencies:
# - maven-package
# script:
# - ./mvnw -ntp jib:build -Pprod -Djib.to.image=$IMAGE_TAG -Djib.to.auth.username=gitlab-ci-token -Djib.to.auth.password=$CI_BUILD_TOKEN -Dmaven.repo.local=$MAVEN_USER_HOME
* GitLab Runnerは別サーバー？ [#qef7020e]
もしかしてGitLabRunnerは別サーバにたてるのだろうか？
以下に構築方法を解説しているサイトがあった。
https://www.alpha.co.jp/blog/202208_01#%E3%82%AD%E3%83%A3%E3%83%83%E3%82%B7%E3%83%A5%E3%82%A2%E3%83%BC%E3%83%86%E3%82%A3%E3%83%95%E3%82%A1%E3%82%AF%E3%83%88%E3%83%AC%E3%82%B8%E3%82%B9%E3%83%88%E3%83%AA%E3%81%AE%E6%A0%BC%E7%B4%8D%E5%A0%B4%E6%89%80
* Dockerコンテナでgitlabとgitlab-runnerを構築してCI/CD [#j72672bb]
https://syachiku.net/docker-gitlab-gitlab-runner/
* docker-composeに追加するコード [#cab9639f]
gitlab-runner:
image: gitlab/gitlab-runner:latest
container_name: gitlab-runner
restart: always
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /root/gitlab/gitlab-runner-config:/etc/gitlab-runner
ports:
- "8093:8093"
** 必要なディレクトリやファイルを作成 [#v7daa150]
mkdir -p /root/gitlab/gitlab-runner-config
** GitLab Runnerを使用する前に、GitLabの管理者アカウントでGitLab Runnerを登録する必要があります。 [#de7649ef]
*** GitLabの公式ドキュメント [#kfa9f19c]
https://docs.gitlab.com/runner/
正直、オンプレミスではどうしたらよいのか親切には書いてない。
* 日本語の解説サイト [#z19e0b20]
** GitLab Runner構築のススメ [#v2853f1d]
https://www.gitlab.jp/blog/2022/09/26/runner-summary/
画面のキャプチャとかあって、本家よりわかりやすいかもしれない。インストール部分は、自分はdocker-composeを使ったので、参考にしてないが、GitRunnerの登録の仕方が本家の説明で要領を得なかったので、ここを参考にした。
*** 手順 [#yf300046]
- GitLab全体の基本設定のほうではなく、プロジェクトのサイドメニューから設定->CI/CD->Runnerを開いてください。
- Specific runnersに表示されているURL (GitLabのURLです)とregistration tokenの二つをメモする
メモしたい項目の具体的な項目名:
- Register the runner with this URL:
- And this registration token:
*** gitlab-runnerのコンテナ名の調査 [#x6580623]
docker-compose ps
起動させてあるのが、前提条件ですが、上記のコマンドで、実行済みのgitlab-runnerのコンテナ名を調べます。
*** docker-imageへのログイン [#c23330d0]
docker exec -it 上記手順で調べたドッカーコンテナ名 bash
*** 登録コマンドの実行 [#rfc64fc7]
コマンドを実行する前に、どのようなコマンドがあるのか確認してみましょう。
gitlab-runner --help
*** gitlab-runner-2というコンテナ名で、helpオプションを実行する例 [#u876ef65]
# docker exec -it gitlab-runner-2 gitlab-runner --help
NAME:
gitlab-runner - a GitLab Runner
USAGE:
gitlab-runner [global options] command [command options] [arguments...]
VERSION:
15.10.1 (dcfb4b66)
AUTHOR:
GitLab Inc. <support@gitlab.com>
COMMANDS:
exec execute a build locally
list List all configured runners
run run multi runner service
register register a new runner
reset-token reset a runner's token
install install service
uninstall uninstall service
start start service
stop stop service
restart restart service
status get status of a service
run-single start single runner
unregister unregister specific runner
verify verify all registered runners
artifacts-downloader download and extract build artifacts (internal)
artifacts-uploader create and upload build artifacts (internal)
cache-archiver create and upload cache artifacts (internal)
cache-extractor download and extract cache artifacts (internal)
cache-init changed permissions for cache paths (internal)
health-check check health for a specific address
read-logs reads job logs from a file, used by kubernetes executor (internal)
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--cpuprofile value write cpu profile to file [$CPU_PROFILE]
--debug debug mode [$RUNNER_DEBUG]
--log-format value Choose log format (options: runner, text, json) [$LOG_FORMAT]
--log-level value, -l value Log level (options: debug, info, warn, error, fatal, panic) [$LOG_LEVEL]
--help, -h show help
--version, -v print the version
登録に実行するコマンドは、以下のコマンドですが、、
gitlab-runner register
上記コマンドだと、インタラクティブなのですが、コマンドラインだけでやる方法もあります。
gitlab-runner register --non-interactive --locked=false --url=<URL> --registration-token=<token> --name=container-runner --tag-list=tag-runner --executor=docker --docker-privileged=true --docker-image=docker:20.10.15-dind
Shell
で、参考にしたサイトは
https://e-penguiner.com/build-gitlab-runner-with-docker/
です。
実行すると、上記の場合は質問されないです。いろいろなサイトで見つけるやり方だといくつか質問をしてくるので、上記手順でメモした内容で答えていきます。
実行タイプはdockerを選んだほうがdocker上のGitLabに認識してもらえるので、いいかと思います。
質問結果は以下に保存されます。
/etc/gitlab-runner/config.toml
編集のために、コンテナの名前を確認します。
docker-compose ps
仮に、
gitlab-web-1
というコンテナ名でgitlabが動作していたとします。
docker exec -it gitlab-web-1 bash
cd /etc/gitlab-runner
テキストエディタのviがインストールされていないので、インストールします。
apt-get update
apt-get install vim
*** gitlab-runnerのサービスのインストール [#x35928ae]
gitlab-runner install --user=gitlab-runner --working-directory=/home/gitlab-runner
実行は、
gitlab-runner run &
です。
停止は、
gitlab-runner stop
です。
* GitLabでSpecific Runnerが表示されたあと何をするのか？ [#w23b9f2e]
GitLab.comではShared Runnerは限定されますが、オンプレミスGitLabではShared RunnerとSpecific Runnerの両方が利用可能であり、全体的に共有されたRunnerの設定が便利です。
** Shared Runnerの設定 [#zf417668]
*** gitlab-runner registerで利用するトークンの取得 [#cca448a6]
GitLabのどこで、トークンを取得できるかというと、[Menu] > [Admin] を選択し，[Overview] > [Runner]を選択します
#ref(specific_token.png)
右上の「Register an instance runner」ボタンをクリックすると、gitlab-runner registerで利用するトークンを取得することができます。
*** gitlab-runner registerでのrunner登録例 [#f8714591]
dockerのgitlab-runnerコンテナ名がroot-runner-1だった場合のrunner登録例です
docker exec -it root-runner-1 gitlab-runner register --non-interactive --locked=false --url=<URL> --registration-token=<token> --name=container-runner --tag-list=tag-runner --executor=docker --docker-privileged=true --docker-image=docker:20.10.15-dind
* CI/CDの実行 [#y5f0ee9c]
** GitLabで、runnerの実行ユーザを設定する [#v70adc24]
GitLabのrunnerの実行ユーザは設定できます。
*** Advanced configuration [#saf9d403]
https://gitlab-docs.creationline.com/runner/configuration/advanced-configuration.html
設定ファイルは、それぞれのrunnerのdockerコンテナごとにあるような感じです。
設定ファイルの場所は、もしrootで実行しているならば、
/etc/gitlab-runner/config.toml
にあるし、rootでの実行ではないならば、それぞれのユーザの
~/.gitlab-runner/config.toml
にあります。
gitlab-runnerをdockerのイメージで実行している場合は、viエディタがインストールされていませんので、以下のコマンドでインストールする必要があります。
apt-get update
apt-get install vim
[runners.docker]
のuserを設定します
gitlab-runnerのコンテナですでに以下のユーザが登録されています。
gitlab-runner
** HelloWorld的な簡単な設定ファイル [#fe298203]
まずは、設定があっていれば必ず成功するレベルの簡単な自動実行をチュートリアルとしてやってみます。
以下の設定ファイルが簡単な設定ファイルと、紹介サイト(https://e-penguiner.com/build-gitlab-runner-with-docker/)には書いてありました。
*** シンプルな.gitlab-ci.yml [#se271657]
image: docker:20.10.15
services:
- docker:20.10.15-dind
variables:
DOCKER_DRIVER: overlay2
DOCKER_TLS_CERTDIR: ""
before_script:
- docker info
test_ci:
script:
- docker pull alpine:latest
- docker run alpine:latest cat /etc/alpine-release
tags:
- tag-runner
*** .gitlab-ci.ymlの実行のさせ方 [#s4c06c19]
ブランチを作って、上記ファイルを含むマージリクエストを作った時点で、動作するようになります。
このyamlファイルの仕様については、以下が元の記事らしいのですが、わかりにくいので、ほかの記事も参考にしていきましょう。
** 参考記事 [#y4588152]
*** 本家 [#obca6436]
https://gitlab-docs.creationline.com/ee/ci/yaml/
*** はじめてのGitLab-CI [#y9cf4771]
https://qiita.com/yurano/items/a7804d987ccff37b1a9d
*** JHipsterでのCI/CDの記事 [#q677e359]
https://www.jhipster.tech/setting-up-ci/#what-cicd-pipeline-do-you-want-to-generate-
* jhipsterの7.9.3のdockerfile [#o8d6f6e9]
https://hub.docker.com/layers/jhipster/jhipster/v7.9.3/images/sha256-0878e0666e88451f3487abc2bf4417368daa86d9d93e0dd659f93ce1e89161cc?context=explore
