メインコンテンツまでスキップ

AWS CloudFormationテンプレート

AWS CloudFormationを使用すると、AWS上でのBitrise Cloud Controllerのワンクリックプロビジョニングと管理が簡単に行えます。CloudFormationテンプレートを顧客のVPCにデプロイすると、Bitrise Cloud Controllerと付随するインフラストラクチャが作成されます。

cloudformation.png

Bitriseは、さまざまなユースケース向けにCloudFormationテンプレートを提供しています。

  • 既存のVPCにCloud Controllerをデプロイする: すでにAWS環境が構築されており、ネットワーキングが整っている場合は、このテンプレートを選択してください。
  • 新規のVPCにCloud Controllerをデプロイする: AWSを初めて使用する場合や、ネットワーキングがまだ構築されていない場合は、このテンプレートを選択してください。このテンプレートは、最初に(顧客の希望に基づいて)新しいVPCを作成し、その後コントローラーをデプロイします。
  • 既存のVPCにエアギャップCloud Controllerをデプロイする: すでにAWS環境が構築されており、ネットワーキングが整っていて、コントローラーを厳密なエアギャップ環境で実行したい場合は、このテンプレートを選択してください。これは完全には自動化されておらず、一部の手動設定が必要です。
  • 新規のVPCにエアギャップCloud Controllerをデプロイする: AWSを初めて使用する場合や、ネットワーキングがまだ構築されていない場合で、コントローラーを厳密なエアギャップ環境で実行したい場合は、このテンプレートを選択してください。このテンプレートは、最初に適切なエアギャップ構成で新しいVPCを作成し、その後コントローラーをデプロイします。

既存のVPCにCloudControllerをデプロイするClick to copy link​

テンプレートパラメーター:

  • Stack Name(必須): AWSアカウント内のBitrise Cloud Controller親スタックを識別します。
  • Latest AMI ID: このAMI IDは、Cloud Controllerを実行するためのベースAMIとして使用されます。
  • BitriseControllerToken(必須): Bitrise Website上でコントローラーを作成する際にユーザーが受け取るコントローラートークンです。
  • BitriseWorkspaceID(必須): 顧客のBitriseアカウントに属するworkspace IDです。
  • ControllerLogGroupClass(必須): コントローラーは、顧客のAWSアカウント内のCloudWatch log groupにエラーログを保存します。どのLog Group Classが予算に最も適しているかは、顧客が管理します。ほとんどの場合、default valueが適しています。デフォルト: INFREQUENT_ACCESS。
  • ControllerLogRetentionInDays(必須): CloudWatchがコントローラーのエラーログを保持する日数です。デフォルト: 7(日)。
  • ControllerSshKey(必須): Cloud ControllerインスタンスへのSSHアクセスを提供します。
  • SubnetIds(必須): 同一リージョン内で、異なるAZに属する少なくとも2つのサブネットです。プライベートサブネットの使用を推奨していますが、パブリックサブネットでも問題ありません。
  • VpcId(必須): コントローラーがデプロイされるVPCです。
  • VpcCidrBlock(必須): 選択したVPCのCIDRブロックです。
  • CustomBashScript(任意): インスタンス起動時に実行するカスタムbashスクリプト
  • UseHostNetwork (required): Dockerコンテナでホストネットワークモードを使用します(--net=host)

