【CodePipeline×ElasticBeanstalk】JavaアプリケーションをCodePipelineでElasticBeanstalkにCI/CDする その2


Javaアプリケーション(データベースから値を取得し、JSON形式で結果を返す)をCodePipelineでElasticBeanstalkにCI/CDするハンズオンです。
【CodePipeline×ElasticBeanstalk】JavaアプリケーションをCodePipelineでElasticBeanstalkにCI/CDする その1
の続きです。

環境

  • OS:Windows10
  • IDE:Eclipse 2020-03
  • JDK:Amazon Correto 8
  • フレームワーク:Spring Boot
  • AWS
    • CodePipeline
      • CodeCommit
      • CodeBuild
      • CodeDeploy
    • Elastic Beantalk
      • Java SE(Java 8 バージョン 2.10.8)
        → 異なるプラットフォームブランチ(Corretto 11など)でも同手順でできます。
      • RDS:MySQL Community Edition(バージョン8.0.17)

手順

3. Elastic Beanstalk環境の作成

続いて、Elastic Beanstalk環境を作成します。
環境作成 → EC2起動してしまうと、課金の対象になってしまうので、できれば手順5のパイプラインの作成まで一気に駆け抜けるのがベスト!
手順1 ,2でちょっと疲れたな―って方は一度お休みして、気力が回復してから臨んでください。

では、いってみましょー!

[1] 環境、アプリケーションの新規作成

(1) AWSマネジメントコンソールにログインし、「サービス」(①) > 「Elastic Beanstalk」を探してクリック。

(2) ナビゲーションペインにて、「環境」をクリック。

(3) 「新しい環境の作成」をクリック。

(4) 「ウェブサーバー環境」を選択し(①)、「選択」をクリック(②)。

(5)「ウェブサーバー環境の作成」ページに遷移するので、以下の通り入力・設定し、「より多くのオプションの設定」をクリック(⑨)。

No 名称 設定内容
アプリケーション名 sample-eb-java
環境名 アプリケーション名を入力すると自動で入力される(※1)
プラットフォーム Java
プラットフォームのブランチ Java 8 running on 64bit Amazon Linux
プラットフォームのバージョン 2.10.9:Recommendedとなっているもの
アプリケーションコード 「コードのアップロード」を選択
ソースコード元 「ローカルファイル」を選択
ファイルを選択 「1-[4]jarファイルの作成」で作成したjarファイルをアップロード(※2)

※1:すでに同名の環境が存在する場合は、環境名の後ろに「-n」(nは数字)が入る。
※2:プラットフォームブランチにJava 8を選択した場合は、代わりに
Elastic Beanstalk での Java の開始方法 | awsより、
「java-se-jetty-gradle-v3.zip」を取得し、使用してもOK。

(6) オプションの設定画面に遷移します。全容は以下のキャプチャの通り。

今回は、

  • ①:ソフトウェア
  • ②:ネットワーク
  • ③:データベース

の3つに手を入れます。

(7) まず、①ソフトウェアから。
「ログのストリーミング」の「有効」にチェックを入れ、画面下方の「保存」をクリック。
こうしておくことで、ログが見られるようになるので、環境でのエラーの原因を調べる際に便利です。

(8) 続いて、②ネットワーク。
パブリックIPアドレス(①)、アベイラビリティーゾーン(②)の左隣のチェックボックスにチェックし、「保存」をクリック(③)。

(9) 最後にデータベース。
ユーザー名(①)、パスワード(②)を設定し、保存をクリック(③)。

(10)「より多くのオプションの設定」画面にて、「環境の作成」をクリック

(11) 10分ほどして環境が作成されたら、「ヘルス」が「OK」となっていることを確認しましょう。

(12) もし、「ヘルス」が黄色(Warning)や赤色(Degraded、Severe)となった場合は原因を特定&解決しておきましょう。
ナビゲーションペインにて、「ログ」や「ヘルス」をクリックすると内容を確認できます。

[2] 追加設定

(1) 追加設定もしておきしょう。Elastic Beanstalkのナビゲーションペインの「設定」をクリック。

(2)「インスタンス」の右側の「編集」をクリック。

(3)「デフォルト」にチェックを入れ(①)、「適用」をクリック(②)。
【重要】忘れると、通信がうまくいかず、502(Bad Gateway)となりますので、必ず設定してください。
→ この設定はなくても大丈夫でした。502(Bad Gateway)はサーバーのポート番号の設定ミスにより起こるようです。

4. データベースの設定

続いて、3. Elastic Beanstalk環境の作成によってできた、データベース(RDS)の設定を行いましょう。

[1] RDSにおける接続設定

(1) マネジメントコンソールにて、RDSを探し、クリック。

(2) ナビゲーションペインにて、「データベース」をクリック。

(3) 作成されたデータベースインスタンスのラジオボタンにチェックを入れ(①)、「変更」をクリック(②)。

(4) データベースインスタンスの変更画面に遷移するので、「ネットワーク&セキュリティ」欄の「パブリックアクセシビリティ」を「はい」にし、画面下方の「次へ」をクリック。

(5)「変更の概要」画面に遷移したら、内容を確認し、「変更のスケジュール」の「すぐに適用」を選択し(①)、「DBインスタンスの変更」をクリック(②)。

(6)「データベース」画面に戻ったら、データベースインスタンス名の上のリンクをクリック。

(7) 「接続とセキュリティ」タブにて、「VPCセキュリティグループ」(リンク)をクリック。

(8)「セキュリティグループ」画面に遷移したら、「インバウンドルール」タブをクリックし(①)、「インバウンドルールを編集」をクリック(②)。

