Jenkins Setup - aragorn/home GitHub Wiki

installation

setup an Ubuntu Server
- JDK
- git
install jenkins on ubuntu server
https://www.rosehosting.com/blog/install-jenkins-on-an-ubuntu-14-04-vps/
setup ldap configuration

plugins

기본 plugin 에 추가하여 설치하는 플러그인

Git plugin
Cron Column Plugin
Grails plugin
user build vars plugin
inheritance-plugin

사용할 것인지 여부를 잘 모르겠다...

Build Pipeline Plugin ?
- Delivery Pipeline Plugin ?

HTTP Proxy 설정

Jenkins 관리 > 플러그인 관리 > 고급 메뉴에서 HTTP Proxy 를 설정할 수 있다.
서버, 포트 등을 지정한 후, 화면의 가장 아래 오른쪽에 보이는 "지금 확인" 버튼을 누르면, 업데이트 사이트로부터 갱신이 가능하다. 여기에서 설정한 프록시 설정은 이후 JDK, Grails 자동설치 등에서도 사용된다.

ldap setup

사내 LDAP 설정 가이드를 따라 설정하면 Configure Global Security 설정으로 로그인 기능이 작동한다.

git and credentials

사내 github 에서 source code 를 clone 하기 위해서는 접근권한을 얻어야 한다. 이를 위한 설정방법이 여러가지가 있으나, jenkins 가 설치된 서버에서 ssh-keygen 으로 ssh public/private key 를 생성하고, 이 public key 를 github repository 에 추가하는 방법을 사용한다.
- jenkins 가 설치된 서버에서 ssh-keygen 을 실행한다.
  ubuntu server 에서 위의 설치 가이드에 따라 jenkins 를 설치하면, jenkins 라는 계정이 생성되고, 홈디렉토리가 /var/lib/jenkins 로 지정된다. su - jenkins 로 jenkins 계정의 권한을 얻은 후, ssh-keygen 명령을 실행한다. /var/lib/jenkins/.ssh/id_rsa.pub 파일이 생성된 것을 확인한다.
- github repository 에서 settings 메뉴에 들어가면, Deploy keys 를 추가할 수 있다.
  Add deploy key 버튼을 선택하고, title 에는 jenkins@hostname 정도의 구분값을 입력하고, Key 에 방금 생성한 id_rsa.pub 의 값을 복사하여 넣는다.
- jenkins 웹인터페이스의 Jenkins > Credentials > Global credentials (unrestricted) 메뉴에서 Add Credentials 를 통해 인증 정보를 입력한다.
  Kind 는 SSH Username with private key, Scope 은 Global, Username 은 jenkins@hostname, Private Key 는 From the Jenkins master ~/.ssh 를 선택한다.
jenkins 의 item configure 에서 앞에서 설정한 값들을 사용한다.
소스코드 관리를 Git 으로 선택한 후, Repository URL, Credentials 를 설정한다. 이후 빌드 테스트 과정에서 정상적으로 소스코드를 가져오는지 확인한다.

JDK, Grails Setup

Jenkins 관리 > 시스템설정 메뉴의 설정만으로 JDK, Grails 를 설치할 수 있다.

Maven Project Configuration

내부 maven repository 에 접근하지 못한다는 에러 메시지가 발생할 수 있다.
~/.m2/settings.xml 의 문제로 추측하고 여러가지 시도를 해 보았으나, 실제 문제의 원인은 proxy 서버의 접근제어 문제였다. Build With Grails 의 프로퍼티 설정에서 다음과 같이 http.nonProxyHosts 설정을 추가하여 내부서버는 proxy 서버를 통하지 않도록 설정한다.
```
grails.env=sandbox
https.proxyHost=proxy.mycompany.io
https.proxyPort=3128
http.proxyHost=proxy.mycompany.io
http.proxyPort=3128
http.nonProxyHosts=localhost|127.0.0.0/8|192.168.0.0/16|10.0.0.0/8|172.16.0.0/12|*.mycompany.io|*.companycorp.com|*.mycompany.net|*.mycompany.com
```

JVM Options By Environment Variables

JVM 실행 옵션을 추가하기 위해 환경변수를 설정할 필요가 있다. 예를 들어 target 을 war 로 하여 빌드를 진행하는 도중, 메모리 부족으로 빌드가 실패하는 경우가 발생할 수 있다. Grails Build 설정에서는 JVM 옵션을 변경하기 위한 설정을 제공하지 않는 것으로 보인다.
Environment Injector Plugin 을 설치하면, Build Configure 에서 'Inject environment variables to the build process' 항목이 추가된다. 이 설정에서 아래와 같은 옵션을 추가할 수 있다.
- JAVA_OPTS=-server -noverify -Xms2G -Xmx6G -XX:+UseParallelGC

codenarc and violations plugin

Grails 에서 codenarc plugin 을 BuildConfig.groovy 에 적용하고, Jenkins 에서 Violations 플러그인을 설치하면, codenarc 의 정적 분석 결과를 jenkins 에서 바로 확인할 수 있다.

violations 플러그인 홈페이지나 문서에서 친절한 설정방법을 알려주지 않아서 설정 과정이 까다롭다면 까다롭다.

