Spring Boot アプリケーションをお手軽に本番運用

$ cd expt-apprunner-springboot // 前回作成したディレクトリに移動
$ mkdir cdk // CDK プロジェクトを格納するディレクトリの作成
$ npx cdk init --language typescript

import * as cdk from 'aws-cdk-lib';
import { StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as elasticache from 'aws-cdk-lib/aws-elasticache';

/**
* ElastiCache へ接続するための情報
*/
export type CacheConnection = {
  /** Redis に付与された SecurityGroup ID */
  readonly securityGroupId: string;
  /** Redis のホスト名 */
  readonly host: string;
  /** Redis のポート */
  readonly port: string;
}

/**
* Redis などのインフラを構築するスタック
*/
export class InfraStack extends cdk.Stack {

  /** 構築した VPC */
  readonly vpc: ec2.IVpc;
  /** 構築した Redis への接続情報 */
  readonly cacheConnection: CacheConnection;

  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // VPC を構築
    this.vpc = new ec2.Vpc(this, 'Vpc', {
      natGateways: 1
    });

    // Redis を構築し、そこに接続するための情報を保存する
    this.cacheConnection = this.cache();
  }

  /**
   * Redis を構築
   * @returns 構築した Redis へ接続するための情報
   */
  private cache(): CacheConnection {
    // Redis に付与されるセキュリティグループ
    const cacheSecurityGroup = new ec2.SecurityGroup(this, "CacheSecurityGroup", { vpc: this.vpc });

    // Redis を構築する VPC のサブネット
    const subnetGroup = new elasticache.CfnSubnetGroup(this, "CacheSubnetGroup", {
      subnetIds: this.vpc.selectSubnets({ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }).subnetIds,
      description: "Group of subnets to place Cache into",
    });

    // Redis 構築
    const cacheCluster = new elasticache.CfnCacheCluster(this, "CacheCluster", {
      engine: "redis",
      cacheNodeType: "cache.t3.micro",
      numCacheNodes: 1,
      cacheSubnetGroupName: subnetGroup.ref,
      vpcSecurityGroupIds: [cacheSecurityGroup.securityGroupId],
    });

    // Redis へ接続するための情報を返り値にする
    return {
      securityGroupId: cacheSecurityGroup.securityGroupId,
      host: cacheCluster.attrRedisEndpointAddress,
      port: cacheCluster.attrRedisEndpointPort,
    }
  }
}

new ec2.Vpc(this, 'Vpc', {
  natGateways: 1
});

#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { InfraStack } from '../lib/infra-stack';

const app = new cdk.App();

new InfraStack(app, 'InfraStack');

$ npx cdk bootstrap
 ⏳  Bootstrapping environment aws://xxxxx/us-west-2...
Trusted accounts for deployment: (none)
Trusted accounts for lookup: (none)
Using default execution policy of 'arn:aws:iam::aws:policy/AdministratorAccess'. Pass '--cloudformation-execution-policies' to customize.
CDKToolkit: creating CloudFormation changeset...
 ✅  Environment aws://xxxxx/us-west-2 bootstrapped.

$ npx cdk deploy

// build.gradle

