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

WAGBY11 MANUAL / 29

AWS運用を始める前に準備する

運用ツールの入手・展開、WindowsとmacOS/Linuxの起動確認、エラー時の確認事項とAWSへの配置準備を説明します。

最終更新日:

運用の小目次へ

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

必要な契約・ツール・認証・アプリを揃え、AWSへ作成する前に準備の不足を確認できます。

2. Wagby11で実現できること

2.1 AWSアカウントと作業権限を準備する

AWSアカウントは、AWSの利用契約と料金の請求をまとめる単位です。最初に契約・支払・日常作業の担当を決めておくと、その後の設定を進めやすくなります。組織ですでにAWSを利用している場合は、利用するアカウントとログイン方法をAWS管理者に確認してください。

2.1.1 アカウントを作成する前に準備するもの

準備・決定すること具体的な内容
契約を管理するメールアドレスと連絡先確認メールを受信できるメールアドレス、契約者名・住所、本人確認に使える電話番号を用意します。組織で利用する場合は、担当者が変わっても管理を引き継げる連絡先にします。
契約管理用のパスワードとMFAルートユーザーのログイン用パスワードを安全に管理する方法と、多要素認証(MFA)に使う認証アプリやセキュリティキーを準備します。
支払用のクレジットカードAWS利用料の支払に使えるカードと請求先情報を用意し、組織の支払承認を確認します。カード情報はAWSの登録画面に入力します。
作業用のユーザー名・パスワードIAMユーザーを使う場合は、作業者ごとのユーザー名とログイン用パスワード、その保管方法を準備します。IAMユーザー自体はAWSアカウントを作成した後に管理者が作ります。組織のログインを使う場合は、管理者から案内される利用者名とログイン方法を確認します。
請求を確認する担当者とメールアドレス毎月の利用額・請求書を確認する担当者と、請求関連の連絡を受けるメールアドレスを決めます。担当者が請求画面にログインして閲覧できるようにする設定も、別途必要です。
月額予算と通知先メールアドレス月額予算の金額・通貨、通知するタイミング(例:予算の80%と100%)、通知を受ける担当者のメールアドレスを決めます。契約後にAWS Budgetsへ登録します。請求連絡先と同じアドレスでも構いませんが、予算の通知先としても設定します。

契約管理用のメールアドレス・パスワードと、日常作業用のIAMユーザー名・パスワードは、それぞれ別に管理します。パスワードやカード番号を配置設定YAMLやAIとの会話へ記載しないでください。登録に必要な情報は、AWS公式のアカウント作成手順で確認できます。

2.1.2 最初に知っておきたいAWSの用語

用語この章での意味
AWSアカウント/アカウントID利用契約・請求の単位と、その識別番号です。アカウントIDは12桁の数字で、配置先の取り違えを確認するために使います。Wagbyアプリにログインする利用者とは別です。
ルートユーザーAWSアカウント全体を管理する、特別な権限を持つ利用者です。契約管理用のメールアドレスでログインします。契約やアカウントの重要な設定に使い、日常の配置作業には作業用の利用者を用意します。
IAM/IAMユーザーIAMは「誰が、AWSで何をできるか」を管理する仕組みです。IAMユーザーは、AWSアカウントの中に管理者が作る作業用の利用者です。ユーザーを作成するだけでは作業権限は付かず、許可する操作を管理者が設定します。
IAMロール必要なときに引き受ける権限のまとまりです。作業者が組織のログインから利用する場合や、AWSのサービスがアプリ配置のために使う場合があります。
ポリシー「この保存先にファイルを置ける」「この環境のアプリを起動できる」など、許可する操作と対象を定めるルールです。管理者がユーザーやロールに設定します。
MFA(多要素認証)パスワードに加え、認証アプリの確認コードやセキュリティキーなどで本人確認する仕組みです。
リージョンAWSのサービスを動かす地域です。この章では東京リージョンを使い、設定値は ap-northeast-1 とします。別の地域で作った環境は、画面のリージョンを切り替えないと一覧に表示されないことがあります。
AWSマネジメントコンソール/AWS CLIAWSを操作するブラウザーの管理画面と、PCのターミナルから操作するコマンドです。Wagbyの配置ツールも、AWSの認証情報を使って配置先を操作します。
リソースAWS上に作るアプリ実行環境、DB、ファイル保存先、ネットワークなどの総称です。作成・保持・利用に応じて料金が発生します。

