翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS CDK を使用した AWS DevOps エージェントの開始方法

概要:

このガイドでは、 AWS クラウド開発キット (AWS CDK) を使用して AWS DevOps エージェントリソースを作成およびデプロイする方法を示します。 AWS CDK アプリケーションは、 AWS CloudFormation を通じてエージェントスペース、 AWS Identity and Access Management (IAM) ロール、オペレーターアプリ、および AWS アカウントの関連付けの作成を自動化します。

AWS CDK アプローチは、必要なすべてのリソースをコードとしてのインフラストラクチャとして定義することで、 CLI オンボーディングガイドで説明されている手動ステップを自動化します。

AWS DevOps エージェントは、米国東部 (バージニア北部）、米国西部 (オレゴン）、アジアパシフィック (シドニー）、アジアパシフィック (東京）、欧州 (フランクフルト）、欧州 (アイルランド) の 6 つの AWS リージョンで利用できます。サポートされているリージョンの詳細については、「」を参照してくださいサポートされるリージョン。

前提条件

作業を開始する前に、以下の準備が整っていることを確認します。

npm install -g aws-cdk

このガイドの内容

このガイドは 2 つのパートに分かれています。

作成されるリソース

パート 1: DevOpsAgentStack (モニタリングアカウント)

パート 2: ServiceStack (サービスアカウント、オプション)

セットアップ

ステップ 1: サンプルリポジトリのクローンを作成する

次のコマンドを実行してリポジトリのクローンを作成し、プロジェクトディレクトリに変更します。

git clone https://github.com/aws-samples/sample-aws-devops-agent-cdk.git
cd sample-aws-devops-agent-cdk

ステップ 2: 依存関係をインストールする

次のコマンドを実行して、プロジェクトの依存関係をインストールします。

npm install

パート 1: エージェントスペースをデプロイする

このセクションでは、エージェントスペース、IAM ロール、オペレーターアプリ、および AWS 関連付けをモニタリングアカウントに作成します。

ステップ 1: モニタリングアカウント ID を設定する

を開きlib/constants.ts、モニタリングアカウント ID を設定します。

次の例は、更新する定数を示しています。

export const MONITORING_ACCOUNT_ID = "<YOUR_MONITORING_ACCOUNT_ID>";

ステップ 2: AWS CDK 環境をブートストラップする

モニタリングアカウントで AWS CDK をブートストラップしていない場合は、次のコマンドを実行します。

cdk bootstrap aws://<MONITORING_ACCOUNT_ID>/<REGION> --profile monitoring

ステップ 3: ビルドとデプロイ

次のコマンドを実行して TypeScript コードを構築し、スタックをデプロイします。

npm run build
cdk deploy DevOpsAgentStack --profile monitoring

ステップ 4: スタック出力を記録する

デプロイが完了すると、 AWS CDK はスタック出力を出力します。これらの値は後で使用するために記録します。

次の例は、予想される出力を示しています。

Outputs:
DevOpsAgentStack.AgentSpaceArn = arn:aws:aidevops:<REGION>:123456789012:agentspace/abc123
DevOpsAgentStack.AgentSpaceRoleArn = arn:aws:iam::123456789012:role/DevOpsAgentRole-AgentSpace
DevOpsAgentStack.OperatorRoleArn = arn:aws:iam::123456789012:role/DevOpsAgentRole-WebappAdmin
DevOpsAgentStack.AssociationId = assoc-xyz

パート 2 を完了する予定がある場合は、AgentSpaceArn値を保存します。サービスアカウントスタックを設定するには、これが必要です。

ステップ 5: デプロイを検証する

エージェントスペースが正常に作成されたことを確認するには、次の AWS CLI コマンドを実行します。

aws devopsagent get-agent-space \
  --agent-space-id <AGENT_SPACE_ID> \
  --region <REGION>

この時点で、エージェントスペースはオペレーターアプリが有効で、モニタリングアカウントが関連付けられている状態でデプロイされます。エージェントはこのアカウントの問題をモニタリングできます。

パート 2 (オプション): クロスアカウントモニタリングを追加する

このセクションでは、エージェントスペースが 2 番目の AWS アカウント (サービスアカウント) のリソースをモニタリングできるようにセットアップを拡張します。これには、次の 2 つのアクションが含まれます。

ステップ 1: サービスアカウント ID を設定する

を開きlib/constants.ts、サービスアカウント ID を設定します。

次の例は、更新する定数を示しています。

export const SERVICE_ACCOUNT_ID = "<YOUR_SERVICE_ACCOUNT_ID>";

DevOpsAgentStack は、このアカウント ID を使用してソース AWS の関連付けを作成します。この値を設定する前に DevOpsAgentStack をデプロイした場合は、再デプロイして関連付けを作成します。

次のコマンドを実行して再デプロイします。

npm run build
cdk deploy DevOpsAgentStack --profile monitoring

ステップ 2: エージェントスペース ARN を設定する

DevOpsAgentStack 出力 (パート 1、ステップ 4) からAgentSpaceArn値をコピーし、 で設定しますlib/constants.ts。

次の例は、更新する定数を示しています。

export const AGENT_SPACE_ARN = "arn:aws:aidevops:<REGION>:<MONITORING_ACCOUNT_ID>:agentspace/<SPACE_ID>";

ServiceStack はこの値を使用して、セカンダリアカウントロールの信頼ポリシーの範囲を設定します。ServiceStack は、この値が設定されている場合にのみ合成されます。

ステップ 3: サービスアカウントをブートストラップする

サービスアカウントで AWS CDK をブートストラップしていない場合は、次のコマンドを実行します。

cdk bootstrap aws://<SERVICE_ACCOUNT_ID>/<REGION> --profile service

ステップ 4: ServiceStack をデプロイする

次のコマンドを実行して、サービスアカウントの認証情報を使用して ServiceStack を構築およびデプロイします。

npm run build
cdk deploy ServiceStack --profile service

これにより、サービスアカウントに次のリソースが作成されます。

ステップ 5: デプロイを検証する

Lambda 関数が正常にデプロイされたことを確認するには、次のコマンドを実行してエコーサービスをテストします。

aws lambda invoke \
  --function-name echo-service \
  --payload '{"test": "hello world"}' \
  --profile service \
  response.json
cat response.json

トラブルシューティング

このセクションでは、一般的な問題とその解決方法について説明します。

CloudFormation リソースタイプが見つかりません

IAM ロールの作成に失敗しました

クロスアカウントデプロイが「ターゲットアカウントでロールを引き受けることができませんでした」で失敗する

IAM 伝達の遅延

クリーンアップ

すべてのリソースを削除するには、スタックを逆の順序で破棄します。

次のコマンドを実行して、スタックを破棄します。

# If you deployed the ServiceStack, destroy it first
cdk destroy ServiceStack --profile service
# Then destroy the DevOpsAgentStack
cdk destroy DevOpsAgentStack --profile monitoring

警告: このアクションは、エージェントスペースと関連するすべてのデータを完全に削除します。このアクションは元に戻すことができません。続行する前に、重要な情報がバックアップされていることを確認してください。

セキュリティに関する考慮事項

次の手順

AWS CDK を使用して AWS DevOps エージェントをデプロイした後:

その他のリソース