テンプレートによってプロビジョニングされるインフラストラクチャClick to copy link​

  • Internal Application Load Balancer: サーバーにトラフィックは発生せず、Cloud Controllerインスタンスに対して定期的なヘルスチェックのみを行います。いずれの場合も、コントローラーとbuild machinesはBitriseコントロールプレーンに向けてネットワーク呼び出しを開始するため、外部からのインバウンドトラフィックは不要です。
  • Autoscaling Group: 常に正常なCloud Controllerインスタンスが1つ実行されている状態を保証します。Instance: Cloud Controllerが実行されるt2.smallインスタンスです。
  • LaunchTemplate: Cloud Controllerインスタンスの構成です。コントローラーの自己更新機能にも必要です。
  • IAM role, instance profile, and policy: コントローラーがビルドノードの状態を照会するために、特定の権限が必要です。
  • AWS Secrets Manager: このテンプレートは、WorkspaceIDとController Tokenをそれぞれ保存するための2つのシークレットを作成します。
  • CloudWatch log group: このテンプレートは、コントローラーのエラーログを保存するためのCloudWatch log groupを作成します。
  • Security groups: このテンプレートは、LoadBalancer用とインスタンス用の2つのセキュリティグループを作成します。

新規のVPCにCloud ControllerをデプロイするClick to copy link​

テンプレートパラメーター:

  • Stack Name(必須): AWSアカウント内のBitrise Cloud Controller親スタックを識別します。
  • Latest AMI ID: このAMI IDは、Cloud Controllerを実行するためのベースAMIとして使用されます。
  • BitriseControllerToken(必須): Bitrise Website上でコントローラーを作成する際にユーザーが受け取るコントローラートークンです。
  • BitriseWorkspaceID(必須): 顧客のBitriseアカウントに属するworkspace IDです。
  • ControllerLogGroupClass(必須): コントローラーは、顧客のAWSアカウント内のCloudWatch log groupにエラーログを保存します。どのLog Group Classが予算に最も適しているかは、顧客が管理します。ほとんどの場合、default valueが適しています。デフォルト: INFREQUENT_ACCESS。
  • ControllerLogRetentionInDays(必須): CloudWatchがコントローラーのエラーログを保持する日数です。デフォルト: 7(日)。
  • ControllerSshKey(必須): Cloud ControllerインスタンスへのSSHアクセスを提供します。
  • EnvironmentName(任意): Bitrise関連の各インフラストラクチャに、Environment Nameで指定したプレフィックスを付加します。顧客が非常に多くのリソースを保有している場合、Bitrise関連のリソースを他と区別できると便利です。
  • PrivateSubnet1CIDR(必須): 新しいVPCの1つ目のプライベートサブネットのCIDR範囲です。デフォルト: 10.192.32.0/20。
  • PrivateSubnet2CIDR(必須): 新しいVPCの2つ目のプライベートサブネットのCIDR範囲です。デフォルト: 10.192.64.0/20。
  • PublicSubnet1CIDR(必須): 新しいVPCの1つ目のパブリックサブネットのCIDR範囲です。デフォルト: 10.192.0.0/20。
  • PublicSubnet2CIDR(必須): 新しいVPCの2つ目のパブリックサブネットのCIDR範囲です。デフォルト: 10.192.16.0/20
  • VpcCidrBlock(必須): 選択したVPCのCIDRブロックです。
  • CustomBashScript(任意): インスタンス起動時に実行するカスタムbashスクリプト
  • UseHostNetwork (required): Dockerコンテナでホストネットワークモードを使用します(--net=host)