2.1.3 契約後にログインと請求・予算の設定を確認する

  1. AWSアカウントを作成し、ルートユーザーのMFAを設定します。日常の配置に使う利用者またはロールを、管理者が用意します。
  2. 作業者が自分のログイン方法でAWSマネジメントコンソールを開けることを確認します。アカウントIDを控え、リージョンは東京にします。配置設定ではテスト用と本番用の環境名を分けます。
  3. 請求担当者のメールアドレスを請求連絡先に登録し、担当者の作業用ユーザーまたはロールで「請求とコスト管理」を開いて利用額を確認できるようにします。メールアドレスの登録だけでは閲覧権限は付きません。IAMユーザー・ロールから請求画面を利用するには、管理者がアカウントの「IAMアクセスの有効化」と必要な閲覧権限を確認します。
  4. AWS Budgetsで月額のコスト予算を作り、予算額・通知の条件・通知先メールアドレスを登録します。請求担当者と、通知を受けた後に利用状況を調べる担当者を決めておきます。

AWS Budgetsの予算通知は、設定した予算に近づいたことや超過を知らせるものです。通知を設定しただけでアプリが自動停止したり、請求額が予算内に制限されたりすることはありません。利用額の反映や通知には時間差があるため、請求画面も定期的に確認します。設定の詳細は、AWS公式の請求連絡先の確認、請求情報へのアクセス権限、予算通知の設定と更新頻度を参照してください。

2.1.4 ログインの許可と、環境を作る許可を用意する

AWSでは「誰が操作するかを確認すること」を認証、「その人が何を操作できるかを決めること」を権限の設定と呼びます。ログインに成功しても、アプリの実行環境やDBを作る操作まで許可されているとは限りません。たとえば、請求額を見る担当者と、Wagbyの実行環境を作る担当者では、必要な権限が異なります。

PCから aws login を使う作業者には、管理者が SignInLocalDevelopmentAccess というAWS提供のポリシーを設定します。これは、ブラウザーでのログインを使ってPCのCLIから操作するための許可です。アプリやDBを作成する許可は、このポリシーとは別に用意します。組織のIAM Identity Centerで aws sso login を使う場合は、その組織の権限設定を利用します。SignInLocalDevelopmentAccessの公式説明も確認できます。

Wagbyの配置ツールは、次のAWSサービスを組み合わせて環境を作ります。AWS管理者には、この表と、構築するテスト環境・本番環境のページを渡し、担当者が必要な範囲を操作できるように設定を依頼します。

行う作業利用するサービス・権限何のために必要か
構成をまとめて作成・確認するCloudFormationネットワークや実行環境を、用意された定義に従って作ります。
アプリを保存・実行するECR、ECSコンテナイメージを保存し、アプリを動かします。
通信経路を作るVPC、ELB専用ネットワークと、ブラウザーからアプリへ接続する入口を作ります。
配置用ファイルと暗号鍵を扱うS3、KMSアプリの資材を保存し、暗号化します。
AWS内のサービスに作業を任せるIAMロールの作成・設定、PassRoleCodeBuildやECSなどが使う権限を用意します。PassRoleは、指定したロールをAWSのサービスに使わせる許可です。
配置を自動で進めるCodePipeline、CodeBuildアプリの組み立て・配置・検証を順番に実行します。
結果や不具合を調べるCloudWatch実行ログや監視情報を確認します。
本番のデータ・添付とバックアップを扱うRDS、EFS、AWS Backup(本番)DBと添付ファイルを保存し、バックアップを管理します。
H2のHTTPS入口を用意するCloudFront、VPCオリジン、EC2の管理プレフィックスリストAWS発行URLのHTTPSを使います。接続元制限は設けず、非公開ALBへの接続に使うプレフィックスリストIDを確認します。
本番の接続情報とHTTPSを用意するSecrets Manager、ACM(本番)DBなどの認証情報を保管し、HTTPSの証明書を使います。

