古き良きRailsアプリケーションをコンテナ化してKubernetes上で動かす

![eyecatch_2103RailsApponKubernetes.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/218415/2384713d-fc90-02f9-772c-1596e8924f6f.png)


※ 本稿は [Tech Inside Drecom](https://tech.drecom.co.jp/?_src=qiita) に掲載された記事、「[古き良きRailsアプリケーションをコンテナ化してKubernetes上で動かす](https://tech.drecom.co.jp/migrate-rails-app-to-container//?_src=qiita)」の Qiita 出張版です。

---

<h2><strong>はじめに</strong></h2>

<p>こんにちは、enzaプラットフォーム事業本部でエンジニアをやっている安藤です。<br>
運用しているプロダクトの本番環境をAmazon EC2からAmazon EKSに移行する日が来まして、良い機会なのでこれまでやってきた対応をまとめてみました。</p>

<p>と言っても、EKS周りのことは特に言及しません。<br />
タイトルの通り、Railsアプリケーションをコンテナ化してKubernetes上で動かすための対応について書いています。<br>
DockerやKubernetesの仕組みなどの説明は端折っているので、ご了承ください。</p>

<p>Kubernetesが普及して久しいですが、「運用中のサービスを移行したいけど、結構大変だな...」というプロダクトも多いのでは無いかと思います。<br>
この記事が、そういったプロダクトの移行作業の助けになれば、嬉しい限りです。</p>

<h2><strong>移行前のシステム</strong></h2>

<figure class="wp-block-image">
<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/218415/bef3bd2b-fb79-c733-ddea-0965cf50679f.jpeg"/>

<figcaption><strong>EKS移行前のシステム</strong></figcaption></figure>

<p>すごくざっくりした図なのはご容赦ください。<br>
まぁ、よくある構成ですよね。</p>

<h2><strong>抱えていた課題点</strong></h2>

<p>わりと長く運用しているサービスなので色々抱えていた課題はあるのですが、今回の載せ替えのモチベーションになったのはこの辺りです。</p>

<ul><li>スケールイン・アウト等のオペレーションコストがかかる <ul><li>手順や注意点が多く、属人化しやすい（触ってた人が辞めたらアウト）</li><li>できる人がなかなか増えない</li><li>作業が面倒くさい </li></ul></li><li>言語やライブラリのアップデートが大変 <ul><li>マシンイメージ作り直してインスタンスを全部取り替えたり</li><li>プロビジョニングツール流さないといけなかったり</li><li>うむ、面倒くさい </li></ul></li></ul>

<h2><strong>課題に対するアクション</strong></h2>

<p>行ったことは大きく分けてこの2点。</p>

<ul><li>Railsアプリをコンテナ化する <ul><li>Rubyのバージョンアップやライブラリの追加をするときはDockerfileを更新するだけで済む </li></ul></li><li>Kubernetes上で動かす <ul><li>インフラがPod / ReplicaSet / Deployment / Service等のリソースに抽象化される</li><li>インフラ構成をマニフェストファイルで一元的に管理できる</li><li>コード化されるため誰でも読めるし書ける（Infrastructure as Code） </li></ul></li></ul>

<p>他にもAmazon EKS周りの作業など色々とアツい移行話もあるのですが、あまりにボリューミーなので、それはまた次の機会に。</p>

<h2><strong>移行後</strong>のシステム</h2>

<figure class="wp-block-image">

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/218415/026b21af-e9a7-5a55-5ba6-74a92188d2e0.jpeg" />

<figcaption><strong>EKS移行後のシステム</strong></figcaption></figure>

<p>移行後はこうなりました。<br>
レッツコンテナオーケストレーション。</p>

<h2><strong>Railsアプリをコンテナ化する</strong></h2>

<p>コンテナで動くようにしていなかったので、以下の対応を実施。</p>

<ol><li>Dockerfileを書く</li><li>コンフィグを整理する</li></ol>

<h3>1. Dockerfileを書く</h3>

<p>まずは構成をどうするかですが、移行前から変える理由もなかったので、</p>

<ul><li>Rails（Unicorn）+ Nginxの構成でコンテナはそれぞれ分ける</li></ul>

<p>という形にしました。</p>

<h4>Nginx</h4>

<p>ディレクトリ構成はこう。</p>

<pre class="wp-block-syntaxhighlighter-code">- docker
  - nginx
    - templates
      - nginx.conf.tmpl
      - （設定系のファイルが諸々）
    - Dockerfile</pre>

<p>次にDockerfileですが、環境ごとに<code>nginx.conf</code>の設定値を変えたかったので、<a rel="noreferrer noopener" aria-label=" (新しいタブで開く)" href="https://github.com/progrium/entrykit" target="_blank">Entrykit</a>を使ってテンプレートのレンダリングを行っています。<br>
そういった事情がないのであれば、<a rel="noreferrer noopener" aria-label="公式イメージ (新しいタブで開く)" href="https://hub.docker.com/_/nginx" target="_blank">公式イメージ</a>を使えばいいかなと思います。</p>

<pre class="wp-block-syntaxhighlighter-code">ARG NGINX_VERSION=1.15.12

FROM nginx:${NGINX_VERSION}-alpine

ARG ENTRYKIT_VERSION=0.4.0
RUN apk add --no-cache openssl ＆＆ \
    wget https://github.com/progrium/entrykit/releases/download/v${ENTRYKIT_VERSION}/entrykit_${ENTRYKIT_VERSION}_Linux_x86_64.tgz ＆＆ \
    tar -xvzf entrykit_${ENTRYKIT_VERSION}_Linux_x86_64.tgz ＆＆ \
    rm entrykit_${ENTRYKIT_VERSION}_Linux_x86_64.tgz ＆＆ \
    mv entrykit /bin/entrykit ＆＆ \
    chmod +x /bin/entrykit ＆＆ \
    entrykit --symlink ＆＆ \
    rm -rf /etc/nginx/nginx.conf.default /etc/nginx/conf.d/*

WORKDIR /etc/nginx

COPY templates/ /etc/nginx/

EXPOSE 80

ENTRYPOINT [ \
  "render", "/etc/nginx/nginx.conf", "--", \
  "/usr/sbin/nginx", "-c", "/etc/nginx/nginx.conf" \
]</pre>

<h4><strong>Rails</strong></h4>

<p>何も考えずにDockerfileを書いてビルドすると、イメージサイズが1GB超えてて吐き気を催したりします。<br>
軽量化しないとビルドやらプッシュやらに時間がかかって仕方ないので工夫必須。</p>

<p>よく書かれている対応方法のまんまですが、手を打ったのはこの2点。</p>

<ol><li><a rel="noreferrer noopener" aria-label="Alpine Linuxベース (新しいタブで開く)" href="https://alpinelinux.org/" target="_blank">Alpine Linuxベース</a>のRubyコンテナを使う</li><li><a rel="noreferrer noopener" aria-label="Multi-stage builds (新しいタブで開く)" href="https://docs.docker.com/develop/develop-images/multistage-build/" target="_blank">Multi-stage builds</a>を使う</li></ol>

<h4><strong>1. Alpine LinuxベースのRubyコンテナを使う</strong></h4>

<p>要するに、ベースとなるコンテナを軽量なものにしました。<br>
Linuxとかの操作に慣れていると「え、ログインシェルがash？なにそれ」という感じになりますが、使い方さえ分かれば気にならないし、Kubernetes上で動かすようになったらコンテナにログインする機会自体が少ないので、特に支障はなかったです。</p>

<h4><strong>2. Multi-stage buildsを使う</strong></h4>

<p>bundle installはビルドステージで行い、最終的なステージには必要な成果物だけを持っていくようにして、サイズを軽くしました。<br>
Multi-stage buildsを使わなくても、ビルド時に生まれた不要なファイルを手動で削除していけば軽くできるのですが、使ったほうがDockerfileもスッキリするし良いかなと思います。</p>

<h4><strong>できたDockerfileはこちら</strong></h4>

<pre class="wp-block-syntaxhighlighter-code"># syntax = docker/dockerfile:experimental
# BuildKitを有効にしている

# ステージ共通で使うargs
ARG RUBY_VERSION=2.5.8
ARG ALPINE_VERSION=3.12
ARG BUNDLER_VERSION=1.17.3
ARG BASE_PACKAGES="busybox-suid git openssh shadow tzdata logrotate"

FROM ruby:${RUBY_VERSION}-alpine${ALPINE_VERSION} as builder

# Multistage buildsの場合はステージ内で再定義が必要
ARG BUNDLER_VERSION
ARG BUNDLE_OPTIONS
ARG BASE_PACKAGES
ARG BUILD_PACKAGES="alpine-sdk build-base linux-headers mariadb-dev"
ARG BUNDLE_OPTIONS="--jobs 4 --local --quiet --deployment --binstubs bin --without development test deploy"

COPY Gemfile* /
COPY vendor/cache /vendor/cache

RUN --mount=type=secret,id=ssh,target=/root/.ssh/id_rsa \
    apk add --no-cache ${BASE_PACKAGES} ${BUILD_PACKAGES} ＆＆ \
    chmod 700 /root/.ssh ＆＆ \
    ssh-keyscan -H github.com ＞＞ /root/.ssh/known_hosts ＆＆ \
    gem install bundler --version ${BUNDLER_VERSION} --no-document ＆＆ \
    bundle config set path /vendor/bundle ＆＆ \
    bundle install ${BUNDLE_OPTIONS} ＆＆ \
    find /vendor/bundle/ruby -path "*/gems/*/ext/*/Makefile" -exec dirname {} \; | xargs -n1 -I{} make -C {} clean

FROM ruby:${RUBY_VERSION}-alpine${ALPINE_VERSION}

ARG BUNDLER_VERSION
ARG BASE_PACKAGES
ARG RUN_PACKAGES="execline mariadb-client-libs openrc"
ARG APP_ROOT=/app
ARG APP_PORT=3000
ARG TIME_ZONE=Asia/Tokyo
# Rubyの公式イメージの設定を上書きする
ENV BUNDLE_APP_CONFIG ${APP_ROOT}/.bundle

WORKDIR ${APP_ROOT}

# 成果物だけをビルドステージから持ってくる
COPY --from=builder /vendor/bundle ${APP_ROOT}/vendor/bundle
COPY --from=builder /usr/local/bundle ${BUNDLE_APP_CONFIG}
COPY . ${APP_ROOT}

RUN apk add --no-cache ${BASE_PACKAGES} ${RUN_PACKAGES} ＆＆ \
    cp /usr/share/zoneinfo/${TIME_ZONE} /etc/localtime ＆＆ \
    gem install bundler --version ${BUNDLER_VERSION} --no-document ＆＆ \
    bundle config set path ${APP_ROOT}/vendor/bundle

# UnicornのSocketファイルをtmp配下に置くためNginxのコンテナからアクセスできるようにする
VOLUME ${APP_ROOT}/tmp
VOLUME ${APP_ROOT}/public

EXPOSE ${APP_PORT}

# プロセスの起動はシェルスクリプトにまとめている
ENTRYPOINT ["./entrypoint.sh"]</pre>

<p>思ったよりボリューミーなDockerfileになってしまいましたが、結果としては約350MBまでサイズダウンに成功。<br>
しかし、軽量化したとはいえビルド時間が4分くらいかかるのが気になりました。</p>

<h4>そこで<strong>BuildKit先生の登場</strong></h4>

<p>「ビルド時間かかりすぎなんだけど…」<br>
そんなときは、Docker v18.09から正式な機能に昇格した<a href="https://github.com/moby/buildkit" target="_blank" rel="noreferrer noopener" aria-label="Buildkit (新しいタブで開く)">Buildkit</a>先生の力を借ります。</p>

<p>これを使うと、命令の並列実行であったり正確なキャッシュ判定であったりを、なんか上手いことやってくれます。（雑）<br>
Dockerfileにちょっと記述を加えるだけなので、試して損はないと思います。</p>

<p>必要な作業は、</p>

<h5>1. 環境変数の設定</h5>

<pre class="wp-block-syntaxhighlighter-code">export DOCKER_BUILDKIT=1</pre>

<h5>2. Dockerfileの先頭にShebang的な記述を追加</h5>

<pre class="wp-block-syntaxhighlighter-code"># syntax = docker/dockerfile:experimental</pre>

<p>以上です。<br>
あとはビルドするだけ！</p>

<p>結果としては約60秒ほどビルドが速くなり、そしてビルド中の出力が格好良くなりましたw<br>
Buildkit先生やりますね。<br></p>

<p>それと、Bundle install時にプライベートリポジトリのGemにアクセスするので、<a rel="noreferrer noopener" aria-label="--secret (新しいタブで開く)" href="https://docs.docker.jp/develop/develop-images/build_enhancements.html#new-docker-build-secret-information" target="_blank">--secret</a>というオプションも使っています。<br></p>

<p>Multi-stage buildsを使っていれば、機密情報がレイヤーに残ってしまう問題は気にしなくて良いと思いますが、まぁせっかくなので。</p>

<p>これでDockerfileのほうは完成です。</p>

<h4>テスト</h4>

<p>Dockerfileが完成したところで、動作検証を行います。<br>
諸々の対応が終わって「よしデプロイだ！」ってときに「・・・動かない」ってなるのは辛いですからね。。</p>

<p>Docker Composeを使って、パパッとローカルで動かせるようにします。</p>

<pre class="wp-block-syntaxhighlighter-code">version: '3.1'

services:
  rails:
    image: rails:test # ローカルでビルドしたイメージを指定
    container_name: api
    build:
      context: ./
    volumes:
      - app-log-data:/app/log
      - public-data:/app/public
      - tmp-data:/app/tmp
    ports:
      - 3000:3000
    env_file:
      - env_files/rails.env # 必要な環境変数を定義しておく
  nginx:
    image: nginx:test # ローカルでビルドしたイメージを指定
    container_name: web
    build:
      context: docker/nginx
    volumes:
      - nginx-log-data:/var/log
      - public-data:/app/public
      - tmp-data:/app/tmp
    ports:
      - 80:80
    depends_on:
      - rails
    env_file:
      - env_files/nginx.env # 必要な環境変数を定義しておく

volumes:
  app-log-data:
  nginx-log-data:
  public-data:
  tmp-data:</pre>

<p>YAMLが書けたら<code>docker-compose up</code>してコンテナを起動。<br>
あとはCurlコマンドなりで疎通確認ができればOKです。</p>

<h3>2. <strong>コンフィグを整理する</strong></h3>

<p>続いてコンフィグ周りの整理となります。<br>
移行前のシステムでは、環境ごとのコンフィグの管理は<a rel="noreferrer noopener" aria-label="Global (新しいタブで開く)" href="https://github.com/railsware/global" target="_blank">Global</a>というGemを使っていました。</p>

<p><code>config/deploy</code>配下に環境ごとの設定を用意して、Capistranoを使ってデプロイを行なうため、同じく環境ごとの設定値を定義できるGlobalとの相性がとても良かったのです。</p>

<p>しかし、コンテナ化してKubernetes上で動かすとなるとシステム自体が変わるため、環境ごとの設定値を管理する仕組みを考え直す必要がありました。</p>

<p>コンフィグは大きく分けて、</p>

<ol><li>コンテナのビルド時に必要なもの<ul><li>DBの接続情報やNginx・Unicornの設定など</li></ul></li><li>アプリケーションの起動以降に必要なもの<ul><li>AWSリソースの接続情報やサービス特有の設定など</li></ul></li></ol>

<p>の2種類があります。</p>

<p>Kubernetesには<a rel="noreferrer noopener" aria-label="ConfigMap (新しいタブで開く)" href="https://kubernetes.io/ja/docs/concepts/configuration/configmap/" target="_blank">ConfigMap</a>/<a rel="noreferrer noopener" aria-label="Secret (新しいタブで開く)" href="https://kubernetes.io/ja/docs/concepts/configuration/secret/" target="_blank">Secret</a>というリソースがあるので、コンテナのビルド時に必要な設定は、それを使うことにしました。<br>
アプリケーションの起動以降に必要なものもConfigMap/Secretにしようかと思ったのですが、長く運用しているサービス故に相当な量のConfigがあり環境も多いため、さすがに管理が厳しいと判断。</p>

<p>アプリケーションの起動以降に必要な設定は、Railsの<a rel="noreferrer noopener" aria-label="Custom-configuration (新しいタブで開く)" href="https://guides.rubyonrails.org/configuring.html#custom-configuration" target="_blank">Custom-configuration</a>を使用して管理することにしました。<br></p>

<p><a rel="noreferrer noopener" aria-label="dry-configurable (新しいタブで開く)" href="https://github.com/dry-rb/dry-configurable" target="_blank">Dry-configurable</a>のようなGemを使うか迷いましたが、Railsの機能で十分かなと。</p>

<p>ふむ、これで方針は決まりました。</p>

<h3><strong>どう移行するか</strong></h3>

<p>移行時に困ったこととしては、既存のコードはありとあらゆるコンフィグがCapistrano+Globalありきの仕組みになっており、それを何とかする必要があるということでした。<br>
環境ごとにセットした変数をもとにテンプレートファイルをレンダリングして、生成したYAMLをデプロイするという仕組みなので、各環境のサーバーにしか完成されたYAMLファイルが存在しないのが厄介です。</p>

<p>もちろん、運用中のサービスなので「あ、DBの接続先間違えちゃった。えへへ」は許されません。<br>
やり方は色々あるのでしょうが、何が何でも安心安全に移行していかねば。。</p>

<p>悶々と考えた結果、</p>

<ol><li>正しい情報は、機械が生成した各環境のサーバーにあるYAMLファイル</li><li>間違える可能性があるのは、人間が新しく生成するCustom-configuration用のYAMLファイル</li></ol>

<p>そう、間違えるのはいつも人間！<br></p>

<p>ということで、「1.」の値を正として「2.」の値を検証するRakeタスクを作成することにしました。</p>

<h3><strong>Rakeタスクを作る</strong></h3>

<p>と、タスクを作っていく前に、Custom-configurationの設定を書いていく必要があります。</p>

<p>（ついでにリファクタしたい気持ちをグッと堪えて）GlobalとCustom-configurationでコンフィグのKey/Valueは全く同じにして、Custom-configurationの設定はどこからも参照されないようにしておきます。</p>

<p>Custom-configurationでもGlobalのように機能ごとに設定ファイルを定義することができるので、</p>

<pre class="wp-block-syntaxhighlighter-code"># config/example.yml
shared:
  foo:
    bar:
      baz: 1

development:
  foo:
    bar:
      qux: 2

production:
  foo:
    bar:
      qux: 3</pre>

<p>というようなコンフィグを作っていきます。<br></p>

<p>そして<code>application.rb</code>で、</p>

<pre class="wp-block-syntaxhighlighter-code"># config/application.rb
module MyApp
  class Application &lt; Rails::Application
    config.x.example = config_for(:example)
  end
end</pre>

<p>というように定義しておけば、<br></p>

<pre class="wp-block-syntaxhighlighter-code"># development environment
Rails.application.x.example[:foo][:bar] #=> { baz: 1, qux: 2 }</pre>

<p>こういう使い方ができるようになるという代物です。</p>

<p>ふむ、良さそう。</p>


<p>しかしここで、Globalを使っていたが故に、とある問題にぶつかってしまいました。<br>
そう...Globalは、</p>

<pre class="wp-block-syntaxhighlighter-code">Global.example.foo.bar #=> { baz: 1, qux: 2 }</pre>

<p>深い階層までドットでアクセスできてしまうのです！</p>

<p>でもまぁこれくらいは想定の範囲内です。<br>
「僕らには<a href="https://github.com/hashie/hashie" target="_blank" rel="noreferrer noopener" aria-label="Hashie (新しいタブで開く)">Hashie</a>があるぜ。ふへへ」と余裕綽々で調整してみたところ、なぜかうまく動かず。</p>

<p>「そんな馬鹿な...なぜだ...？」と焦りを隠しきれないまま調べていたところ、コンフィグ内の一部のKeyがHashの予約語に被っており使えないことが判明しまして。（確か<code>default</code>というKey）</p>

<p>今回は人間を信じないという方針で進行しており、手動での対応は避けたい。<br></p>

<p>ということで思いついた苦肉の策がこちら。</p>

<pre class="wp-block-syntaxhighlighter-code"># config/application.rb
module MyApp
  class Application &lt; Rails::Application
    # コンフィグ内のNestされたHashにもドットでアクセスできるようにする
    # HashではなくOpenStructを使っているのは、コンフィグのKeyがdefaultといったHashの予約語を使ってしまっているため
    def define_nested_custom_config(config_hash)
      config_hash.each_with_object(OpenStruct.new) do |(k, v), s|
        if v.is_a?(Hash)
          v = define_nested_custom_config(v)
        end
        s.send("#{k}=", v)
      end
    end

    Pathname.glob(Rails.root.join("config", "custom", "*.yml")) do |f|
      k = f.basename(".*").to_s
      h = config_for(f).deep_symbolize_keys
      custom = define_nested_custom_config(h)
      config.x.send("#{k}=", custom)
    end
  end
end</pre>

<p>OpenStructを使ってドットでアクセス出来るようにしました。<br>
うーん、移行時の安全確保のためとはいえ、なかなか辛い実装になってしまいましたね...。<br>
今思えば、もう少し他に使えるGemがないか調査を行っても良かったかもしれません。</p>

<p>しかし、これでようやく準備は整いました！<br>
あとは検証用のRakeタスクを作成すれば完成です。</p>

<pre class="wp-block-syntaxhighlighter-code">task :check_custom_config => :environment do
  Global.configuration.to_hash.keys.each do |key|
    custom_config_hash = Rails.configuration.x.send(key)
    global_config_hash = Global.send(key).to_hash.deep_symbolize_keys

    next if custom_config_hash == global_config_hash

    puts "Not match config! key:#{key}"
  end
end</pre>

<p>それぞれのコンフィグの値が完全に合致しない場合、メッセージが出力されるようにしました。<br>
これを各環境にデプロイして、実行して周ります。</p>

<p>恥ずかしいほどに愚直な手法でしたが、YAMLファイルの修正を確実に行うことができました。<br>
修正を施してすべての環境で合致することを確認したら、最後はえいやっ！</p>

<pre class="wp-block-syntaxhighlighter-code">git grep -l 'Global\.' | xargs sed -i '' -e 's/Global\./Rails\.configuration\.x\./g’</pre>

<p>（ここまで検証しておいて最後はまさかの手動）</p>

<p>このRakeタスクでの検証・修正作業のおかげで、コンフィグ移行ミスによる障害を起こすことなく、対応を完了することができました！</p>

<h2><strong>Kubernetes上で動かす</strong></h2>

<p>さて、コンテナ化ができたら次はそれをKubernetes上で動かすようにします。<br>
やることは以下の3点。</p>

<ol><li>マニフェストを書く</li><li>ツールを使ってマニフェストを管理する</li><li>CI/CDからデプロイする</li></ol>

<h3>1. マニフェストを書く</h3>

<p>今回使うKubernetesのリソース一覧はこちら。<br></p>

<ul><li>Namespace</li><li>Deployment</li><li>Service</li><li>ConfigMap</li><li>Secret</li><li>HorizontalPodAutoscaler</li><li>Job</li></ul>

<p>各リソースについての理解やマニフェストの書き方を知るには、やはり<a rel="noreferrer noopener" aria-label="Kubernetesの公式ドキュメント (新しいタブで開く)" href="https://kubernetes.io/ja/docs/home/" target="_blank">Kubernetesの公式ドキュメント</a>を見るのが一番良かったです。</p>

<p>では、それぞれのマニフェストと考慮した点を紹介していきます。<br>
一部の設定値は記事用の適当なものになっているので、ご了承ください。</p>

<h4><a href="https://kubernetes.io/ja/docs/concepts/overview/working-with-objects/namespaces/" target="_blank" rel="noreferrer noopener" aria-label="Namespace (新しいタブで開く)">Namespace</a></h4>

<p>これは至極単純。<br>
クラスター内に名前空間を作るためのリソースです。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: v1
kind: Namespace
metadata:
  name: develop</pre>

<p>使うのは名前空間を作るとき、つまりは1回こっきりです。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/workloads/controllers/deployment/" target="_blank" rel="noreferrer noopener" aria-label="Deployment (新しいタブで開く)">Deployment</a></strong></h4>

<p>PodやReplicaSetを管理するためのリソースです。<br>
RailsとNginxの2つのコンテナで1つのPodが構成されています。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  strategy:
    type: RollingUpdate
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
  selector:
    matchLabels:
      app: app
  template:
    metadata:
      labels:
        app: app
    spec:
      containers:
      - name: app-rails
        image: app-rails
        imagePullPolicy: IfNotPresent
        resources:
          requests:
            cpu: 50m
            memory: 400Mi
        lifecycle:
          preStop:
            exec:
              command: ["rc-service", "unicorn-app", "stop"] # Graceful shutdown
        envFrom:
        - configMapRef:
            name: app-config
        - secretRef:
            name: app-secret
        ports:
        - containerPort: 3000
        volumeMounts:
        - name: app-assets
          mountPath: /app/public
        - name: app-sock
          mountPath: /app/tmp/sockets
      - name: app-nginx
        image: app-nginx
        imagePullPolicy: IfNotPresent
        resources:
          requests:
            cpu: 50m
            memory: 100Mi
        readinessProbe:
          httpGet:
            path: /heartbeat
            port: 80
          initialDelaySeconds: 60
          timeoutSeconds: 5
        livenessProbe:
          httpGet:
            path: /heartbeat
            port: 80
          initialDelaySeconds: 120
          timeoutSeconds: 5
        lifecycle:
          preStop:
            exec:
              command: ["/usr/sbin/nginx","-s","quit"] # Graceful shutdown
        envFrom:
        - configMapRef:
            name: app-config
        ports:
        - containerPort: 80
        volumeMounts:
        - name: app-assets
          mountPath: /app/public
          readOnly: true
        - name: app-sock
          mountPath: /app/tmp/sockets
      restartPolicy: Always
      terminationGracePeriodSeconds: 35 # Unicorn/SidekiqのTimeoutが30なので少し長く設定
      volumes:
      - name: app-assets
        emptyDir: {}
      - name: app-sock
        emptyDir: {}</pre>

<p>他のリソースに比べると書くことが多いですが、ポイントとなる点としては、</p>

<ul><li>Resources</li><li>Lifecycle</li><li>ReadinessProbe/LivenessProbe</li></ul>

<p>あたりですかね。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/configuration/manage-resources-containers/" target="_blank" rel="noreferrer noopener" aria-label="Resources (新しいタブで開く)">Resources</a></strong></h4>

<p>設定できる項目はこちら。</p>

<div style="height:20px" aria-hidden="true" class="wp-block-spacer"></div>

<ul><li>Requests<ul><li>デプロイするのに最低限必要なリソース量を指定できる</li><li>Worker Nodeのリソース使用量を見ないでデプロイしようとする</li><li>Cluster AutoScalerのNode数やサイズと想定を合わせておかないと、デプロイしてもリソース足りなくてずっとPendingみたいなことが起きてしまう</li></ul></li><li>Limits<ul><li>アプリが使用可能なリソース量を指定できる</li><li>上限を超えるとコンテナのプロセスがKillされて再起動<br></li></ul></li></ul>

<p>ここに関しては弊社のインフラエンジニア・<a rel="noreferrer noopener" aria-label="外道父さんの記事 (新しいタブで開く)" href="http://blog.father.gedow.net/2019/11/14/eks-kubernetes-resource/" target="_blank">外道父さんの記事</a>がとても勉強になるのでお勧めです。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/containers/container-lifecycle-hooks/" target="_blank" rel="noreferrer noopener" aria-label="Lifecycle (新しいタブで開く)">Lifecycle</a></strong></h4>

<p>設定できる項目はこちら。</p>

<ul><li>PostStart<ul><li>コンテナが作成された直後に実行される</li><li>ただし、フックがコンテナのENTRYPOINTの前に実行されるという保証はない</li><li>失敗した場合はコンテナを終了させて、restartPolicyに従い再起動させる</li></ul></li><li>PreStop<ul><li>コンテナが終了する直前に呼び出される</li><li>コンテナがすでに終了状態または完了状態にある場合、呼び出しは失敗する<br></li></ul></li></ul>

<p>今回扱うのはPreStopのほう。<br>
「ユーザーのリクエストを処理中にPodを終了しちゃう」といった無邪気な事故を起こさないためにも、ここの設定はしっかり入れておく必要があります。</p>

<p>Podの終了処理については<a href="https://qiita.com/superbrothers/items/3ac78daba3560ea406b2" target="_blank" rel="noreferrer noopener" aria-label="Kubernetes: 詳解 Pods の終了 (新しいタブで開く)">Kubernetes: 詳解 Pods の終了</a>の記事が参考になりました。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/" target="_blank" rel="noreferrer noopener" aria-label="ReadinessProbe/LivenessProbe (新しいタブで開く)">ReadinessProbe/LivenessProbe</a></strong></h4>

<p>Probeには、</p>

<ul><li>LivenessProbe<ul><li>コンテナが動いているか</li><li>失敗するとKubeletはコンテナをRestartさせる</li></ul></li><li>ReadinessProbe<ul><li>コンテナがServiceのリクエストを受けられるか</li><li>失敗するとServiceからそのPodのIPアドレスが削除される<br></li></ul></li></ul>

<p>という2種類があります。<br>
LivenessProbeのほうは、いわゆる死活監視なので特筆することはないです。<br>
今回ポイントになるのはReadinessProbeのほう。</p>

<p>「PodがRunning状態 = トラフィックが受けられる状態」とは限らないため、設定しておかないと「Unicornが起動しきってないのにトラフィックを受け始めちゃう」みたいなことが起きるので要注意です。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/services-networking/service/" target="_blank" rel="noreferrer noopener" aria-label="Service (新しいタブで開く)">Service</a></strong></h4>

<p>Podへの接続を解決してくれる抽象的なリソースです。<br>
Serviceを介して通信するPodは、Selectorによって決定されます。</p>

<p>（Kubernetesを触り始めた初期、Serviceがピンとこず迷走した記憶があります...）</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: v1
kind: Service
metadata:
  name: app-np
spec:
  type: NodePort
  selector:
    app: app
  ports:
  - nodePort: 30000
    port: 80</pre>

<p>EKSではアプリケーションを外部に公開する場合、<a rel="noreferrer noopener" aria-label=" (新しいタブで開く)" href="https://github.com/kubernetes-sigs/aws-load-balancer-controller" target="_blank">ALB Ingress Controller</a>を使う方法が主流かと思いますが、「移行するときに既存のALBを利用したい」「Terraformで管理したい」という都合があったので、NodePortを使う形にしています。</p>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/configuration/configmap/" target="_blank" rel="noreferrer noopener" aria-label=" (新しいタブで開く)">ConfigMap</a></strong></h4>

<p>アプリケーションの設定情報を扱うリソースです。<br>
分かりやすいので、これは特筆すること無しですね。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
data:
  DB_NAME: "hoge"
  ...</pre>

<h4><strong><a href="https://kubernetes.io/ja/docs/concepts/configuration/configmap/" target="_blank" rel="noreferrer noopener" aria-label="Secret (新しいタブで開く)">Secret</a></strong></h4>

<p>クレデンシャルなどの秘密情報を扱うリソースです。<br>
base64形式で保存されます。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: v1
kind: Secret
metadata:
  name: app-secret
type: Opaque
data:
  SECRET_KEY_BASE: "ZnVnYQ=="
  ...</pre>

<p>ただ、そもそもこういう情報がGitHubにコミットされること自体が危険なので、<a rel="noreferrer noopener" aria-label="AWS KMS (新しいタブで開く)" href="https://aws.amazon.com/jp/kms/" target="_blank">AWS KMS</a>などを使って管理するのが望ましいと思います。</p>

<h4><strong><a href="https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/" target="_blank" rel="noreferrer noopener" aria-label="HorizontalPodAutoscaler (新しいタブで開く)">HorizontalPodAutoscaler</a></strong></h4>

<p>DeploymentのReplica数を制御するためのリソースです。<br>
その名の通り、CPUなどのメトリクスに応じて自動的にPodを水平分散してくれます。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: autoscaling/v2beta1
kind: HorizontalPodAutoscaler
metadata:
  name: app-hpa
spec:
  scaleTargetRef:
    apiVersion: apps/v1
    kind: Deployment
    name: app
  minReplicas: 1
  maxReplicas: 2
  metrics:
  - type: Resource
    resource:
      name: cpu
      targetAverageUtilization: 40</pre>

<p>使用するためには<a href="https://github.com/kubernetes-sigs/metrics-server" target="_blank" rel="noreferrer noopener" aria-label="メトリクスサーバー (新しいタブで開く)">メトリクスサーバー</a>をデプロイするのをお忘れなく。</p>

<h4><strong><a href="https://kubernetes.io/docs/concepts/workloads/controllers/job/" target="_blank" rel="noreferrer noopener" aria-label="Job (新しいタブで開く)">Job</a></strong></h4>

<p>Podが正常に完了したことを追跡するためのリソースで、1つ以上のPodを作成して、指定された数が正常に終了することを保証してくれます。<br>
指定された数が正常に終了するとJobが完了状態となり、Jobを削除するとそのJobによって作成されたPodも削除されます。</p>

<pre class="wp-block-syntaxhighlighter-code">apiVersion: batch/v1
kind: Job
metadata:
  name: app-migrator
spec:
  backoffLimit: 1 # リトライ回数
  parallelism: 1 # 並列数
  completions: 1 # 完了数
  template:
    metadata:
      labels:
        app: migrator
    spec:
      containers:
        - name: app-migrator
          image: app-rails
          envFrom:
            - configMapRef:
                name: app-config
            - secretRef:
                name: app-secret
      restartPolicy: Never # 失敗時にコンテナを再起動しない</pre>

<p>今回はJobを使ってDBのマイグレーションを行っています。<br>
実行するスクリプトは、<a rel="noreferrer noopener" aria-label="Kubernetes の Job でマイグレーションを実行する (新しいタブで開く)" href="https://blog.manabusakai.com/2018/04/migration-job-on-kubernetes/" target="_blank">Kubernetes の Job でマイグレーションを実行する</a>の記事で紹介されているものを参考にさせて頂きました！</p>

<p>Kubernetesでのマイグレーションって、結局どの方法が一番いいんでしょうねぇ。</p>

<h4><strong>テスト</strong></h4>

<p>マニフェストファイルが書けたところで、実際に<code>kubectl apply</code>でマニフェストを適用して動作検証をします。<br>
ここで検証しておけば、CIからデプロイしたら「ずっとPodがCrashLoopBackOffなんだけど？」という悲しい思いをしないで済みます。（多分）</p>

<p>ローカルでマニフェストファイルの検証を行うときは、<a rel="noreferrer noopener" aria-label="Minikube (新しいタブで開く)" href="https://kubernetes.io/ja/docs/tutorials/hello-minikube/" target="_blank">Minikube</a>が便利でした。<br>
ローカルのDockerイメージを使うように設定出来て、Amazon ECRなどのリポジトリにプッシュしなくて済むので、作業がだいぶ楽になります。</p>

<p>やり方は<a rel="noreferrer noopener" aria-label="minikubeでローカルのdocker imageを使う (新しいタブで開く)" href="https://qiita.com/ocadaruma/items/efe720e46ae7ecb9ec25" target="_blank">minikubeでローカルのdocker imageを使う</a>の記事がまとめてくれているので、そちらを参考にしてみてください。</p>

<h3>2. ツールを使ってマニフェストを管理する</h3>

<p>今回は<a rel="noreferrer noopener" aria-label="Kustomize (新しいタブで開く)" href="https://github.com/kubernetes-sigs/kustomize" target="_blank">Kustomize</a>というツールを使って、環境ごとのマニフェストを管理・生成できるようにしました。<br>
KustomizeはKubernetesのマニフェストをパッケージングできるツールで、Kubectl v1.14.0にて統合されています。</p>

<p>基盤となるベース構成に各環境ごとのカスタマイズを加えてパッケージングが可能で、出力される単一のYAMLファイルをどのようにKubernatesに適用するかは使う側の自由です。  <br><a rel="noreferrer noopener" aria-label="Overlay (新しいタブで開く)" href="https://kubectl.docs.kubernetes.io/references/kustomize/glossary/#overlay" target="_blank">Overlay</a>という機能を使うことで、ベースとなるマニフェストに対してパッチを当てることができるので、</p>

<ul><li>各環境で共通となる設定はベースにする</li><li>各環境で異なる設定のみパッチを当てる<br></li></ul>

<p>ということが出来て、嵩張りがちなマニフェストのYAMLファイルをスッキリさせることができます。<br>
また、ConfigMapやSecretにハッシュ値を付与してバージョン管理することができるので、ロールバックに対応させることも可能です。</p>

<p>Overlayというのがどういう機能かと言うと、</p>

<pre class="wp-block-syntaxhighlighter-code">- k8s
  - base
    - deployment.yaml
    - kustomization.yaml
  - develop
    - deployment_conf.yaml
    - kustomization.yaml
  - production
    - deployment_conf.yaml
    - kustomization.yaml</pre>

<p>こういうベースとなるマニフェストファイル群と環境ごとのマニフェストファイル群があるとして。</p>

<pre class="wp-block-syntaxhighlighter-code"># k8s/base/kustomization.yaml

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: base-namespace
commonLabels:
  app: base-label
configMapGenerator:
- name: app-config
secretGenerator:
- name: app-secret
resources:
- deployment.yaml</pre>

<pre class="wp-block-syntaxhighlighter-code"># k8s/base/deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  selector:
    matchLabels:
      app: app
  template:
    metadata:
      labels:
        app: app
    spec:
      containers:
      - name: app-rails
        image: app-rails
        imagePullPolicy: IfNotPresent
        resources:
          requests:
            cpu: 50m
            memory: 400Mi
  ...</pre>

<p>このようにベースとなる<code>kustomization.yaml</code>と<code>deployment.yaml</code>を用意します。<br>
そして次に環境特有の設定を、</p>

<pre class="wp-block-syntaxhighlighter-code"># k8s/production/kustomization.yaml

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
bases:
- ../base
namespace: production
commonLabels:
  app: production
patchesStrategicMerge:
- deployment_conf.yaml</pre>

<pre class="wp-block-syntaxhighlighter-code"># k8s/production/deployment_conf.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  template:
    spec:
      containers:
      - name: app-rails
        resources: # 本番環境用のResourcesの設定値を当てる
          requests:
            cpu: 1000m
            memory: 3500Mi</pre>

<p>という感じで作ります。<br>
こうすることで、ベースとなるDeploymentのマニフェストに対して、Resourcesの値だけを環境特有の値に更新することができるようになります。</p>

<p>環境ごとに丸々<code>deployment.yaml</code>を書くよりは、だいぶスッキリしますね。</p>

<p>実際にデプロイするときには、</p>

<pre class="wp-block-syntaxhighlighter-code"># マニフェストが想定通りになっているか確認
kubectl kustomize k8s/production
# 本番環境用のマニフェストをレンダリングして適用
kubectl apply -k k8s/production</pre>

<p>というコマンドで実行することができます。</p>

<h4><strong>その他のマニフェスト管理ツール</strong></h4>

<p>Kustomizeの他にも<a rel="noreferrer noopener" aria-label="Helm (新しいタブで開く)" href="https://helm.sh/" target="_blank">Helm</a>とか<a rel="noreferrer noopener" aria-label="CDK for Kubernetes (新しいタブで開く)" href="https://cdk8s.io/" target="_blank">CDK for Kubernetes</a>とかツールの選択肢は結構あります。</p>

<p>その中で今回Kustomizeを選定した理由としては、</p>

<ul><li>カスタマイズの自由度が高い</li><li>学習コストが低い<br></li></ul>

<p>という点は大きかったです。<br>
ただ、実際に対応を終えた後に改めて振り返ると「Kustomizeじゃ厳しいか...」という場面もありました。<br></p>

<p>このあたりはやってみて分かったことなので、これから見直していきたいなと思っています。</p>

<h3>3. <strong>CI/CDからデプロイする</strong></h3>

<p>さて、あとはデプロイするのみですね。<br>
今回のプロダクトでは<a rel="noreferrer noopener" aria-label="CircleCI (新しいタブで開く)" href="https://circleci.com/ja/" target="_blank">CircleCI</a>を使っているので、その設定の書き方となっていますが、どのツールを使うにしてもやることは大体同じだと思います。</p>

<p>ということで、デプロイするための<code>config.yml</code>はこんな具合です。</p>

<pre class="wp-block-syntaxhighlighter-code">version: 2.1
...
jobs:
  deploy:
    executor: deploy_executor # デプロイ用のexecutorを用意
    parameters:
      current_stage: # デプロイ先の環境を定義
        type: enum
        enum: ["develop", "production"]
      eks_cluster: # デプロイ先のクラスターを定義
        default: "develop"
        type: enum
        enum: ["develop", "production"]
    environment: # ECRのリポジトリを指定
      RAILS_IMAGE: xxx.dkr.ecr.ap-northeast-1.amazonaws.com/app-rails
      NGINX_IMAGE: yyy.dkr.ecr.ap-northeast-1.amazonaws.com/app-nginx
    steps:
      - run:
          name: set secret access key
          command: |
            echo 'export AWS_ACCESS_KEY_ID="$APP_AWS_ACCESS_KEY_ID"' ＞＞ $BASH_ENV
            echo 'export AWS_SECRET_ACCESS_KEY="$APP_AWS_SECRET_ACCESS_KEY"' ＞＞ $BASH_ENV
      - run:
          name: setup kubectl
          command: |
            aws configure set region ap-northeast-1
            aws eks update-kubeconfig --name ＜＜ parameters.eks_cluster ＞＞ --region ap-northeast-1
      - checkout
      - setup_remote_docker:
          version: 18.09.3
      - run:
          name: build image
          command: |
            docker version
            $(aws ecr get-login --no-include-email --region ap-northeast-1)
            export DOCKER_BUILDKIT=1
            docker build --no-cache --secret id=ssh,src="/home/circleci/.ssh/id_rsa" -t app-rails .
            docker build --no-cache -f docker/nginx/Dockerfile -t app-nginx docker/nginx/
      - run:
          name: push image
          command: |
            RAILS_IMAGE_NAME=${RAILS_IMAGE}:$(git rev-parse HEAD)
            docker tag app-rails ${RAILS_IMAGE_NAME}
            docker push ${RAILS_IMAGE_NAME}
            NGINX_IMAGE_NAME=${NGINX_IMAGE}:$(git rev-parse HEAD)
            docker tag app-nginx ${NGINX_IMAGE_NAME}
            docker push ${NGINX_IMAGE_NAME}
      - run:
          name: create namespace
          command: |
            kubectl apply -f k8s/＜＜ parameters.current_stage ＞＞/namespace.yaml
      - run:
          name: migration
          command: |
            # ここを参考にしてスクリプトを作成
            # https://blog.manabusakai.com/2018/04/migration-job-on-kubernetes/
            ./.circleci/migration.sh ＜＜ parameters.current_stage ＞＞
      - run:
          name: deploy
          command: |
            cd k8s/base
            RAILS_IMAGE_NAME=${RAILS_IMAGE}:$(git rev-parse HEAD)
            NGINX_IMAGE_NAME=${NGINX_IMAGE}:$(git rev-parse HEAD)

            # ビルドしたイメージを使うように置き換え
            kustomize edit set image \
            "app-rails=${RAILS_IMAGE_NAME}" \
            "app-nginx=${NGINX_IMAGE_NAME}"

            # マニフェストを生成して適用
            cd ..
            kubectl kustomize ＜＜ parameters.current_stage ＞＞
            kubectl apply -k ＜＜ parameters.current_stage ＞＞</pre>

<p>やっていることは、</p>

<ol><li>ビルドの準備</li><li>イメージのビルド（ECR）</li><li>イメージのプッシュ（ECR）</li><li>Namespaceの作成（無ければ）</li><li>マイグレーション</li><li>デプロイ<br></li></ol>

<p>となります。</p>

<p>基本的にコードに書いてある通りなのですが、「6. デプロイ」の「ビルドしたイメージを使うように置き換え」という部分がポイントになるかなと思います。</p>

<p>デプロイ後に問題が発生した場合にロールバックが行えるように、イメージのタグにGitのHEADのハッシュ値をつけてECRにプッシュしています。<br>
ここでプッシュしたイメージを使用してPodをデプロイするためには<code>deployment.yaml</code>の、</p>

<pre class="wp-block-syntaxhighlighter-code">spec:
  template:
    spec:
      containers:
      - name: app-rails
        image: app-rails # ← ココ</pre>

<p>にタグを含めて指定する必要があり、それを可能にするのが<code>kustomize edit set image</code>というコマンドです。<br>
これを使うことで、イメージのタグの指定を更新した上でマニフェストを適用することが出来ます。</p>

<p>こいつは便利ですね。<br>
あとは実際にデプロイして動作確認するだけ。</p>

<p>これでようやく、アプリケーションをコンテナ化してKubernetes上で動かすところまでこぎつけることができました！</p>

<h2>まとめ</h2>

<p>長々と「コンテナ化してKubernetes上で動かす」ための作業について書かせて頂きました。</p>

<p>Kubernetesは学習コストが高いという話をよく聞きます。<br>
確かに難しいし、いまだによく分かっていない部分が多いというのが正直なところです。</p>

<p>しかし今後、というか既にKubernetesを触ることはスタンダードだと思うので、本番環境の移行にチャレンジするというのは、良いアクションだったのではないかと感じています。</p>

<hr class="wp-block-separator"/>

<p>Kubernetes上で動かせるようにもなったし、次はGitOpsやProgressive Deliveryに挑戦してみようと、プロダクトメンバーたちと目論んでいます！</p>

<p>そんな目論みやKubernetes周りのことを、自分とプロダクトメンバーが執筆しているので、気が向いたらそちらの記事もぜひm(_ _)m</p>

<ul><li><a rel="noreferrer noopener" aria-label="俺、今期が終わったらGitOpsするんだ (新しいタブで開く)" href="https://tech.drecom.co.jp/ac2020-beginning-gitops/?_src=qiita" target="_blank">俺、今期が終わったらGitOpsするんだ</a></li><li><a rel="noreferrer noopener" aria-label="CI、CD、そしてPDにて (新しいタブで開く)" href="https://tech.drecom.co.jp/ac2020-ci-cd-pd/?_src=qiita" target="_blank">CI、CD、そしてPDにて</a></li><li><a href="https://tech.drecom.co.jp/ac2020-k0sk8sk9s/?_src=qiita" target="_blank" rel="noreferrer noopener" aria-label="k0sのk8sをk9sで見てみた (新しいタブで開く)">k0sのk8sをk9sで見てみた</a></li></ul>

<h2><strong>本当はまだまだ積もる話があるんだ！</strong></h2>

<p>まだまだ移行作業での積もる話は尽きず、</p>

<ul><li>EKS周りの設計・リソース作り</li><li>ログ収集どうするんだ問題</li><li>どうにもDNS周りが安定しない</li><li>ダウンタイム無しでどう本番環境をEC2EKSに載せ替えればいいのか<br></li></ul>

<p>などなど、話したいことが沢山あります。<br></p>

<p>ぜひ続編を書けたらと思いますので、機会があればまた読んで頂けたら嬉しいです。</p>

<p>それでは、また。</p>

---

ドリコムでは一緒に働くメンバーを募集しています！
募集一覧は[コチラ](https://bit.ly/2QKNSlG)を御覧ください！

※ その他の Tech Inside Drecom の記事は、[コチラ](https://tech.drecom.co.jp/?_src=qiita)からお探しいただけます！