MENU
  1. ホーム
  2. PowerShell
  3. PowerShellでAWS CodeBuildプロジェクトを作成する完全ガイド

PowerShellでAWS CodeBuildプロジェクトを作成する完全ガイド

PowerShell

AWS CodeBuildを利用することで、ソースコードのビルドとテストのプロセスを自動化し、継続的なインテグレーションを効率的に行うことが可能です。本記事では、PowerShellを活用してAWS CodeBuildプロジェクトを作成し、ビルド手順を定義する具体的なワークフローを解説します。初心者にも分かりやすいように、基本的な環境設定からプロジェクト作成、トラブルシューティングまでの流れを網羅しています。これにより、DevOpsプロセスの自動化をスムーズに進めるためのスキルを習得できます。

目次
  1. AWS CodeBuildとPowerShellの概要
    1. PowerShellを使用する利点
    2. CodeBuildの主要な機能
  2. AWS CLIのセットアップと前提条件
    1. AWS CLIのインストール
    2. AWS Tools for PowerShellのインストール
    3. AWSアカウントとIAM設定
    4. 認証情報の設定
    5. 前提条件のチェック
  3. CodeBuildプロジェクトの作成手順
    1. 1. プロジェクト作成用スクリプトの準備
    2. 2. パラメータの詳細
    3. 3. スクリプトの実行
    4. 4. S3バケットとソースコードの準備
    5. 5. プロジェクトのビルド実行
    6. 6. ビルド結果の確認
  4. ビルド手順の定義と設定
    1. 1. buildspec.ymlファイルの役割
    2. 2. buildspec.ymlの基本構造
    3. 3. 各セクションの詳細
    4. 4. buildspec.ymlのアップロード
    5. 5. プロジェクトでbuildspec.ymlを指定
    6. 6. ビルドの実行と確認
  5. 実践例: 簡単なビルドプロジェクトの構築
    1. 1. サンプルアプリケーションの準備
    2. 2. ソースコードを圧縮してS3にアップロード
    3. 3. CodeBuildプロジェクトの作成
    4. 4. ビルドの開始
    5. 5. ビルド結果の確認
    6. 6. 結果の確認と次のステップ
  6. トラブルシューティングとベストプラクティス
    1. 1. トラブルシューティング
    2. 2. ベストプラクティス
    3. 3. まとめ
  7. まとめ

AWS CodeBuildとPowerShellの概要


AWS CodeBuildは、ソースコードのビルドとテストをクラウド上で実行するための完全マネージド型のサービスです。このサービスは、オンプレミスでのビルド環境の設定や維持の手間を省き、スケーラブルかつ効率的にビルドプロセスを実行することが可能です。

PowerShellを使用する利点


PowerShellを活用すると、AWS CodeBuildの操作をスクリプト化して、自動化されたワークフローを実現できます。以下のような利点があります。

  • 簡単なスクリプト記述：PowerShellのコマンドレットを利用して、AWSリソースを直感的に操作可能。
  • 再利用性：スクリプトを再利用することで、複数のプロジェクトに対応。
  • 柔軟な統合：他のツールやサービスとの連携が容易。

CodeBuildの主要な機能


AWS CodeBuildは以下の主要な機能を提供します。

  • 多言語対応：Java、Python、Node.js、C++ など、さまざまなプログラミング言語をサポート。
  • カスタムビルド環境：Dockerを使用して独自のビルド環境を定義可能。
  • 継続的インテグレーション/継続的デリバリー（CI/CD）のサポート：AWS CodePipelineや他のCI/CDツールと簡単に統合可能。

PowerShellとAWS CodeBuildを組み合わせることで、効率的でスケーラブルなビルドプロセスを実現するための強力なフレームワークが完成します。次章では、この組み合わせを実現するために必要な環境構築と準備について詳しく説明します。

AWS CLIのセットアップと前提条件

PowerShellを利用してAWS CodeBuildを操作するには、AWS CLI（Command Line Interface）のセットアップといくつかの前提条件を満たす必要があります。このセクションでは、PowerShell環境をAWSと連携するための準備手順を解説します。

