本文へ移動
Wagby11
マニュアルのグループを選ぶ

WAGBY11 MANUAL / 29

RDS MySQLの本番環境を構築する

HTTPS・RDS MySQL・EFSを使う本番環境を準備し、配置と更新後のデータ保持を確認します。

最終更新日:

運用の小目次へ

1. このページで伝える機能

RDS MySQL・EFS・HTTPSを使う本番環境を構築し、更新でデータを失わないことを確認できます。

2. Wagby11で実現できること

2.1 本番用に追加で準備する

項目準備・確認
MySQL用アプリMySQLで生成・ビルドし、ローカルでDB接続と業務操作を確認。H2のJARは使わない
RDS設定提供中のMySQLエンジン、db.t4g.small、gp3 20 GiB、Single-AZの例。性能・可用性を確認して変更
DBアプリ用SecretSecrets Managerにusername/passwordを登録。管理者・root用のユーザーは使わない
ドメイン・証明書DNSを編集できる権限、対象ホスト名、東京リージョンの発行済みACM証明書
保持方針RDS・EFSバックアップ7日、ログ30日の例。復旧目標と保存期間を担当者が確定
更新時間旧タスク停止から起動・確認までの停止時間を確保
配置先テストと異なる環境名・設定・プロファイルを使用

SecretはAWSコンソールで登録し、username と password を持つJSONとします。配置設定へ書くのは完全なSecret ARNだけです。RDSの管理者用Secretはツールが作成・管理し、通常アプリへ渡しません。SMTPを使う場合はTLS対応のSMTP設定と専用Secretを別に準備します。

AWSのエンジン提供状況は変わります。設定に記載する完全なエンジン番号とクラスの組み合わせを、作成前に確認します。次は対応候補を調べる読み取りコマンドです。

aws rds describe-db-engine-versions --profile wagby-prod --region ap-northeast-1 \
  --engine mysql --query 'DBEngineVersions[?starts_with(EngineVersion, `8.4.`)].EngineVersion' --output table
aws rds describe-orderable-db-instance-options --profile wagby-prod --region ap-northeast-1 \
  --engine mysql --db-instance-class db.t4g.small \
  --query 'OrderableDBInstanceOptions[?StorageType==`gp3`].{Version:EngineVersion,Min:MinStorageSize,Max:MaxStorageSize,MultiAZ:MultiAZCapable}' --output table

2.2 本番用の設定を確定する

examples/pipeline-prod.yml を config/pipeline-prod.yml へコピーします。次の項目は必ず確認します。サンプル中のアカウント・ARN・ホスト名・アプリのパスは置き換えます。

設定この章の例・意味
schema-version / environment.type4 / production
aws / app.directory東京、期待するアカウントID、wagby-prod、MySQL用アプリの場所
runtime1 vCPU / 4 GiB、MCP無効
databasemysql、提供確認した完全なエンジン番号、db.t4g.small、20 GiB、multi-az: false、DB名とSecret ARN
storage.attachmentsefs / elastic / backup-retention-days: 7
fulltextephemeral / rebuild-on-start: true / startup-mode: background
loggingretention-days: 30
https東京リージョンのcertificate-arnとhostname
pipeline本番専用のname / bucket / source-key

RDSのバックアップ枠・メンテナンス枠はUTCで指定します。サンプルの 20:00-20:30 は日本時間の翌日05:00〜05:30です。EFSのバックアップとRDSは同時点を保証しないため、整合した復旧点と復元試験は別途計画します。

2.3 コマンド操作一覧

順序操作確認すること
1config validate / doctor --offline本番設定、MySQL用生成物、JDBC等の必要資材
2env create --prepare-only保持対象、接続元、作成構成
3env create基盤・データ・監視・本番Pipelineを作成または同一構成で再利用
4ALB出力とDNS設定 / doctor独自ホスト名をALBへ向け、認証とPipelineを照合
5deploy --prepare-only / deploy転送入力を確認して配置を受け付ける
6wait / status / logs同じ実行IDで本番の配置・検証が成功
7許可したPCからHTTPS確認ログオン、登録・検索、添付、全文検索、更新後の保持