この表は、管理者に依頼する作業範囲を説明するものです。サービス名を選ぶだけで必要な権限がすべて揃うわけではありません。管理者は、対象アカウント・東京リージョン・このWagby環境のリソースを確認し、作成・更新・参照など必要な操作をポリシーに設定します。作業者は、用意されたログイン方法とプロファイル名を受け取り、後述の手順で接続を確認します。

2.2 運用ツールをインストールし、起動を確認する

2.2.1 配布ZIPを入手して展開する

運用ツールは、wagby-aws-deployer-11.0.0.zip としてWagbyの正規購入者に提供されます。Wagby本体のインストーラーとは別の配布物です。案内された提供元からZIPを入手してください。

ZIPはすべてのファイルをまとめて展開します。ZIPの中からコマンドだけを取り出して実行せず、展開したフォルダ全体を作業用のPCへ保存してください。ここでは、展開先をWindowsでは C:\work\wagby-aws-deployer-11.0.0、macOS/Linuxでは ~/Downloads/wagby-aws-deployer-11.0.0 とした例を使います。実際に展開した場所へ読み替えてください。

運用ツールの起動にはJava 21以降が必要です。JAVA_COMMAND、JAVA_HOME、PATHの順に実行するJavaを選び、同梱の検査スクリプトでバージョンを確認します。JAVA_COMMAND はJava実行ファイルのパス、JAVA_HOME はJavaのインストール先フォルダを指定する環境変数です。

2.2.2 展開後のファイル構成を確認する

主なファイルとフォルダは次のとおりです。配布ZIPには設定例や参考資料も含まれます。

wagby-aws-deployer-11.0.0/
├─ README.md
├─ VERSION
├─ bin/
│  ├─ wagby-cloud
│  ├─ wagby-cloud.bat
│  ├─ check-java-version.sh
│  └─ check-java-version.bat
├─ lib/
│  └─ wagby-aws-deployer.jar
├─ examples/
│  ├─ pipeline-test.yml
│  ├─ pipeline-prod.yml
│  ├─ test.yml
│  └─ prod.yml
├─ templates/
├─ docker/
├─ pipeline/
└─ docs/
ファイル・フォルダ用途
bin/wagby-cloud.batWindowsから実行する運用コマンドです。コマンドプロンプトとPowerShellから使えます。
bin/wagby-cloudmacOS/Linuxから実行する運用コマンドです。
bin/check-java-version.sh / bin/check-java-version.bat運用コマンドが呼び出すJavaの検査ファイルです。bin 内にそのまま保持します。
lib/wagby-aws-deployer.jar運用ツール本体です。必要なJavaライブラリを含みます。bin と lib の位置関係を変えないでください。
examples/配置設定YAMLの例です。この章ではテストに pipeline-test.yml、本番に pipeline-prod.yml を使い、コピーして自分の環境用に編集します。
templates/ / docker/ / pipeline/AWS環境の構成やコンテナ作成、配置処理を確認するための参考資材です。運用コマンドは本体JARに組み込まれた資材を使うため、これらの参考ファイルだけを編集しても動作は変わりません。
docs/操作手順、設定、トラブル対応などの利用者向け資料です。
README.md / VERSION利用開始の案内と、配布ツールのバージョン情報です。

2.2.3 Windowsで運用コマンドの起動を確認する

スタートメニューからPowerShellを開きます。次の Set-Location のパスを展開先へ変更してから、1行ずつ実行してください。$LASTEXITCODE は、直前の運用コマンドの終了コードです。

Set-Location 'C:\work\wagby-aws-deployer-11.0.0'
.\bin\wagby-cloud.bat --help
$LASTEXITCODE
.\bin\wagby-cloud.bat --version
$LASTEXITCODE