...
dependencies {
    implementation('org.springframework.boot:spring-boot-starter-web')
    implementation('org.springframework.boot:spring-boot-starter-data-redis')
    ...

// src/main/resources/application.yaml
spring:
  redis:
    host: ${CACHE_HOST:localhost}
    port: ${CACHE_PORT:6379}
    password: ${CACHE_PASSWORD:}

// src/main/java/com/example/exptapprunnerspringboot/Application.java

package com.example.exptapprunnerspringboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

// 以下の二つのクラスを Import
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class Application {

    // RedisTemplate を Inject
    private final RedisTemplate<String, String> redisTemplate;

    Application(final RedisTemplate<String, String> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @GetMapping("/")
    public String root() {
        return "hello";
    }
    
    // 以下3つの Mapping を追加
    
    @GetMapping("/health")
    public String getHealth() {
        ValueOperations<String, String> ops = redisTemplate.opsForValue();
        return "Status: " + ops.get("health");
    }

    @GetMapping("/healthy")
    public String setHealty() {
        ValueOperations<String, String> ops = redisTemplate.opsForValue();
        ops.set("health", "healthy");
        return "Status: " + ops.get("health");
    }

    @GetMapping("/unhealthy")
    public String setUnhealty() {
        ValueOperations<String, String> ops = redisTemplate.opsForValue();
        ops.set("health", "unhealthy");
        return "Status: " + ops.get("health");
    }
}

git add src/main/resources/application.yaml
git add src/main/java/com/example/exptapprunnerspringboot/Application.java
git add build.gradle

git push

import * as cdk from 'aws-cdk-lib';
import { StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as apprunner from 'aws-cdk-lib/aws-apprunner';
import { CacheConnection } from './infra-stack';

export class ServiceStack extends cdk.Stack {
  constructor(scope: Construct, id: string, vpc: ec2.IVpc, cacheConnection: CacheConnection, props?: StackProps) {
    super(scope, id, props);

    // VPC での App Runner サービスのセキュリティグループ
    const vpcConnectionSecurityGroup = new ec2.SecurityGroup(this, "SecurityGroup", { vpc });

    // App Runner サービスが、ElastiCache へ接続できるようセキュリティグループを設定
    const cacheSecurityGroup = ec2.SecurityGroup.fromSecurityGroupId(
      this, "CacheSecurityGroup", cacheConnection.securityGroupId, {
    });
    cacheSecurityGroup.addIngressRule(
      vpcConnectionSecurityGroup, ec2.Port.tcp(6379), "Ingress to the cache");

    // App Runner サービスと VPC の接続 (VPC Connector) を作成
    const connector = new apprunner.CfnVpcConnector(this, 'VpcConnector', {
      subnets: vpc.selectSubnets({ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }).subnetIds,
      securityGroups: [ vpcConnectionSecurityGroup.securityGroupId ],
    });

    // App Runner サービスを作成
    const service = new apprunner.CfnService(this, 'Service', {
      sourceConfiguration: {
        authenticationConfiguration: {
          // ソースコード取得用の CodeStar Connection ARN を設定
          connectionArn: this.node.tryGetContext('connectionArn'),
        },
        codeRepository: {
          // ソースコードのリポジトリ URL やブランチを設定
          repositoryUrl: this.node.tryGetContext('repositoryUrl'),
          sourceCodeVersion: {
            type: "BRANCH",
            value: "main",
          },
          codeConfiguration: {
            configurationSource: "API",
            codeConfigurationValues: {
              // Java のマネージドランタイムを設定
              runtime: "CORRETTO_11",
              // アプリケーションのビルドコマンド
              buildCommand: "./gradlew bootJar && cp build/libs/*.jar ./",
              // アプリケーションの実行コマンド
              startCommand: "java -jar ./expt-apprunner-springboot.jar",
              // アプリケーションに設定する環境変数
              runtimeEnvironmentVariables: [
               {
                  name: "CACHE_HOST",
                  // InfraStack から渡された ElastiCache のホスト名
                  value: cacheConnection.host,
                },
                {
                  name: "CACHE_PORT",
                  // InfraStack から渡された ElastiCache のポート番号
                  value: cacheConnection.port,
                },
              ],
            }
          },
        },
      },
      networkConfiguration: {
        egressConfiguration: {
          egressType: "VPC",
          vpcConnectorArn: connector.attrVpcConnectorArn,
        },
      },
    });
    new cdk.CfnOutput(this, 'AppRunnerServiceURL', {
      value: service.attrServiceUrl,
    });
  }
}

#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { ServiceStack } from '../lib/service-stack';
import { InfraStack } from '../lib/infra-stack';

// 環境変数から リポジトリの URL と コネクションの ARN を取得
const repositoryUrl = process.env.REPOSITORY_URL
const connectionArn = process.env.CONNECTION_ARN

const app = new cdk.App({
  context: {
    repositoryUrl,
    connectionArn,
  }
});

const infra = new InfraStack(app, 'InfraStack');
new ServiceStack(app, 'ServiceStack', infra.vpc, infra.cacheConnection);

export REPOSITORY_URL=xxx
export CONNECTION_ARN=xxx

npx cdk deploy ServiceStack

...
Outputs:
ServiceStack.AppRunnerServiceURL = xxxxx.xxx.awsapprunner.com

> curl https://xxx-xxx.awsapprunner.com/healthy # Redis の値を書き換え
healthy

> curl https://xxx-xxx.awsapprunner.com/health # Redis の値を確認
healthy

> curl https://xxx-xxx.awsapprunner.com/unhealth# Redis の値を書き換え
unhealthy

> curl https://xxx-xxx.awsapprunner.com/health # Redis の値を確認
unhealthy