以下のCIDRも説明用です。実際に許可する接続元へ置き換えます。env create はアプリを転送・起動する操作ではありません。作成直後から基盤やDBの費用が発生します。

./bin/wagby-cloud config validate --config config/pipeline-prod.yml
./bin/wagby-cloud doctor --config config/pipeline-prod.yml --offline
./bin/wagby-cloud env create --config config/pipeline-prod.yml --allow-cidr 203.0.113.10/32 --prepare-only
./bin/wagby-cloud env create --config config/pipeline-prod.yml --allow-cidr 203.0.113.10/32
aws cloudformation describe-stacks --profile wagby-prod --region ap-northeast-1 \
  --stack-name wagby11app-prod-foundation --query 'Stacks[0].Outputs' --output table

スタック名は実際の環境名に合わせます。出力したALBのDNS名へ、独自ホスト名のCNAMEやRoute 53のエイリアスを設定します。ACMのDNS検証用レコードと、アプリ接続用のDNSレコードは別です。名前解決と証明書を確認してから配置を進めます。

./bin/wagby-cloud doctor --config config/pipeline-prod.yml
./bin/wagby-cloud deploy --config config/pipeline-prod.yml --release prod-001 --prepare-only
./bin/wagby-cloud deploy --config config/pipeline-prod.yml --release prod-001
EXECUTION_ID="ここに返された実行ID"
./bin/wagby-cloud status --config config/pipeline-prod.yml --execution-id "$EXECUTION_ID" --watch
./bin/wagby-cloud logs --config config/pipeline-prod.yml --execution-id "$EXECUTION_ID" --stage build
./bin/wagby-cloud logs --config config/pipeline-prod.yml --execution-id "$EXECUTION_ID" --stage deploy
./bin/wagby-cloud logs --config config/pipeline-prod.yml --execution-id "$EXECUTION_ID" --stage verify
./bin/wagby-cloud wait --config config/pipeline-prod.yml --execution-id "$EXECUTION_ID" --timeout-seconds 3600
./bin/wagby-cloud history --config config/pipeline-prod.yml

2.4 更新・停止・データ保持を確認する

本番のDeployは旧タスクが完全にSTOPPEDになるまで待ち、DBアプリユーザーの確認・初期化を行ってから新アプリを1台起動します。更新の間は接続できない時間があり、利用者は再ログオンします。変更した成果物には prod-002 など新しいリリース名を使います。

初回のHTTPS接続でログオンし、代表データと添付を登録します。更新後に、その登録データと添付の内容が一致すること、検索や権限が正常なことを確認します。全文検索は起動後に非同期で再構築するため、Pipeline成功直後に完了したとは判断しません。

./bin/wagby-cloud stop --config config/pipeline-prod.yml
./bin/wagby-cloud start --config config/pipeline-prod.yml

上記は配置済みアプリの停止・起動です。DBと添付はRDS/EFSに保持します。進行中Pipelineや未解決のDB初期化がある場合は操作を拒否します。複数PCやコンソールから同時に操作しません。Secret変更は実行中アプリへ自動反映されないため、新リリースで再配置します。

この本番Pipeline構成の env delete は対応していません。完全廃棄では、復元可能性を確認したうえで終了保護、データ、保存資材、バックアップ等を別途扱います。stop 後も保持サービスの課金は続きます。

2.5 構成変更の仕様と制約

CPU・メモリは配置設定YAMLの runtime.vcpu と runtime.memory-gib で変更できます。対応範囲は1 vCPU/2〜8 GiB、2 vCPU/4〜16 GiB、4 vCPU/8〜30 GiBです。費用と必要な性能を確認して変更します。

本番ではRDSの database.instance-class の変更と、database.allocated-storage-gib の増量も許可します。容量縮小はできません。増量は現在容量の10%以上とし、AWSで提供されるクラス・容量の組み合わせを確認します。RDS変更はアプリを停止してから実行し、DBや添付を作り直しません。増量後の容量最適化中は追加のRDSサイズ変更を行わず、完了を待ちます。更新後のサイズと保護を確認できれば、アプリの再配置・起動は可能です。