テンプレートによってプロビジョニングされるインフラストラクチャClick to copy link​

  • Internal Application Load Balancer: サーバーにトラフィックは発生せず、Cloud Controllerインスタンスに対して定期的なヘルスチェックのみを行います。いずれの場合も、コントローラーとbuild machinesはBitriseコントロールプレーンに向けてネットワーク呼び出しを開始するため、外部からのインバウンドトラフィックは不要です。

  • Autoscaling Group: 常に正常なCloud Controllerインスタンスが1つ実行されている状態を保証します。

  • Instance: Cloud Controllerが実行されるt2.smallインスタンスです。

  • LaunchTemplate: Cloud Controllerインスタンスの構成です。コントローラーの自己更新機能にも必要です。

  • IAM role, instance profile, and policy: コントローラーがビルドノードの状態を照会するために、特定の権限が必要です。

  • AWS Secrets Manager: このテンプレートは、WorkspaceIDとController Tokenをそれぞれ保存するための2つのシークレットを作成します。

  • CloudWatch log group: このテンプレートは、コントローラーのエラーログを保存するためのCloudWatch log groupを作成します。

  • Security groups: このテンプレートは、LoadBalancer用とインスタンス用の2つのセキュリティグループを作成します。

  • VPC: ベストプラクティスに基づく、標準的な汎用VPCです。デフォルトのCIDRブロックを選択すると、各サブネットで4096個の利用可能なIPアドレスが確保されます。このテンプレートが作成するVPC関連リソースの一覧は次のとおりです。

    • VPCを1つ。
    • パブリックサブネットを2つ。
    • プライベートサブネットを2つ。
    • NATゲートウェイを1つ + Elastic IPを1つ。
    • インターネットゲートウェイを1つ + Elastic IPを1つ。
    • ルートテーブル。
  • Bitrise Agent Logs: この機能により、Bitrise AgentのビルドログをAWS CloudWatchへシームレスに送信できます。CloudFormationを活用して必要なIAMロールとポリシーを自動的に設定し、Bitrise Agentが適切な権限を持てるようにします。さらに、CloudWatch内にbitrise-agent-logという名前の専用ロググループを作成し、AWS環境内での整理されたログ管理とリアルタイム分析を可能にします。

既存のVPCにエアギャップCloud ControllerをデプロイするClick to copy link​

テンプレートパラメーター:

  • Stack Name(必須): AWSアカウント内のBitrise Cloud Controller親スタックを識別します。
  • BitriseControllerToken(必須): Bitrise Website上でコントローラーを作成する際にユーザーが受け取るコントローラートークンです。
  • BitriseWorkspaceID(必須): 顧客のBitriseアカウントに属するworkspace IDです。
  • ControllerLogGroupClass(必須): コントローラーは、顧客のAWSアカウント内のCloudWatch log groupにエラーログを保存します。どのLog Group Classが予算に最も適しているかは、顧客が管理します。ほとんどの場合、default valueが適しています。デフォルト: INFREQUENT_ACCESS。
  • ControllerLogRetentionInDays(必須): CloudWatchがコントローラーのエラーログを保持する日数です。デフォルト: 7(日)。
  • ControllerSshKey(必須): Cloud ControllerインスタンスへのSSHアクセスを提供します。
  • SubnetIds(必須): 同一リージョン内で、異なるAZに属する少なくとも2つのサブネットです。プライベートサブネットの使用を推奨していますが、パブリックサブネットでも問題ありません。
  • VpcId(必須): コントローラーがデプロイされるVPCです。
  • VpcCidrBlock(必須): 選択したVPCのCIDRブロックです。
  • CustomBashScript(任意): インスタンス起動時に実行するカスタムbashスクリプト
  • UseHostNetwork (required): Dockerコンテナでホストネットワークモードを使用します(--net=host)

テンプレートによってプロビジョニングされるインフラストラクチャClick to copy link​

  • Internal Application Load Balancer: サーバーにトラフィックは発生せず、Cloud Controllerインスタンスに対して定期的なヘルスチェックのみを行います。いずれの場合も、コントローラーとbuild machinesはBitriseコントロールプレーンに向けてネットワーク呼び出しを開始するため、外部からのインバウンドトラフィックは不要です。
  • Autoscaling Group: 常に正常なCloud Controllerインスタンスが1つ実行されている状態を保証します。Instance: Cloud Controllerが実行されるt2.smallインスタンスです。
  • Airgapped LaunchTemplate: Cloud Controllerインスタンスの構成です。コントローラーの自己更新機能にも必要です。
  • Airgapped IAM role, instance profile, and policy: コントローラーがビルドノードの状態を照会し、必要なBitriseプライベートECRにアクセスするために、特定の権限が必要です。
  • AWS Secrets Manager: このテンプレートは、WorkspaceIDとController Tokenをそれぞれ保存するための2つのシークレットを作成します。
  • CloudWatch log group: このテンプレートは、コントローラーのエラーログを保存するためのCloudWatch log groupを作成します。
  • Airgapped security groups: このテンプレートは、LoadBalancer用とインスタンス用の2つのセキュリティグループを作成します。
  • Bitrise Agent Logs: この機能により、Bitrise AgentのビルドログをAWS CloudWatchへシームレスに送信できます。CloudFormationを活用して必要なIAMロールとポリシーを自動的に設定し、Bitrise Agentが適切な権限を持てるようにします。さらに、CloudWatch内にbitrise-agent-logという名前の専用ロググループを作成し、AWS環境内での整理されたログ管理とリアルタイム分析を可能にします。