AWS CLIのインストール

  1. 公式サイトからインストーラーをダウンロード
  1. インストール
  • インストーラーを実行し、指示に従ってインストールします。MacOSやLinuxではパッケージマネージャーを利用できます。
  1. インストール確認
    PowerShellで以下のコマンドを実行し、バージョン情報が表示されることを確認します。
   aws --version

AWS Tools for PowerShellのインストール


AWS CLIを補完する形で、AWS Tools for PowerShellを利用すると、PowerShellからAWSリソースを直接操作できます。

  1. インストールコマンド
    PowerShellで以下のコマンドを実行します。
   Install-Module -Name AWSPowerShell -Force
  1. モジュールの確認
    モジュールが正しくインストールされたか確認します。
   Get-Module -Name AWSPowerShell -ListAvailable

AWSアカウントとIAM設定


AWSリソースにアクセスするためには、適切なIAMユーザーまたはロールを設定する必要があります。

  1. AWSアカウントの作成
  1. IAMユーザーの作成
  • AWS Management ConsoleでIAMユーザーを作成し、プログラムアクセスを有効化します。
  • ユーザーに「AdministratorAccess」ポリシーを割り当てることを推奨します（必要最低限の権限にする場合は、CodeBuild関連ポリシーを付与）。
  1. アクセスキーの取得
  • 作成したIAMユーザーのアクセスキーIDとシークレットキーを取得します。

認証情報の設定


AWS CLIにアクセスキー情報を設定します。

  1. 認証情報を登録
    PowerShellで以下のコマンドを実行し、アクセスキー情報を設定します。
   aws configure
  • アクセスキーID、シークレットアクセスキー、デフォルトリージョン、出力形式を入力します。
  1. 設定の確認
    設定が正しいか確認します。
   aws sts get-caller-identity

前提条件のチェック


以下の項目を満たしていることを確認してください。

  • AWS CLIとAWS Tools for PowerShellが正常に動作すること。
  • IAMユーザーにCodeBuild関連の操作権限が付与されていること。
  • 必要なAWSリージョンが指定されていること。

次の章では、PowerShellを使用した具体的なCodeBuildプロジェクトの作成手順を説明します。

CodeBuildプロジェクトの作成手順

PowerShellを使用してAWS CodeBuildプロジェクトを作成するプロセスを、ステップバイステップで解説します。この手順に従うことで、基本的なビルドプロジェクトを簡単に構築できます。

1. プロジェクト作成用スクリプトの準備


以下のPowerShellスクリプトを作成して、CodeBuildプロジェクトを定義します。このスクリプトは、AWS Tools for PowerShellを利用します。

# パラメータの定義
$projectName = "MyCodeBuildProject"
$sourceBucket = "my-source-bucket"
$sourceKey = "source-code.zip"
$buildImage = "aws/codebuild/standard:6.0"
$serviceRole = "arn:aws:iam::123456789012:role/service-role/codebuild-service-role"

