05. Week5 Jenkins on Kubernetes - chuirang/DevOps GitHub Wiki

Jenkins 를 이용해 sampleapp을 kubernetes에 배포하기

절차

1. 코드를 GitHub 리포에 저장
2. Jenkins 에서 Credential 생성
3. Jenkins Job 생성

1. 코드를 GitHub 리포에 저장

1.1 기본 코드를 작성

user@u2004-master:~/04_cicd$ tree .
.
├── docker
│   ├── app.py
│   └── Dockerfile
├── Jenkinsfile
└── k8s
    ├── deployment.yaml
    └── service.yaml

docker 하위의 app.py, Dockerfile과 k8s 하위의 yaml 파일은 Week 2의 실습 코드를 그대로 사용하시면 됩니다.

1.2 Jenkinsfile 수정

소스코드 위치에 Jenkinsfile 복사해오고(cp /tmp/Jenkinsfile .) 아래와 같이 수정한다.

..
  // 각 Credential ID를 아래 네이밍룰에 따라 수정 _ line 46, 47
  // 네이밍룰 : {username}_kubeconfig, {username}_kubeconfig
  environment {
    DOCKER_CREDENTIAL_ID = "wonkilee_dockerhub"
    K8S_CREDENTIAL_ID = "wonkilee_kubeconfig"
  }
..
      // 각자의 github ID와 repository로 수정 _ line 60
      steps {
        git branch: 'main', url: 'https://github.com/chuirang/DevOps.git'
      }
..

Jenkinsfile을 git에 저장하는 의미:

Jenkins 의 pipeline 을 Jenkins GUI에서 작성할 수 있지만, Jenkins pipeline을 수정하기 위한 관리포인트가 추가되고 pipeline을 변경해도 변경사항을 기록으로 남길 수 없다.

Jenkinsfile로 pipeline을 코드로 정의하면, Git을 통하여 코드로 관리할 수 있고, 코드의 변경사항을 기록할 수 있다. 모든 코드와 설정은 코드로 작성되고 관리할 필요가 있다.

1.3 GitHub 리포지터리 생성

이후 Jenkins Pipeline의 Checkout 단계에서 개인 github 저장소로 부터 소스코드를 끌어오기 위해 리포지터리를 생성한다.

1. GitHub 접속 > sign in > 좌측 상단의 [New] 를 눌러 Repository 생성

2. Repository name 입력 후 [Create repository] 을 누른다

Github 정책 변경으로 plain username/password 로는 더이상 git push 가 되지 않는다. (2021/8/13일 부터)

아래의 절차로 Personal access token을 생성한다.

1. 우측 상단 개인프로필 > settings > Developer settings > Personal access tokens > Generate new token

2. 아래와 같이 설정 후 [Generate token] 을 누른다.

• Note: git_acess_token
• Selet scopes: repo 체크

3. 화면에 노출된 Token을 복사해 둔다. (이 화면은 다시 확인불가하므로 반드시 노트패드에 복사해둘 것)

1.4 GitHub 로 소스코드 동기화

코드가 있는 상단 위치에서 아래와 같이 명령어 수행한다.

git init
git add -A
git commit -m "first commit"
git config --global user.email "[email protected]"  // 각자의 github mail
git config --global user.name "your name"   // 각자의 이름
git branch -M main
git remote add origin https://github.com/{Github_ID}/{Repo_Name}.git
git push -u origin main

• git push 에서 1.3에서 생성한 Personal access token을 패스워드로 사용한다.

예시)

user@u2004-master:~/04_sample$ ls
docker  Jenkinsfile  k8s
user@u2004-master:~/04_sample$ git init
Initialized empty Git repository in /home/user/04_sample/.git/
user@u2004-master:~/04_sample$ git add -A
user@u2004-master:~/04_sample$ git commit -m "first commit"
[master (root-commit) 8106e8d] first commit
 5 files changed, 159 insertions(+)
 create mode 100644 Jenkinsfile
 create mode 100755 docker/Dockerfile
 create mode 100755 docker/app.py
 create mode 100755 k8s/deployment.yaml
 create mode 100755 k8s/service.yaml

# 이미 설정되어 있어 git config --global 은 생략

