こんにちは。iQeda [@iQeeeda] です。

CI/CD ツールって有名どころだと Jenkins とか CircleCI がありますが、そこで質問です。

…僕はぶっちゃけありませんでした。

CI/CD ツールの敷居が高い問題

実際、仕事であんまり CI/CD ツールを触ったことがないけど「興味だけはある！」
そんな駆け出しエンジニアの方って多いと思います。

そんな印象もあると思うんですよね。

CircleCI の使い方・設定を徹底解説！

今回は実践的に CircleCI という CI/CD ツールで何ができるか解説しようと思います。

そもそも CI/CD ツールとは？

言葉としてはこういう意味ですが覚えなくていいです。
CI と CD の説明・区別があやふやだったりするので。

自動化すると単純にラクですし、コマンドの実行漏れ・間違いもなくなります。
CircleCI の場合は GitHub にプッシュすれば後は勝手にやってくれます！

CircleCI 前提知識: GitHub・サーバ SSH が可能

さて「CircleCI を出来るだけ分かりやすく説明する」とは書きましたが、前提知識は必要です。以下の準備だけしておいてください。

CircleCI 設定ファイルを作成して GitHub にプッシュする

config.yml の書き方

早速ですが CircleCI の設定ファイルを書いてみましょう。

対象のプロジェクトファイルの直下に .circleci という隠しフォルダを作成して、
中に config.yml という設定ファイルを置きます。

version: 2

jobs:
    # build ジョブ: CircleCI 上で Docker コンテナを作成してテストする
    build:
        docker:
            - image: alpine
        steps:
            - checkout
            - run:
                name: Echo Test
                command: echo "CircleCI Test"
    # deploy ジョブ: EC2 に SSH 接続して、デプロイを実行する
    deploy:
        machine:
            image: circleci/classic:edge
        steps:
            - checkout
            # CircleCI に登録した秘密鍵を呼び出す
            - add_ssh_keys:
            # CircleCI に登録した環境変数を使って SSH
            - run: ssh ${USER_NAME}@${HOST_NAME} 'cd [あなたのプロジェクトへのパス] && git pull'

workflows:
    version: 2
    # build_and_deploy ジョブ: 一番最初に呼ばれるジョブ
    build_and_deploy:
        # build ジョブと deploy ジョブを登録する
        jobs:
            - build
            - deploy:
                requires:
                    # 依存性あるから deploy ジョブより先に build ジョブを実行してね、という命令
                    - build
                # master ブランチに push された場合のみ deploy ジョブを実行する
                filters:
                    branches:
                        only: master

完成したら、このファイルを GitHub リポジトリにプッシュしておいてください。

この config.yml が行うこと

この config.yml ファイルによって CircleCI サーバ上では以下のことが行われます。

build ジョブと deploy ジョブがなにをしているのか？…を詳しくみていきます。

build ジョブ

CircleCI サーバ上で Docker コンテナを起動する

CircleCI サーバ上では Docker のコンテナを起動することができます。
そのコンテナで GitHub のコード (今回は master ブランチのコード) を動かせるのです。

今回は話を簡単にするため alpine という Docker イメージファイルでコンテナを作成して、
echo "CircleCI Test" するだけ…ということを build ジョブ内でやりました。

deploy ジョブ

deploy ジョブでは、以下を定義しています。

CircleCI サーバが EC2 インスタンスに ssh するには

EC2 インスタンス上で秘密鍵 (pem ファイル) を作成して CircleCI に登録する必要があります。

また、どのサーバアドレスに、どのユーザでログインするか？
…も環境変数 (HOST_NAME / USER_NAME) として CircleCI に登録しておく必要があります。

その設定方法については後述します。

EC2 インスタンス上で GitHub を使えるようにするには？

こちらの記事で詳しく解説しているのでご覧ください。

秘密鍵と公開鍵

秘密鍵・公開鍵は必要なので、サーバに存在するか確認してください。
そして秘密鍵の文字列をコピーしておいてください。

cd ~/.ssh

# id_rsa.pub と id_rsa があるか確認する
ls

# 秘密鍵を表示して、文字列をコピーしておく
cat ~/.ssh/id_rsa

CircleCI にログインしてからの作業

利用する GitHub リポジトリをフォローする

CircleCI にログインして、利用する GitHub リポジトリをフォローします。

サイドメニューの「ADD PROJECTS」を選び、
リポジトリ名の横にある「Follow Project」ボタンを押してください。

環境変数と SSH パーミッションを設定する

サイドメニューの「WORKFLOWS」を選択して、歯車アイコンを選択してください。

環境変数を設定する

「Environment Variables」を選択してください。

「Add Variable」ボタンから環境変数を追加します。

以下の環境変数を追加してください。

SSH パーミッションを設定する

「SSH Permissions」を選択してください。

「Add SSH Key」ボタンからパーミッションを追加します。

以下の値を追加してください。

プッシュしてジョブを確認する

CircleCI が上手く動作するか master ブランチにプッシュして確認してみてください。
サイドメニューの「JOBS」を選ぶと CircleCI の実行結果を見ることができます。

「build」ジョブ「deploy」ジョブ、それぞれ成功したか失敗したか表示されます。

シンプルな CircleCI によるデプロイ自動化ですが、基本はこのやり方です。
あとは自分で設定ファイルをいじって色々と拡張してみてください。

関連記事