--help で Usage: wagby-cloud と config、doctor、env、deploy などのコマンド一覧が表示され、--version でツール名とバージョンが表示されることを確認します。それぞれの終了コードが 0 なら、Javaを含む運用ツールのインストールは完了です。

コマンドプロンプトを使う場合は、同じ確認を次のように行います。echo %ERRORLEVEL% の表示が、それぞれ 0 になることを確認してください。

cd /d "C:\work\wagby-aws-deployer-11.0.0"
bin\wagby-cloud.bat --help
echo %ERRORLEVEL%
bin\wagby-cloud.bat --version
echo %ERRORLEVEL%

PowerShellで空白を含む絶対パスを指定して実行するときは、次のように先頭へ & を付けます。

& 'C:\work\Wagby tools\wagby-aws-deployer-11.0.0\bin\wagby-cloud.bat' --help

2.2.4 macOS/Linuxで運用コマンドの起動を確認する

ターミナルを開き、展開したフォルダへ移動してから1行ずつ実行します。echo $? は、直前の運用コマンドの終了コードを表示します。

cd "$HOME/Downloads/wagby-aws-deployer-11.0.0"
./bin/wagby-cloud --help
echo $?
./bin/wagby-cloud --version
echo $?

ヘルプに Usage: wagby-cloud とコマンド一覧が表示され、バージョンの確認でツール名とバージョンが表示されることを確認します。それぞれの終了コードが 0 なら、Javaを含む運用ツールのインストールは完了です。

以降の運用コマンドの例はmacOS/Linuxの表記です。Windowsでは ./bin/wagby-cloud の部分を .\bin\wagby-cloud.bat に置き換え、同じ引数を指定します。複数行の例は、行継続の記号を除いて1行にまとめると入力しやすくなります。

2.2.5 AWS CLIを導入して起動を確認する

この章では、AWSへのログインとアカウント照合にAWS CLIを使います。運用ツールのインストールとは別に、AWS公式のインストール手順から、OSに合ったAWS CLIを導入してください。導入後はPowerShell、コマンドプロンプトまたはターミナルを開き直し、次を実行します。

aws --version

aws-cli/2 で始まるバージョン情報が表示されれば、AWS CLIを実行できます。aws login に対応するAWS CLIを使ってください。この確認だけでは、AWSへのログインやリソース作成権限は確認できません。続く「CLIでログインし、アカウントを照合する」で確認します。

2.2.6 確認コマンドでエラーになったとき

エラーが出たコマンドと、その直前から表示されたメッセージを確認します。まず次の表で切り分け、修正後に --help と --version をもう一度実行してください。