エアギャップテンプレートの手動設定Click to copy link​

  1. 設定済みのサブネットを使用して、次のインターフェイス型VPCエンドポイントを作成します。

    すべてのエンドポイントでプライベートDNSが有効になっていることを確認してください。

    • com.amazonaws.${AWS::Region}.autoscaling: コントローラーの自己更新に使用します。
    • com.amazonaws.${AWS::Region}.ec2: EC2インスタンスと専用ホストの管理に使用します。
    • com.amazonaws.${AWS::Region}.ecr.api: BitriseプライベートECRからコントローラーバイナリをダウンロードするために使用します。
    • com.amazonaws.${AWS::Region}.ecr.dkr: BitriseプライベートECRからコントローラーバイナリをダウンロードするために使用します。
    • com.amazonaws.${AWS::Region}.logs: コントローラーログをCloudWatchに送信するために使用します。
    • com.amazonaws.${AWS::Region}.secretsmanager: シークレットへのアクセスに使用します。
  2. 作成したエンドポイントを、インスタンスのセキュリティグループに適用します。

新規のVPCにエアギャップCloud ControllerをデプロイするClick to copy link​

テンプレートパラメーター:

  • Stack Name(必須): AWSアカウント内のBitrise Cloud Controller親スタックを識別します。
  • Latest AMI ID: このAMI IDは、Cloud Controllerを実行するためのベースAMIとして使用されます。
  • BitriseControllerToken(必須): Bitrise Website上でコントローラーを作成する際にユーザーが受け取るコントローラートークンです。
  • BitriseWorkspaceID(必須): 顧客のBitriseアカウントに属するworkspace IDです。
  • ControllerLogGroupClass(必須): コントローラーは、顧客のAWSアカウント内のCloudWatch log groupにエラーログを保存します。どのLog Group Classが予算に最も適しているかは、顧客が管理します。ほとんどの場合、default valueが適しています。デフォルト: INFREQUENT_ACCESS。
  • ControllerLogRetentionInDays(必須): CloudWatchがコントローラーのエラーログを保持する日数です。デフォルト: 7(日)。
  • ControllerSshKey(必須): Cloud ControllerインスタンスへのSSHアクセスを提供します。
  • EnvironmentName(任意): Bitrise関連の各インフラストラクチャに、Environment Nameで指定したプレフィックスを付加します。顧客が非常に多くのリソースを保有している場合、Bitrise関連のリソースを他と区別できると便利です。
  • PrivateSubnet1CIDR(必須): 新しいVPCの1つ目のプライベートサブネットのCIDR範囲です。デフォルト: 10.192.32.0/20。
  • PrivateSubnet2CIDR(必須): 新しいVPCの2つ目のプライベートサブネットのCIDR範囲です。デフォルト: 10.192.64.0/20。
  • PublicSubnet1CIDR(必須): 新しいVPCの1つ目のパブリックサブネットのCIDR範囲です。デフォルト: 10.192.0.0/20。
  • PublicSubnet2CIDR(必須): 新しいVPCの2つ目のパブリックサブネットのCIDR範囲です。デフォルト: 10.192.16.0/20
  • VpcCidrBlock(必須): 選択したVPCのCIDRブロックです。
  • CustomBashScript(任意): インスタンス起動時に実行するカスタムbashスクリプト
  • UseHostNetwork (required): Dockerコンテナでホストネットワークモードを使用します(--net=host)