EFSの保存容量はファイル量に応じて自動伸縮します。割当容量の変更操作は不要です。初回リリースではEFSの性能・スループット設定の変更は対象外です。

最新のバックアップと更新中の停止時間を確認してから進めます。

変更後のYAMLで env create を実行し、許可項目だけを照合してRDSとAWS側の配置設定を更新します。続いて新しいリリース名で deploy し、CPU・メモリを新タスクへ反映します。env create だけでは稼働中タスクのCPU・メモリは変わりません。RDS変更を含む場合は、先に stop でアプリを停止します。

本番の変更操作の例です。CIDRは初回と同じ実際の接続元を指定し、prod-resize-001 は新しいリリース名にします。

./bin/wagby-cloud stop --config config/pipeline-prod.yml
# pipeline-prod.ymlの許可されたサイズ項目を変更します。
./bin/wagby-cloud config validate --config config/pipeline-prod.yml
./bin/wagby-cloud env create --config config/pipeline-prod.yml --allow-cidr 203.0.113.10/32 --prepare-only
./bin/wagby-cloud env create --config config/pipeline-prod.yml --allow-cidr 203.0.113.10/32
./bin/wagby-cloud deploy --config config/pipeline-prod.yml --release prod-resize-001

返された実行IDで wait し、HTTPSログオンとDB・添付の保持を確認します。CPU・メモリだけを変更する場合は、env create 前の停止は必須ではありません。RDS変更を含む場合は必須です。更新が途中で止まった場合はAWSの状態を確認し、同じ変更後の設定で env create を再実行します。

DBの変更、ネットワークの変更、タスク数の変更、コンテナの追加・分割、Pipelineの工程・順序の変更は許可しません。本番のMulti-AZやDB名・認証情報の参照先、バックアップ方針等も、このサイズ変更操作の対象外です。設定やテンプレートの任意編集でこれらを変更すると、標準コマンドが拒否するか、検証に失敗します。

--prepare-only はローカル計画の確認です。実際の更新前にはAWSの現在値、実行中の配置とDB初期化、データ保護を確認します。タイムアウトしてもAWS処理は継続することがあるため、状態を照合して再実行します。

2.6 バックアップと復元を理解する

本番では、DBのデータをRDS、添付ファイルの原本をEFSに保存し、それぞれ別の仕組みでバックアップします。全文検索のインデックスはバックアップせず、アプリの起動時に作り直します。以下は、この章の標準構成とサンプル設定での方針です。

対象バックアップの方法・時刻保持期間・復元の考え方
RDS:DBのデータRDSの自動バックアップ。サンプルの取得枠は毎日UTC 20:00〜20:30(日本時間の翌日05:00〜05:30)です。database.backup-retention-days: 7。保持期間内の復元可能な時点、または取得済みスナップショットから別DBへ復元します。
EFS:添付ファイルの原本AWS Backupの専用バックアッププランで日次取得。UTC 20:00(日本時間の翌日05:00)を基準に、60分の開始枠でジョブを開始する設定です。storage.attachments.backup-retention-days: 7。完了したバックアップの復旧点から、別のEFSへ復元します。
全文検索のインデックスバックアップ対象外。タスク内の一時領域に保存します。アプリの入れ替え・起動時に、DBのデータと添付ファイルの原本等からバックグラウンドで再構築します。

保持期間は初回構築前に確定します。既存環境のバックアップ方針変更は、サイズ変更操作の対象外です。バックアップの保存や復元先のDB・EFSには別途料金が発生します。

2.6.1 RDSのバックアップと復元