jenkins 에서 violations plugin 을 설치한 후, Project configuration 에서 Violations Report 를 생성할 수 있다. '빌드 후 조치' 항목에서 'Report Violations' 항목을 선택하면 된다. Freestyle project 뿐만 아니라, Inheritance project 유형에도 이 설정을 추가할 수 있다.
codenarc 를 사용하는 경우, XML filename pattern 으로 **/CodeNarc-Report.xml 와 같은 값을 입력하면 된다. 빌드가 성공하면, 해당 빌드를 상세조회하는 화면의 왼쪽 메뉴에 Violations 라는 메뉴가 추가된 것을 확인할 수 있다. 이 메뉴를 선택하면, 분석 리포트를 살펴볼 수 있다.
Grails 의 경우, multi-module project 를 사용하는 경우가 많다. 이 경우, 리포트 생성 후 각 파일의 상세 리포트를 조회할 수 없는 현상이 발생할 수 있다. XML 기반의 리포트와 소스코드 연결을 하지 못해서 나타나는 현상인데, 이 문제를 해결하려면 Project configuration 에서 Faux Project Path 라는 값을 적절히 입력하여야 한다. 이 값을 어떻게 입력해야 하는지 문서에서 잘 설명하지 않는데, 이 값은 jenkins 의 workspace + project directory 경로를 대체하는 값이며, 절대경로를 입력해야만 한다.
- https://github.com/jenkinsci/violations-plugin/blob/master/src/main/java/hudson/plugins/violations/ViolationsCollector.java
  이 코드의 private void doType(), findFiles(workspace, name) 메쏘드를 참고하면 된다. Faux Project Path 가 설정된 경우, workspace 가 이 설정값으로 대체된다.
사내 CI 서버에서 사용한 Faux Project Path 설정값은 아래와 같다.
- /var/lib/jenkins/workspace/sandbox.grails2.common.codenarc/common
- /var/lib/jenkins - 젠킨스 홈디렉토리 경로이며, ubuntu 서버의 기본 설정값이다.
- workspace - 젠킨스에서 사용하는 워크스페이스 경로
- sandbox.grails2.common.codenarc - 젠킨스에서 설정한 Project 의 이름
- common - Grails 의 module 이름
  common/grails-app/, common/src/ 과 같은 경로에 실제 소스코드가 위치한다.

Slave Instances

slave 노드를 추가로 구성한다.

http://systemscitizen.com/2014/05/02/ubuntu-jenkins-slave-using-ssh/
새로운 VM 인스턴스를 생성한다.
- slave node 에는 jenkins 를 apt-get 으로 설치하지 않는다.
- JDK 를 설치한다.
/etc/group, /etc/passwd 의 마지막 그룹, 계정의 GID, UID 를 확인한다.
- 이번 서버의 경우, ntp group 이 GID 111, UID 106 이다.
- jenkin 를 설치하는 경우, 다음과 같은 계정이 만들어진다.
  jenkins:x:107:112:Jenkins,,,:/var/lib/jenkins:/bin/bash
sudo groupadd -g 112 jenkins
sudo useradd -u 107 -g 112 -c Jenkins -m -d /var/lib/jenkins -s /bin/bash jenkins
su - jenkins
.ssh/authorized_keys 에 master 노드 jenkins 계정의 ssh public key 를 복사해서 넣는다.
master node 의 jenkins 계정에서 slave node 로 ssh 연결되는지 확인한다. 인증 없이 연결되어야 한다.
master node 의 젠킨스 웹인터페이스에서 slave node 를 구성한다.
- Credential 설정에 주의해야 한다. Credential 설정을 생성할 때, Username 지정을 주의해야 한다.
  Kind 는 SSH Username with private key, Scope 은 Global, Username 은 jenkins, Private Key 는 From the Jenkins master ~/.ssh 를 선택한다. Username 을 jenkins@hostname 으로 지정하면 master node 에서 slave node 로 연결되지 않게 된다.
slave node 연결 후, 동시에 실행할 job 의 수 등을 설정한 후, job 을 실행한다.
- slave node 에 git 이 설치되어 있지 않다면, 에러가 발생할 수 있다. sudo apt-get install git --yes 로 git 을 설치한다.
- jenkins 에서 사용할 JDK, Grails 등이 slave node 에서 자동으로 설치된다.

Grails and Jenkins

가상서버의 메모리를 8GB 로 할당한 경우, Grails Build 작업을 4개 이상 실행하면, 메모리 부족으로 작업이 정상적으로 실행되지 않는다. Grails Build 과정에서 Java 프로세스가 RSS 2.5GB 이상 사용하는 상태를 종종 확인할 수 있다. 8GB 서버 기준으로 최대 3개 작업을 동시에 실행하도록 설정한다.
best practice to estimate java heap size
- http://www.mkyong.com/java/find-out-your-java-heap-memory-size/
- http://docs.oracle.com/cd/E15523_01/web.1111/e13814/jvm_tuning.htm#PERFM150
아래와 같이 최소 heap size 를 줄이면, 실행 도중 최대 메모리가 1.6GB 정도로 줄어든다.
JAVA_OPTS=-server -noverify -Xms512M -Xmx4G -XX:+UseParallelGC
java heap size 의 적절한 설정값을 알아내기 위해 충분한 테스트가 필요하다.