テンプレートによってプロビジョニングされるインフラストラクチャClick to copy link​

  • Internal Application Load Balancer: サーバーにトラフィックは発生せず、Cloud Controllerインスタンスに対して定期的なヘルスチェックのみを行います。いずれの場合も、コントローラーとbuild machinesはBitriseコントロールプレーンに向けてネットワーク呼び出しを開始するため、外部からのインバウンドトラフィックは不要です。

  • Autoscaling Group: 常に正常なCloud Controllerインスタンスが1つ実行されている状態を保証します。Instance: Cloud Controllerが実行されるt2.smallインスタンスです。

  • Instance: Cloud Controllerが実行されるt2.smallインスタンスです。

  • Airgapped LaunchTemplate: Cloud Controllerインスタンスの構成です。コントローラーの自己更新機能にも必要です。

  • IAM role, instance profile, and policy: コントローラーがビルドノードの状態を照会するために、特定の権限が必要です。

  • AWS Secrets Manager: このテンプレートは、WorkspaceIDとController Tokenをそれぞれ保存するための2つのシークレットを作成します。

  • CloudWatch log group: このテンプレートは、コントローラーのエラーログを保存するためのCloudWatch log groupを作成します。

  • Airgapped security groups: このテンプレートは、LoadBalancer用とインスタンス用の2つのセキュリティグループを作成します。

  • VPC: ベストプラクティスに基づく、標準的な汎用VPCです。デフォルトのCIDRブロックを選択すると、各サブネットで4096個の利用可能なIPアドレスが確保されます。このテンプレートが作成するVPC関連リソースの一覧は次のとおりです。

    • VPCを1つ。
    • パブリックサブネットを2つ。
    • プライベートサブネットを2つ。
    • NATゲートウェイを1つ + Elastic IPを1つ。
    • インターネットゲートウェイを1つ + Elastic IPを1つ。
    • ルートテーブル。
  • VPC Endpoints: このテンプレートは、6つのインターフェイス型エンドポイントを作成し、インスタンスのセキュリティグループに接続することで、コントローラーがAWSリソースにアクセスできるようにします。

    • com.amazonaws.${AWS::Region}.autoscaling: コントローラーの自己更新に使用します。
    • com.amazonaws.${AWS::Region}.ec2: EC2インスタンスと専用ホストの管理に使用します。
    • com.amazonaws.${AWS::Region}.ecr.api: BitriseプライベートECRからコントローラーバイナリをダウンロードするために使用します。
    • com.amazonaws.${AWS::Region}.ecr.dkr: BitriseプライベートECRからコントローラーバイナリをダウンロードするために使用します。
    • com.amazonaws.${AWS::Region}.logs: コントローラーログをCloudWatchに送信するために使用します。
    • com.amazonaws.${AWS::Region}.secretsmanager: シークレットへのアクセスに使用します。
  • Bitrise Agent Logs: この機能により、Bitrise AgentのビルドログをAWS CloudWatchへシームレスに送信できます。CloudFormationを活用して必要なIAMロールとポリシーを自動的に設定し、Bitrise Agentが適切な権限を持てるようにします。さらに、CloudWatch内にbitrise-agent-logという名前の専用ロググループを作成し、AWS環境内での整理されたログ管理とリアルタイム分析を可能にします。

必要なAWS権限と接続性Click to copy link​

コントローラーがビルドノードに対して操作を行うには、特定のAWS権限が必要です。必要な権限は最小限の範囲に抑えるよう努めています。信頼性を高めるため、CloudFormationテンプレートのリポジトリも公開しています。必要な権限の(最新の)全リストは、リポジトリ内のこちらをご覧ください。

コントローラーは、特定のBitriseエンドポイントへの接続を必要とします。詳細はコントローラーのドキュメントをご覧ください。