# CodeBuildプロジェクトの作成
New-CBProject -Name $projectName `
    -SourceType S3 `
    -SourceLocation "$sourceBucket/$sourceKey" `
    -Environment_ComputeType BUILD_GENERAL1_SMALL `
    -Environment_Image $buildImage `
    -Environment_Type LINUX_CONTAINER `
    -ServiceRole $serviceRole `
    -Artifacts_Type NO_ARTIFACTS

2. パラメータの詳細


上記のスクリプトで指定するパラメータの意味は次の通りです。

  • $projectName：CodeBuildプロジェクトの名前。
  • $sourceBucket と $sourceKey：ビルド対象のソースコードが格納されているS3バケットとキー。
  • $buildImage：CodeBuildのビルド環境イメージ（AWS CodeBuildの標準イメージを使用）。
  • $serviceRole：CodeBuildに付与するIAMロール。必要なポリシーを事前に設定してください。
  • -Artifacts_Type：ビルド成果物の保存方法（ここでは成果物を保存しない設定）。

3. スクリプトの実行


PowerShellでスクリプトを実行すると、指定した設定に基づいてCodeBuildプロジェクトが作成されます。
スクリプトを実行後、以下のコマンドでプロジェクトが作成されたことを確認します。

Get-CBProject -Name $projectName

4. S3バケットとソースコードの準備


CodeBuildプロジェクトを実行するためには、ビルド対象のソースコードをS3バケットにアップロードする必要があります。以下のコマンドでアップロードを行います。

Write-S3Object -BucketName $sourceBucket -Key $sourceKey -File "source-code.zip"

5. プロジェクトのビルド実行


プロジェクトを作成したら、以下のコマンドでビルドを開始できます。

Start-CBBuild -ProjectName $projectName

6. ビルド結果の確認


ビルド結果を確認するには、以下のコマンドを実行します。

Get-CBBuild -Ids (Get-CBBuildList -ProjectName $projectName).Ids[0]

これで、CodeBuildプロジェクトの作成とビルドの実行が完了です。次章では、ビルド手順を詳細に定義する方法について説明します。

ビルド手順の定義と設定

AWS CodeBuildでは、ビルドプロセスをbuildspec.ymlファイルで定義します。このファイルは、ビルドの手順、環境変数、アーティファクトの保存先などを記述するYAML形式の設定ファイルです。このセクションでは、buildspec.ymlファイルの作成方法と設定の詳細を解説します。

1. buildspec.ymlファイルの役割


buildspec.ymlファイルは、以下のような項目を定義します。

  • 環境変数：ビルド中に使用する値の設定。
  • フェーズ：インストール、プリビルド、ビルド、ポストビルドなど、ビルドプロセスを段階ごとに定義。
  • アーティファクト：ビルドの成果物を保存する場所と形式の指定。
  • レポート：テスト結果やログの生成設定。

2. buildspec.ymlの基本構造


以下は、buildspec.ymlの基本的なテンプレートです。

version: 0.2

env:
  variables:
    ENV_VARIABLE: "value"

phases:
  install:
    commands:
      - echo "Installing dependencies..."
      - apt-get update && apt-get install -y some-dependency
  pre_build:
    commands:
      - echo "Preparing the build environment..."
      - npm install
  build:
    commands:
      - echo "Building the application..."
      - npm run build
  post_build:
    commands:
      - echo "Build completed successfully."

artifacts:
  files:
    - '**/*'
  discard-paths: yes
  base-directory: build/

3. 各セクションの詳細

envセクション


環境変数を定義します。ビルド中に繰り返し使用する値を設定します。

phasesセクション

  • installフェーズ：依存関係やビルド環境の準備を行います。
  • pre_buildフェーズ：ビルドの直前に行う処理を記述します。
  • buildフェーズ：実際のビルド手順を定義します。
  • post_buildフェーズ：ビルドの後処理や結果の送信を行います。

artifactsセクション


ビルド成果物を指定します。成果物をS3バケットに保存する場合、base-directoryを指定してビルド成果物のルートディレクトリを設定します。

4. buildspec.ymlのアップロード


作成したbuildspec.ymlをプロジェクトのルートディレクトリに配置し、ソースコードと共にS3バケットにアップロードします。以下のコマンドを使用してアップロードします。

Write-S3Object -BucketName "my-source-bucket" -Key "source-code.zip" -File "source-code.zip"

5. プロジェクトでbuildspec.ymlを指定


CodeBuildプロジェクトでbuildspec.ymlを使用するには、以下のコマンドを実行してプロジェクト設定を更新します。

Update-CBProject -Name "MyCodeBuildProject" -Source_Buildspec "buildspec.yml"

6. ビルドの実行と確認


PowerShellからビルドを開始し、ビルド手順が正しく実行されているか確認します。

Start-CBBuild -ProjectName "MyCodeBuildProject"
Get-CBBuild -Ids (Get-CBBuildList -ProjectName "MyCodeBuildProject").Ids[0]

これにより、ビルド手順が適切に定義され、実行可能になります。次章では、実践例として具体的なビルドプロジェクトを構築する方法を解説します。

実践例: 簡単なビルドプロジェクトの構築

ここでは、PowerShellを使用して、シンプルなNode.jsアプリケーションをAWS CodeBuildでビルドするプロジェクトを構築する例を紹介します。この実践例により、CodeBuildの基本的な使い方を学ぶことができます。

1. サンプルアプリケーションの準備


ビルド対象となるサンプルのNode.jsアプリケーションを作成します。以下のファイル構成をローカル環境で用意してください。

/sample-app
├── package.json
├── index.js
├── buildspec.yml

package.json の内容

{
  "name": "sample-app",
  "version": "1.0.0",
  "scripts": {
    "build": "echo Building the application...",
    "test": "echo Running tests..."
  }
}

index.js の内容

console.log("Hello, AWS CodeBuild!");

buildspec.yml の内容

version: 0.2

phases:
  install:
    commands:
      - echo "Installing dependencies..."
      - npm install
  build:
    commands:
      - echo "Building the application..."
      - npm run build
  post_build:
    commands:
      - echo "Build completed successfully."

artifacts:
  files:
    - '**/*'

2. ソースコードを圧縮してS3にアップロード


準備したファイルをZIP形式に圧縮し、S3バケットにアップロードします。PowerShellを使用して以下の手順を実行します。

# ファイルの圧縮
Compress-Archive -Path ./sample-app/* -DestinationPath ./source-code.zip

# S3へのアップロード
Write-S3Object -BucketName "my-source-bucket" -Key "source-code.zip" -File "source-code.zip"

3. CodeBuildプロジェクトの作成


以下のPowerShellコマンドでCodeBuildプロジェクトを作成します。

$projectName = "NodeJsSampleProject"
$sourceBucket = "my-source-bucket"
$sourceKey = "source-code.zip"
$buildImage = "aws/codebuild/standard:6.0"
$serviceRole = "arn:aws:iam::123456789012:role/service-role/codebuild-service-role"

New-CBProject -Name $projectName `
    -SourceType S3 `
    -SourceLocation "$sourceBucket/$sourceKey" `
    -Environment_ComputeType BUILD_GENERAL1_SMALL `
    -Environment_Image $buildImage `
    -Environment_Type LINUX_CONTAINER `
    -ServiceRole $serviceRole `
    -Artifacts_Type NO_ARTIFACTS