RDSの自動バックアップは、DB全体のスナップショットと更新履歴を使い、保持期間内の時点へ戻せる仕組みです。「7日保持」は、常に直前の状態へ戻せるという意味ではありません。RDSコンソールの自動バックアップと「最新の復元可能な時刻」を確認します。重要な更新前には、必要に応じて手動スナップショットも取得します。

  1. AWSマネジメントコンソールで東京リージョンのRDSを開き、対象のDB識別子とアカウントを確認します。
  2. 自動バックアップから戻す場合は「特定時点への復元」で、復元可能な範囲内の時刻を指定します。スナップショットから戻す場合は、対象のスナップショットを選び「スナップショットを復元」を実行します。
  3. 元のDBと異なるDB識別子を指定します。復元すると新しいDBが作成されます。非公開のサブネット、セキュリティグループ、暗号化、DBパラメーターなどを確認し、元のDBは保持します。
  4. 復元先が利用可能になったら、検証用アプリから接続し、ログイン、代表データ、更新履歴などを確認します。EFSも使うデータは、次項の添付ファイルとの整合性まで確認します。

手動スナップショットは自動バックアップの7日保持とは別に管理し、保存期限と削除担当を決めます。詳しい操作はAWS公式の特定時点への復元とスナップショットからの復元を参照してください。

2.6.2 EFSのバックアップと復元

この構成では、添付用EFSをAWS Backupの専用プランへ登録し、環境名-backup というバックアップボールト(復旧点の保管先)に保存します。EFSの標準自動バックアップとの二重取得を避け、専用プランで管理します。日次ジョブの完了状態と復旧点の作成日時を確認してください。予定時刻になったことだけでは、バックアップ成功とは判断しません。

  1. 東京リージョンのAWS Backupで対象のバックアップボールトを開き、EFSのIDと、戻したい日時の復旧点を確認します。
  2. 復旧点から「復元」を選び、全体を新しい暗号化済みファイルシステムへ復元します。復元用IAMロールは、通常のバックアップ用ロールとは別に、AWS管理者が権限を確認して用意します。
  3. 復元ジョブの完了後、新しいEFSの中に作られた /aws-backup-restore_日時/ という回復ディレクトリを確認します。ファイルは元のパスへ自動的に戻るわけではありません。検証用アプリが、この配下の添付保存先を参照するようにします。
  4. 復元先のマウントターゲットとアクセスポイントを用意し、所有者・権限を確認します。この構成のアプリ用UID/GIDは 10001 です。検証用アプリから代表的な添付ファイルを開き、DBのレコードと対応し、内容が正しいことを確認します。

詳しい操作と回復ディレクトリの扱いは、AWS公式のEFSの復元を参照してください。

2.6.3 DBと添付を一組として復元する

標準設定では、RDSとEFSの日次バックアップの開始予定時刻を日本時間05:00に揃えています。開始予定時刻が同じでも、DBと添付ファイルの整合性は保証されません。RDSとEFSはそれぞれの時間枠内で別々にバックアップを開始するため、実際の取得時点や、取得中に反映される更新は揃うとは限りません。たとえば、DBには添付の登録情報があっても、復元したEFSにはそのファイルがない場合があります。復旧時はDBと添付の対応を確認します。

重要な更新前など、整合した復旧点を残したい場合は、次の手順で一組として記録します。

  1. 進行中の配置・DB初期化がないことを確認し、stop でアプリを停止します。すべてのタスクが停止し、ほかの処理からもDB・EFSへ書き込みがないことを確認します。
  2. RDSの手動スナップショットを取得し、AWS Backupで対象EFSのオンデマンドバックアップを開始します。
  3. 両方の完了を待ち、RDSのスナップショットARNとEFSの復旧点ARN、取得日時、対応するアプリのリリースを一組として記録します。オンデマンドバックアップにも保持期限を決めます。
  4. start でアプリを再開します。復元試験では、記録した一組を別のDB・EFSへ戻し、同じリリースの検証用アプリでデータと添付を確認します。

2.6.4 全文検索のインデックスを再構築する

全文検索のインデックスは検索を速くするためのデータであり、バックアップ対象の原本ではありません。この構成ではRDSやEFSへインデックスを保存せず、タスク内の一時領域へ作成します。

