【SpringBoot:Maven】Elastic Beanstalkでデプロイするまでの流れ


前提

  • MySQLに接続したアプリケーションが既にある。
  • awsのアカウントを発行済である。

対象者

  • デプロイをとりあえずしたい人。
  • Elastic Beanstalkでデプロイする流れをサクッと知りたい人。
  • AWSについて詳しくない人。

注意

  • くれぐれもくるくるしている間に触らない。1つ1つ読み込み長いです。
  • インフラ系は戻るボタンを使わない。

ざっくりElastic Beanstalkって何?

AWSでデプロイに必要な

  • Elastic Load Balancing (ロードバランサー)
    • アプリケーションのデータ量を自動で分散してくれる。
  • Amazon Elastic Compute Cloud (Amazon EC2)
    • 仮想サーバーを構築してくれる。これですばやくデプロイできる。
      • Elastic BeanstalkではNginx(エンジンエックス)とTomcatを構築してくれています。
  • Amazon Relational Database Service (Amazon RDS)
    • クラウド上に作る性能の高いDB。今回はデータベースエンジンにMySQLを選択。

をセットで構築してくれて、簡単にデプロイできるようにするためのサービス。
(簡単に、と言っていますが初心者の筆者は1週間悩みましたw)

Elastic Beanstalkの準備

  • Elastic Beanstalkにログイン
  • リージョンを東京にしておく。
  • いますぐ始めるを押す
  • 各項目を入力してアプリケーションの作成

    • アプリケーション名→好きな名前(URLになる)
    • プラットフォーム→Java
    • アプリケーションコード→サンプルアプリケーション

作成まで結構時間がかかります。


ヘルスチェックが緑になれば無事に作成完了です。

DBの作成

編集を押したら、

  • エンジン→mysql
  • ユーザー名→好きな名前(今回はadmin)
  • パスワード→好きなパスワード
    そのほかは触らない。
  • 適用を押す

DBの作成も時間がかかります。


作成されたDBのエンドポイントを確認します。

RDSを見てみると、DBが作成されているのが分かります。

application.propertiesをYAML形式に変更

MySQLに接続していたこの状態のapplication.propertiesを

#MySQLのDBのURL
spring.datasource.url=jdbc:mysql://localhost:3306/mydb?serverTimezone=JST

#name、パス指定。
spring.datasource.username=root
spring.datasource.password=xxxxxxxx

#SpringBootを起動したときに実行したいSQL文を記述したパス
spring.datasource.schema=classpath:schema.sql
spring.datasource.data=classpath:data.sql

RDSに接続できるようにapplication.ymlに変更

spring:
  profiles:
    active: dev
  datasource:
    initialization-mode: always
    url: jdbc:mysql://確認したエンドポイント/ebdb
    username: admin
    password: 設定したパスワード
server: 
  port: 5000
  • プロファイル名dev(今回は開発と本番環境を分ける前提でdevと名前を付ける)
  • MySQLでschema.sqlやdatasqlを実行したい場合はinitialization-mode: alwaysにする
  • YAMLは:の後に設定がある場合1つスペースを入れます。
  • YAMLは一段下がると、前に2つスペースを入れます。(必ず偶数になる)
  • ebdbは標準で作成するDB名
  • port: 5000は重要です。(いつも8080を使っていたのであまり重要視していませんでした。)

application.propertiesではまったこと

dev書き方

参考にしていた書籍では

 config: 
  activate:
   on-profile: dev

となっていたのですが、これだとRDSと接続エラーとなりました。

Description:
Failed to configure a DataSource: 'url' attribute is not specified and no embedded datasource could be configured.
Reason: Failed to determine a suitable driver class
Action:
Consider the following:
If you want an embedded database (H2, HSQL or Derby), please put it on the classpath.
If you have database settings to be loaded from a particular profile you may need to activate it (no profiles are currently active).

公式リファレンスを見てみると書き方が違ったため、

  profiles:
    active: dev

に変更したらいけました~!
リファレンスURL

ポート番号

最初はポート番号を8080にしており、localhostでは正常な挙動なのにawsのURLだと「502 Bad Gateway」になるという現象に悩まされました。
理由はElastic Beanstalkのデフォルトのポートは5000番だったからです。aws公式サイト
nginxがTomcatの5000を参照しに行くので、5000以外だとRDSに接続できなくなります。

ビルド

pom.xmlのversionを指定しておく。

今後アプリケーションがバージョンアップして、デプロイし直す度にここを変えていく。

アプリを選択して実行→Mavenビルド

  • ゴール→package
  • プロファイル→ブランク

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.22.2:test (default-test) on project Qiita210129: There are test failures.

※Junitテストができていないと上記のエラーがでるので、最初からあるcom.example.demoパッケージ内も含めて一旦すべて消してください。

ビルドがうまくできたら、jarファイルがtargetの中にできるので、格納場所を確認しておく。

デプロイ

Elastic Beanstalk

このバージョンはpomで指定したversionと同じにしておく。
デプロイはとても時間がかかります。

Elastic Beanstalkにdevを設定する

Elastic BeanstalkでYAMLに書いたdevの設定をする。
設定→ソフトウエア(一番上)編集

画面が自動転送されるとき(loginなど)

今回のアプリケーションの仕様にはないですが、最初のページに自動転送されるという仕様があるときに設定が必要になります。
(例えば、/hogeをurlに入力しても、ログインしていないので/loginにリダイレクトされるようなとき)


設定→ロードバランサー→ヘルスチェックパスを最初の画面(/login)にする。
デフォルトでは/になっている。

※何故設定するかというと、ロードバランサーがHTTPのステータスコードが成功だと思って「200」が返ってくると思っているのに、リダイレクトの「301」「302」「303」が返ってきてくるからです。

こちらを参考にしました。
基礎からのネットワーク&サーバー構築

デプロイできているか確認

Elastic Beanstalk
環境に移動

awsのページに飛ぶので、最初のページ(/todos)を末尾に付け足します。(今回はawsのURL/todosが最初のページに指定されているため)

controllerの指定が最初から/なのであれば「環境に移動」を選択すればすぐに表示されるので付け足し不要です。

最後に

お疲れさまでした!!
こんなに色々やってくれるElastic Beanstalkすごいですね!
RDSは課金されるので、お気を付けください。

Elastic Beanstalkは簡単にデプロイできるらしい、便利じゃないか!と思いやってみましたが、理解するのはまだまだ難しいです。
これをきっかけにインフラ・ネットワークの仕組みを学習していこうと思います。