表示・症状確認すること対応
wagby-cloud / wagby-cloud.bat が見つからない、認識されないZIPをすべて展開したか、展開先のフォルダで実行しているかを確認します。Windowsは .\bin\wagby-cloud.bat、macOS/Linuxは ./bin/wagby-cloud と、bin からのパスを付けて実行します。パスに空白がある場合は引用符で囲みます。
java was not found、Java 21 or later is required、UnsupportedClassVersionErrorJavaが未導入か、古いJavaを選んでいる可能性があります。Java 21以降を導入し、JAVA_COMMAND、JAVA_HOME、PATHを確認します。JAVA_HOME は bin ではなくJavaのインストール先を指定し、変更後はターミナルを開き直します。
could not determine the Java version、Javaのパスが見つからないJavaの指定先や引用符が正しいかを確認します。JAVA_COMMAND はJava実行ファイルのパスを、引用符を値に含めず指定します。Windowsの Get-Command java、macOS/Linuxの command -v java でPATH上のJavaも確認できます。環境変数で別のJavaを指定している場合は、その指定先を優先して確認します。
lib/wagby-aws-deployer.jar was not found、Unable to access jarfile、check-java-version が見つからないコマンドだけを移動していないか、展開が途中で終わっていないかを確認します。ZIPを別フォルダへ展開し直します。bin と lib を同じ階層に置き、Java検査ファイルも bin 内に保持します。
macOS/Linuxで Permission denied になる展開時に起動ファイルの実行権限が失われていないかを確認します。sh bin/wagby-cloud --help で確認できます。通常の起動にする場合は chmod u+x bin/wagby-cloud で実行権限を付け、元のコマンドを再実行します。
PowerShellでパスの文字列だけが表示され、実行されない引用符付きの絶対パスを、そのまま入力していないかを確認します。& 'BATファイルの絶対パス' --help のように、呼び出し演算子 & を先頭に付けます。
aws が認識されない、aws: command not found になるAWS CLIが導入済みか、PATHから見つかるかを確認します。AWS公式の手順で導入し、新しいターミナルで aws --version を再実行します。Windowsは Get-Command aws、macOS/Linuxは command -v aws でも確認できます。運用ツールのヘルプとバージョンの両方が正常に表示できる場合、運用ツール自体のインストールは完了しています。
aws --version は表示されるが、aws login が未対応・引数エラーになるインストール済みのAWS CLIが、aws login に対応しているかを確認します。AWS公式のCLIログイン手順に従って更新します。組織でIAM Identity Centerを使っている場合は、管理者から指定された aws sso login の手順を使います。
ログイン後に認証期限切れや AccessDenied になるログインの有効期限、プロファイル、AWS側の作業権限を確認します。運用ツールの再インストールではなく、次の ログインとアカウント照合をやり直し、権限不足はAWS管理者へ確認します。配置・起動後の問題は AWS運用のトラブル切り分けを参照します。

2.3 CLIでログインし、アカウントを照合する

aws login --profile wagby-test
aws sts get-caller-identity --profile wagby-test --query '{Account:Account,Arn:Arn}' --output json

ブラウザーで作業用のAWSユーザー・ロールを選んでログインします。リージョンを尋ねられたら ap-northeast-1 を指定します。返されたAccountが配置先の12桁アカウントIDと一致し、Arnが予定した作業者であることを確認します。組織でIAM Identity Centerを使っている場合は、既存のプロファイルで aws sso login --profile 名前 を使います。

配置YAMLの aws.profile にも同じ名前を指定します。本番用は wagby-prod など別のプロファイルで照合すると、取り違えを減らせます。パスワード・アクセスキーを設定YAMLやAIの会話へ貼り付けません。

公式手順:コンソール認証情報を使ったCLIログイン。

2.4 入力アプリと設定を用意する

ローカルで生成・起動・業務操作を確認したアプリを用意します。restapi/target と web-ui/target に、それぞれ実行可能JARを1つ置きます。リポジトリ定義、画面・メニュー定義、OpenAPI、生成済み環境設定、表示文言、祝日定義なども必要です。MCP無効の場合はMCPのJARは不要です。アプリのフォルダ全体を手作業でS3へコピーする必要はありません。

生成後に実行可能JARを作る

最後にgenerateした後、以下をアプリのルートフォルダから実行します。Designerから生成した場合も同じです。REST APIとWeb UIをそれぞれpackageします。MCPを有効にする場合は mcp-server でもpackageします。テストが失敗したら原因を解消し、成功したJARを使います。

Windows(PowerShell)

cd restapi
..\bin\mvnw.cmd package
cd ..\web-ui
..\bin\mvnw.cmd package
cd ..

macOS/Linux

cd restapi
../bin/mvnw package
cd ../web-ui
../bin/mvnw package
cd ..

これは配布されたWagbyアプリのコマンドです。生成後のpackageが終わったら、配置ツールの展開先で doctor --offline → deploy --prepare-only → deploy と進みます。generateは生成先を作り直すため、既存JARが消えることがあります。再生成したら必ず再packageしてください。

転送するリポジトリ資材

designer/repository の appschema.yaml、appschema/ のYAML、uidefs/・menus/・i18n/ のYAMLとproperties、rootdefs/ 直下の隠しファイル以外の .yaml・.yml、report-layouts/ 配下の全ファイルを収集します。rootdefsをappschema.yamlへ手作業で統合する必要はありません。帳票テンプレートやマッピングに機密データを置かないでください。

