JenkinsでRancherのKubernetes環境のアプリを更新〜EHW2018「開発環境整備⑩」


概要

このエントリは、「Enterprise "hello, world" 2018 Advent Calendar 2018」の12/24向けのものです。このAdvent Calendarでは、複数個のエントリにまたがる話の流れも鑑みつつ、なるべく1エントリで1つのトピックをカバーできるようにする予定です。

このエントリで記載するトピックは、JenkinsでRancherのKubernetes環境のアプリを更新することです。

下図のような世界で、JenkinsからKubernetes環境のアプリを更新します。

前提

おことわり

  • このEnterpfise "hello, world"シリーズは、ネタのためのエントリです。実環境でそのまま利用ことを目的とはしていません。
  • 動かしやすさを優先してセキュリティを意図的に低くする設定など入れてありますのでご注意ください。

想定読者

「Enterprise "hello, world" 2018」的なネタとしては、下記のような状況を想定しています。

GitLabのCIの結果をDocker Private Registryに配備したので、Kubernetes環境のアプリを更新しなければいけない。ただし、このステップはユーザがGUIから指示できるようにする。

JenkinsでRancher-cliを動かす

Rancher-cliをJenkinsコンテナで動かせるようにする

Rancher-cliのリリースページから、対応するバイナリを入手します。

作業フォルダを適当に決めます。本エントリでは、Jenkinsコンテナの中で、/var/jenkins-home/rancher-cliというディレクトリを作りました。

そのディレクトリの中で、rancher-cliを入手し、展開します。

$ ~/rancher-cli$ wget https://github.com/rancher/cli/releases/download/v2.2.0-rc9/rancher-linux-amd64-v2.2.0-rc9.tar.gz
$ ~/rancher-cli$ tar zxvf rancher-linux-amd64-v2.2.0-rc9.tar.gz 

アクセス用のTokenを入手する

RancherのUIにログインし、右上のアカウントのアイコンをクリック、「API & Keys」をクリックします。

右上の「Add Key」をクリックし、ダイアログでキーに適当な名前をつけます。本エントリでは「jenkins-cd」としました。

「Create」ボタンをクリックすると、APIの情報が表示されます。この画面でしか表示されない情報を含むので、どこかにメモしておきます。

「Close」ボタンをクリックすると一覧画面に戻り、いま作成したキーが表示されています。

ログイン

rancher-cliのloginコマンドで、上記で入手したbearer-tokenの文字列を用いて、ログインします。

~/rancher-cli$ ./rancher-v2.2.0-rc9/rancher login https://192.168.3.221:8443/v3 --token "token-79hvq:gc(省略)"

(表示されるメッセージは省略)

Do you want to continue connecting (yes/no)? yes
INFO[0089] Saving config to /var/jenkins_home/.rancher/cli2.json 

kubectlのインストール

kubectlインストールに関する説明サイトに従ってkubectlコマンドをJenkinsコンテナ内にインストールします。

サイトではいくつかの方法が示されていますが、このエントリでは、バイナリをcurlコマンドで手元に落としてくる方法を使います。落としてきたkubectlコマンドに実行権限をつけて(chmod +x)います。

~/rancher-cli$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
~/rancher-cli$ chmod +x kubectl 

Jenkinsからアプリを更新するためのパイプラインを作成

フォルダを作成

Jenkinsでジョブ軍をわかりやすくせいりするためのフォルダについて、本エントリでは下記のように作りました。

ehw2018>deployment>update-front-app

パイプラインを作成

以下のようなパイプラインを作成しました。

ごくかんたんなスクリプトですが、ポイントは、

  • 上記でインストールしたコマンド(rancher-cli, kubectl)へのパスをpipeline中のenvironmentで指定している
  • コンテナのみの更新であるため、Kubernates上でのアプリに関するメタデータの一部を時刻の文字列で更新し、リポジトリからコンテナを再読込させている 参考: rancherのコミュニティサイト
node {
}

pipeline {
    agent any
    environment {
        PATH = "/var/jenkins_home/rancher-cli/rancher-v2.2.0-rc9:/var/jenkins_home/rancher-cli:$PATH"
    }
    stages {
        stage('show os information') {
            steps {
                sh 'cat /etc/os-release'
                // sh 'rancher kubectl get all'
                sh """
                rancher kubectl patch deployment front-test -p   "{\\"spec\\":{\\"template\\":{\\"metadata\\":{\\"labels\\":{\\"date\\":\\"`date +'%s'`\\"}}}}}"
                """
            }
        }
    }
}

ソースを書き換えてPush〜デプロイまで

実行前のWEBサイト

ソースを書き換える

index.htmlで、タイトル部分を書き換えます。

Pushから新しいイメージ作成まで

書き換えたindex.htmlをcommitしてpushすると、別のエントリで紹介した流れで、GitLab runnerでテストが実施され、新しいコンテナのイメージが作成され、Git Private Repositoryに格納されます。

Jenkinsからアプリを更新

Jenkinsで、パイプラインのメニューから「Build Now」を実行すると、Rancher上のWorkloadが更新され(一時的にScaleが1から2になり、また1に戻るのが観察できるでしょう)

WEBサイトを再読込すると、タイトル部分の文字列が変更されているはずです。

まとめ

このエントリでは、「Enterprise "hello, world" 2018 Advent Calendar 2018」(EHW2018)の24日目として、JenkinsでRancherのKubernetes環境のアプリを更新することをトピックとして取り上げました。