4. ビルドの開始


以下のコマンドを実行してビルドを開始します。

Start-CBBuild -ProjectName $projectName

ビルドが開始され、buildspec.ymlで定義した手順が実行されます。

5. ビルド結果の確認


ビルド結果を確認するには以下のコマンドを使用します。

Get-CBBuild -Ids (Get-CBBuildList -ProjectName $projectName).Ids[0]

ビルドログを確認して、正しく実行されているか検証します。

6. 結果の確認と次のステップ


ビルド結果が正常であれば、ビルドプロセスは成功しています。この基本的なプロジェクトを拡張し、以下を試してみてください。

  • テストの実行：npm testの追加。
  • アーティファクトの保存：ビルド成果物をS3に保存する設定を追加。

次章では、トラブルシューティングとベストプラクティスについて解説します。

トラブルシューティングとベストプラクティス

AWS CodeBuildプロジェクトで問題が発生した場合、適切なトラブルシューティングとベストプラクティスを活用することで、迅速に問題を解決し、プロジェクトの効率を最大化できます。このセクションでは、よくあるエラーの対処法と、プロジェクト運用のための最善の方法を紹介します。

1. トラブルシューティング

1.1 ビルドの失敗


エラーメッセージが役立つ

  • CodeBuildのコンソールでビルドの詳細ログを確認します。
  • PowerShellで以下のコマンドを実行してログを取得します。
  Get-CBBuild -Ids (Get-CBBuildList -ProjectName "MyProjectName").Ids[0]

よくある原因

  • buildspec.ymlの記述ミス：YAML形式はインデントに厳密なので、スペースやコロンの位置を確認してください。
  • ビルド環境の設定ミス：正しいDockerイメージが選択されているか確認します。

解決策

  • buildspec.ymlを公式ドキュメントと比較して修正します。
  • ビルド環境のイメージを変更し、再実行します。

1.2 S3からのソース取得エラー


エラー例: SourceLocationNotFound
原因

  • ソースコードが正しいバケットに存在しない。
  • IAMロールにS3アクセス権限が不足している。

解決策

  • S3バケットとオブジェクトキーが正しいか確認します。
  • IAMロールに以下のポリシーを追加します。
  {
    "Effect": "Allow",
    "Action": "s3:GetObject",
    "Resource": "arn:aws:s3:::my-source-bucket/*"
  }