このほかJAR、OpenAPI、生成済み環境設定、表示文言、祝日・郵便番号資材、Web UIの静的ファイル・ヘルプ・プラグインJAR、ライセンス・製品情報を収集します。ローカルDB・ログ・AWS認証ファイル・リポジトリのバックアップフォルダは転送しません。任意の独自フォルダを自動転送する仕組みではありません。シンボリックリンクやアプリ外への参照は拒否します。

例の設定ファイルを config へコピーし、アカウントID、リージョン、アプリのパス、プロファイル、環境名、Pipeline名、S3バケット名を変更します。S3バケット名は他の利用者と重複しない名前にします。app.directory の相対パスはYAMLファイルの場所を基準にします。

mkdir -p config
cp examples/pipeline-test.yml config/pipeline-test.yml
cp examples/pipeline-prod.yml config/pipeline-prod.yml

テストは schema-version: 3、本番は schema-version: 4 を使います。これらは配置設定の形式番号です。examples/test.yml や examples/prod.yml と取り違えないようにします。

Windows(PowerShell)の設定ファイルのコピー

New-Item -ItemType Directory -Force config
Copy-Item examples/pipeline-test.yml config/pipeline-test.yml
Copy-Item examples/pipeline-prod.yml config/pipeline-prod.yml

配布例の aws.profile: wagby-test は、自分がログインしたプロファイル名へ変更します。プロファイル指定を省略すると、環境変数などを含むAWSの標準認証チェーンが使われ、名前付きプロファイルでのログインが自動的に選ばれるわけではありません。

2.5 準備できた範囲を確認する

確認成功で分かることまだ分からないこと
運用コマンドの --help / --versionJavaを含む運用ツールの起動。両方が正常終了すればインストール完了AWS CLIの導入、AWS認証・権限、アプリの動作
aws --version / java -versionコマンドが見つかり、実行環境を確認できるAWS権限やアプリの動作
sts get-caller-identity認証とアカウント・実行主体リソース作成権限
config validate配置YAMLの構文・値AWS上のリソースや認証
doctor --offline入力ファイル、転送するリポジトリのYAMLと参照先、生成済みDB種別(本番)ロール等の意味検証、転送後のアプリ起動、AWSでの接続・作成・実稼働
env create --prepare-only基盤作成計画の出力実際のAWS作成
deploy --prepare-only入力収集・分割・ハッシュ計算ロール等の意味検証、アプリ起動、転送・Pipeline実行
基盤作成後のdoctorAWS認証、PipelineとS3の照合RDS実接続や業務操作
./bin/wagby-cloud config validate --config config/pipeline-test.yml
./bin/wagby-cloud doctor --config config/pipeline-test.yml --offline
./bin/wagby-cloud deploy --config config/pipeline-test.yml --release test-001 --prepare-only

3. AIへの指示例

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

最小限の指示例

このPCでWagbyのAWS配置ツールを使う準備をしてください。

AIはOS、AWS CLI、Java、認証プロファイル、配置ツールと入力アプリの有無を調べ、足りない準備を挙げます。 未指定の仕様はAIが資料やファイルから類推して補います。費用やデータ保持など、判断に必要な条件は確認します。最小限の指示だけで次の詳細例と同じ構成になるとは限りません。

より詳細な指示例

まずローカルのAWS CLIとJava、配置ツールのヘルプを確認してください。AWSの作業用プロファイルとAccountを照合し、テストと本番で設定を分けます。入力アプリの生成・ビルド状態を調べ、config validate、doctor --offline、deploy --prepare-onlyまで進めてください。認証情報の本文は表示せず、AWSリソースの作成はこの準備に含めません。

4. 編集されるAppSchemaの例

CLIのインストール、AWSログイン、配置YAMLの準備だけではAppSchemaは変更しません。本番用アプリを用意するときは、AIへMySQL用の生成・ローカル動作確認を依頼します。DB変更に伴う既存データの移送は別に行います。

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