user@u2004-master:~/04_sample$ git config --global -l
[email protected]
user.name=wonki lee
user@u2004-master:~/04_sample$ git branch -M main
user@u2004-master:~/04_sample$ git remote add origin https://github.com/chuirang/Devops_Sample.git
user@u2004-master:~/04_sample$ git push -u origin main
Username for 'https://github.com': user
Password for 'https://[email protected]': (*Personal access token을 패스워드로 사용)
Enumerating objects: 9, done.
Counting objects: 100% (9/9), done.
Delta compression using up to 4 threads
Compressing objects: 100% (9/9), done.
Writing objects: 100% (9/9), 2.06 KiB | 234.00 KiB/s, done.
Total 9 (delta 0), reused 0 (delta 0)
To https://github.com/user/Devops_Sample.git
 * [new branch]      main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.
user@u2004-master:~/04_sample$

정상적으로 push가 되면 GitHub 리포지터리를 새로고침 했을 때 아래와 같이 보인다.

2. Jenkins 에서 Credential 생성

2.1 GitHub credential 설정 (public repository 이므로 생략)

2.2 Docker Hub credential 설정

Docker 이미지 빌드가 끝나면 쿠버네티스에서 해당 이미지를 사용하기 위해 Docker Hub에 저장해야한다. Docker Hub에 저장하기 위해서 인증 정보가 필요한데, Jenkins의 Credential 로 저장하여 Pipeline에서 사용한다.

아래의 절차로 Docker Hub 인증을 위한 credential을 생성한다.

• 네이밍룰 : {username}_dockerhub

1. Jenkins 접속 > 좌측 창에서 Manage Jenkins 클릭 > Manage Credential 클릭 > 하단 표에서 Jenkins 클릭 > Global credentials (unrestricted) 클릭

2. 좌측 창에서 Add Credentials 클릭 후 아래와 같이 작성

• Kind: Username with password
• Scope: Global
• Username: (DockerHub ID)
• password: (DockerHub Password)
• ID: 네이밍룰에 따라 입력 (ex. wonkilee_dockerhub)
• Description: (Optional)

생성한 Credential ID가 Pipeline에서 참조하는 값이다.

2.3 Kubeconfig credential 설정:

Jenkins Pipeline 의 마지막 단계에서 Deploy를 수행하는데, 이 때 API Server 와 인증하기 위한 kubeconfig을 Jenkins 의 credential로 등록한다.

아래의 절차로 pipeline의 Deploy stage에서 kubectl 을 사용할 때 참조하는 credential을 생성한다.

• 네이밍룰 : {username}_kubeconfig

1. Jenkins 접속 > ㅍ측 창에서 Manage Jenkins 클릭 > Manage Credential 클릭 > 하단 표에서 Jenkins 클릭 > Global credentials (unrestricted) 클릭

2. 좌측 창에서 Add Credentials 클릭 후 아래와 같이 작성

• kind: Kubernetes configuration (kubeconfig)
• Scope: Global
• ID: 네이밍룰에 따라 입력 (ex. wonkilee_kubeconfig)
• Description: (Optional)
• kubeconfig: Enter directly 선택 > 마스터 노드의 아래의 결과를 복사하여 Content에 입력한다.

  $ cat ~/.kube/config
  

생성한 Credential ID가 Pipeline에서 참조하는 값이다.

3. Jenkins Job 생성

GitHub 의 repository에서 Jenkinsfile을 가져오도록 Job을 생성한다.

1. Jenkins > 좌측의 New item

2. item name을 Week5_username 으로 입력하고 [Pipeline] 을 선택하고 [OK] 버튼을 누른다.

3. 아래와 같이 입력 후 [Save] 를 누른다.

• Pipeline

  Definition: Pipeline scriptPipeline script from SCM

  SCM: Git

  Repository URL: 앞서 생성한 github repository 를 입력

  Branch Specifier: */main

4. 생성이 완료된 Job에서 Build Now 를 누르면, 하단에 Build History가 확인된다.

5. 정상적인 경우 아래와 같이 Stage View가 우측화면 확인된다.

6. Build History의 Build #1 으로 이동하고, 좌측의 Console Output 을 눌러보면 pipeline 실행과정을 확인 할 수 있다.

---