アプリを入れ替えて新しいタスクを起動すると、最初にバックグラウンドでインデックスの再構築を始めます。DBの業務データや添付ファイルの原本等を使って再構築し、モデルごとに準備ができたものから全文検索を利用できます。添付の解析結果が反映されるまで、さらに時間がかかる場合もあります。

ログイン画面が開いたことやPipelineが成功したことだけでは、全文検索の準備完了とは判断しません。再構築中は全文検索が準備中となる場合があるため、アプリの管理APIとログで ready・rebuilding・failedUpdates の状態を確認し、代表的なキーワードと添付内容で検索できることを確かめます。バックアップから復元した検証用アプリでも、同じ再構築と確認が必要です。

3. AIへの指示例

AWSへの転送時に、改版履歴の更新もAIへ依頼できます。履歴を確定してから生成・ビルドし、その成果物を転送します。記録の方針は、AWSへ転送する前に記録するを参照してください。

AIにAWS配置ツールを使ってもらう例です。対象アカウント・環境名・費用の条件を伝えます。

最小限の指示例

このアプリをRDS MySQLを使うAWS本番環境へ配置してください。

AIはMySQL用アプリ、保存先、Secret、証明書とDNSの準備を確認し、構成や停止条件の不足を補います。 未指定の仕様はAIが資料やファイルから類推して補います。費用やデータ保持など、判断に必要な条件は確認します。最小限の指示だけで次の詳細例と同じ構成になるとは限りません。

より詳細な指示例

転送前に、今回確定した設計変更をAppSchemaの改版履歴へ記録してください。既存の採番方針に従い、担当が未指定なら確認してください。同じ版の再転送で設計に変更がなければ履歴を重複追加せず、配置成功を先に記録しないでください。履歴更新後に検証・生成・ビルドし、その成果物を転送してください。
config/pipeline-prod.ymlを使い、RDS MySQL・EFS・HTTPSの本番環境を作成してください。1 vCPU/4 GiB、MCP無効、RDS db.t4g.small・gp3 20 GiB・Single-AZ、バックアップ7日、ログ30日を例に見積もり、性能と可用性の要件も確認してください。Secret本文を表示せず、MySQL用JARと対応する完全なエンジン番号を検査してください。計画確認後に基盤を作成し、ALBのDNS設定を確認してからprod-001を配置してください。旧タスクの完全停止後に新版を起動し、Pipeline完了とHTTPSログオン・DB登録・添付保存取得・更新後の保持を別々に確認してください。

会話の進め方の例

発言者やり取り
利用者本番用のAWS環境を作りたいです。データと添付を保持してください。
AIMySQL用アプリ、アカウント、Secret ARN、ドメインと証明書、接続元、停止時間、バックアップ条件を確認し、構成・費用・未確定項目を示します。
利用者この設定で進めてください。更新中の停止を許容します。DNS設定は担当者が行います。
AI基盤作成後にALBのDNS名を提示します。DNS設定を確認して配置し、実行IDによる完了確認と、HTTPS・DB・添付の受入確認結果を分けて報告します。

4. 編集されるAppSchemaの例

MySQL用の生成はデータベースの接続先の設定を使います。H2用の成果物へ配置設定だけを追加しても本番用にはなりません。AppSchemaはAIに設定・生成してもらい、利用者はDB種別と生成・検査結果を確認します。

database:
  type: mysql
  version: "8.4"
  jdbcUrl: jdbc:mysql://localhost:3306/wagbyapp
  usernameEnv: WAGBY_DB_USERNAME
  passwordEnv: WAGBY_DB_PASSWORD

これは開発側のDB種別と接続設定の抜粋です。AWSでの実接続先、TLSのホスト名検証、RDS保存時暗号化、EFSの設定、秘密情報は配置ツールとAWS側で構成します。AppSchemaへRDSのパスワードやSecret本文を書きません。

5. 参考資料

guide:データベース接続
designer/docs/appschema/markdown/guide/02-environment/02-database.md
reference:データベース設定
designer/docs/appschema/markdown/reference/25-database.md
Java共通基盤:データベース構成とマイグレーション
designer/docs/java/markdown/29_database_migrations.md