(9)「任意の場所」を選択し(①)、「ルールを保存」をクリック(②)。
【注意】この設定内容は全ての接続元からのアクセスを許可してしまうため、セキュリティ上よくありません。
今回は無線LANを使ってクライアントPCからの接続も行うため、この設定としています。

[2] テーブルの作成

(1) 続いて、接続確認も兼ねて、クライアントPCから、テーブルの作成を行いましょう。
コマンドプロンプトを起動し、以下のコマンドを実行、データベースインスタンスへ接続します。

実行コマンド
> mysql -h ホスト名-P ポート番号 -u ユーザー名 -p

ここで、ホスト名は以下のキャプチャの「エンドポイント」(①)、ポート番号はか「ポート」(②:デフォルトは3306)、ユーザー名は3. Elastic Beanstalk環境の作成で設定した「ユーザー名」になります(今回はadmin)。

コマンド実行後、パスワードを聞かれるので、Elastic Beanstalk環境の作成で設定した「パスワード」を入力し、Enter。

ログインできたら、以下のDDL、SQLを実行し、データベース、テーブルの作成、ならびに、データの挿入を行っておきましょう。

データベースとテーブルの作成
CREATE DATABASE `sample-db` CHARACTER SET = utf8mb4 COLLATE = utf8mb4_bin;

USE `sample-db`;

CREATE TABLE `shop_informations` (
  `shop_id` mediumint(9) NOT NULL AUTO_INCREMENT COMMENT '店舗ID',
  `shop_name` varchar(100) DEFAULT NULL COMMENT '店舗名',
  `tel` varchar(15) DEFAULT NULL COMMENT '電話番号',
  `zip_code` varchar(10) DEFAULT NULL COMMENT '郵便番号',
  `address` varchar(100) DEFAULT NULL COMMENT '住所',
  `access` varchar(100) DEFAULT NULL COMMENT 'アクセス',
  `business_hour` varchar(100) DEFAULT NULL COMMENT '営業時間',
  `regular_holiday` varchar(100) DEFAULT NULL COMMENT '定休日',
  PRIMARY KEY (`shop_id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COMMENT='店舗情報';
begin;

INSERT INTO shop_informations VALUES(1, '春風カフェ', '03-XXXX-XXXX', '100-0005', '東京都千代田区丸の内・・・', '東京駅から徒歩5分', '平日 7:00~21:00/土日祝 10:00~21:00', '不定休');
INSERT INTO shop_informations VALUES(2, '夏海食堂', '050-XXXX-XXXX', '254-0034', '神奈川県宝町・・・', '平塚駅から徒歩10分', '平日 11:00~22:00/土日祝 11:00~20:00', '火曜日');
INSERT INTO shop_informations VALUES(3, '割譲秋山', '049-XXXX-XXXX', '350-0041', '埼玉県川越市六軒町・・・', '川越市駅から徒歩7分/本川越駅から徒歩5分', '昼 11:00~14:00/夜 18:00~23:30', '日曜・祝日');
INSERT INTO shop_informations VALUES(4, '冬空キッチン', '04-XXXX-XXXX', '350-0041', '千葉県我孫子市本町・・・', '我孫子駅から徒歩8分', '昼 11:30~14:00/夜 17:00~23:00', '木曜日');

commit;

※上記データは、架空のものになります。実在する店舗ではありません。

[3] Elastic Beanstalkにおける設定

(2) 続いて、Elastic Beanstalkにて、データベース接続用の環境変数を追加します。
マネジメントコンソールにて、Elastic Beanstalkを探してクリック。

(3) 「ソフトウェア」の右端の「編集」をクリック。

(4) 「環境のプロパティ」欄にて、以下のように設定し(①)、「適用」をクリック(②)。

名前
DB_HOST (10)で入力したホスト名
DB_PORT (10)で入力したポート番号
DB_NAME (10)で作成したデータベース名
DB_USER (10)で入力したユーザー名
DB_PASSWORD (10)で入力したパスワード
SERVER_PORT 5000

(5) 「1. Java(Spring Boot)アプリケーションの作成」で作成したapplication.ymlの内容を以下のように書き換えます。

application.yml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://${DB_HOST:(10)で入力したホスト名}:${DB_PORT:(10)で入力したポート番号}/${DB_NAME:(10)で作成したデータベース名}?serverTimezone=JST
    username: ${DB_USERNAME:(10)で入力したユーザー名}
    password: ${DB_PASSWORD:(10)で入力したパスワード}
  jpa:
    database: MYSQL
    hibernate.ddl-auto: none
server:
  port: ${SERVER_PORT:5000}

こうすることで、クライアントPCから、今回作成したデータベースに接続することができるようになります。

(6) Eclipseにて、作成したプロジェクト上で右クリックし(①)、「実行」(②) > 「Spring Bootアプリケーション」(③)をクリックして、ローカルサーバーを起動しましょう。

(7) ブラウザを立ち上げて、以下のURLを叩き、結果が取得できることを確認します。

実行URL
http://localhost:5000/shop-information/1

(8) application.ymlの変更内容をGitのリモートリポジトリ(CodeCommit)にも反映させます。
コマンドプロンプトを起動して、プロジェクトのルートディレクトリまで移動し、以下の順でコマンドを実行。

> git add application.yml
> git commit -m "fix application.yml"

続編について

続きは、

にて。
5. パイプラインの作成の接続設定と6. 後片付けを行います。

更新履歴

  • 2020/08/13:「3. Elastic Beanstalk環境の作成」の[1] 環境、アプリケーションの新規作成、[2] 追加設定の内容を一部変更

参考

手順

3. Elastic Beanstalk環境の作成

4. データベースの接続設定