1.3 IAMロールの権限不足


エラー例: AccessDenied
解決策

  • IAMロールに必要な権限を付与します。CodeBuildプロジェクトでは以下のようなポリシーが必要です。
  {
    "Effect": "Allow",
    "Action": [
      "s3:GetObject",
      "logs:CreateLogStream",
      "logs:PutLogEvents",
      "codebuild:StartBuild"
    ],
    "Resource": "*"
  }

2. ベストプラクティス

2.1 buildspec.ymlのバージョン管理


ビルド手順を定義したbuildspec.ymlは、ソースコードと同じリポジトリで管理することで、変更履歴を追跡できます。

2.2 アーティファクトの保存


ビルド成果物を保存するには、buildspec.ymlのartifactsセクションを活用し、S3や他のストレージサービスに成果物を保存します。

例:

artifacts:
  files:
    - '**/*'
  base-directory: build/
  discard-paths: yes

2.3 ログの活用


CodeBuildプロジェクトのログをAmazon CloudWatchに保存しておくと、ビルドの分析やエラーの追跡に役立ちます。プロジェクト作成時にlogsConfigを設定します。

2.4 最小権限の適用


IAMロールには必要最小限の権限を付与し、セキュリティを向上させます。具体的なリソースを指定することで、アクセス範囲を限定します。

2.5 Dockerキャッシュの活用


頻繁に使用する依存関係やビルドツールをキャッシュすることで、ビルド時間を短縮できます。

3. まとめ


トラブルシューティングとベストプラクティスを理解することで、AWS CodeBuildの運用がスムーズになり、エラー発生時の対応も迅速に行えます。次章では、記事の総まとめとして全体を振り返ります。

まとめ

本記事では、PowerShellを活用してAWS CodeBuildプロジェクトを作成し、ビルド手順を定義する方法を解説しました。CodeBuildの概要から始まり、必要な環境のセットアップ、buildspec.ymlの作成、実践的なビルドプロジェクトの構築方法、さらにトラブルシューティングとベストプラクティスまで網羅しました。

適切なツールと手順を使用することで、ビルドプロセスの効率化と自動化を実現し、DevOpsの強化につなげることができます。これを機に、より複雑なプロジェクトやカスタムビルドフローにも挑戦してみてください。AWS CodeBuildとPowerShellを組み合わせて、スケーラブルで効果的なビルドプロセスを構築しましょう。

PowerShell
PowerShell AWS DevOps CodeBuild

コメント

コメントする

目次
  1. AWS CodeBuildとPowerShellの概要
    1. PowerShellを使用する利点
    2. CodeBuildの主要な機能
  2. AWS CLIのセットアップと前提条件
    1. AWS CLIのインストール
    2. AWS Tools for PowerShellのインストール
    3. AWSアカウントとIAM設定
    4. 認証情報の設定
    5. 前提条件のチェック
  3. CodeBuildプロジェクトの作成手順
    1. 1. プロジェクト作成用スクリプトの準備
    2. 2. パラメータの詳細
    3. 3. スクリプトの実行
    4. 4. S3バケットとソースコードの準備
    5. 5. プロジェクトのビルド実行
    6. 6. ビルド結果の確認
  4. ビルド手順の定義と設定
    1. 1. buildspec.ymlファイルの役割
    2. 2. buildspec.ymlの基本構造
    3. 3. 各セクションの詳細
    4. 4. buildspec.ymlのアップロード
    5. 5. プロジェクトでbuildspec.ymlを指定
    6. 6. ビルドの実行と確認
  5. 実践例: 簡単なビルドプロジェクトの構築
    1. 1. サンプルアプリケーションの準備
    2. 2. ソースコードを圧縮してS3にアップロード
    3. 3. CodeBuildプロジェクトの作成
    4. 4. ビルドの開始
    5. 5. ビルド結果の確認
    6. 6. 結果の確認と次のステップ
  6. トラブルシューティングとベストプラクティス
    1. 1. トラブルシューティング
    2. 2. ベストプラクティス
    3. 3. まとめ
  7. まとめ