ElastiCache構築自動化テンプレート

【連載】

AWSで実践! 基盤構築・デプロイ自動化

【第31回】ElastiCache構築自動化テンプレート

[2020/04/08 08:00]川畑 光平 ブックマーク ブックマーク

本連載では、以下のイメージの構成にあるAWSリソース基盤自動化環境の構築を実践しています。

本連載で構築していく基盤自動化環境のイメージ

前回は、DynamoDBを構築するテンプレートを実装しました。続く今回は、ElastiCacheを構築するテンプレートを作成します。

なお、実際のソースコードはGitHub上にコミットしています。以降のソースコードでは本質的でない記述を一部省略しているので、実行コードを作成する場合は、必要に応じて適宜GitHub上のソースコードも参照してください。

ElastiCacheスタック構築テンプレート

ElastiCacheは、連載「AWSで作るクラウドネイティブアプリケーションの基本」の第22回で実施した要領と同等のものを構築します。

ElastiCache(Redis)をCloudFormationで構築する場合、リソースタイプが「AWS::ElastiCache::ReplicationGroup」であるElastiCache定義※1、および「AWS::ElastiCache::SubnetGroup」となるサブネットグループ定義、「AWS::ElastiCache::ParameterGroup」となるパラメータグループ定義が必要です。

プロパティとして設定可能な属性は、各リンク先の通りですが、ElastiCacheを商用環境/ステージング環境/開発環境※2の3つのパターンに分けて作成するようにします。 テンプレートのサンプルは以下の通りです。

AWSTemplateFormatVersion: '2010-09-09'

// omit

Parameters:
  // omit
  EnvType:                                                                                                #(A)
    Description: Which environments to deploy your service.
    Type: String
    AllowedValues: ["Dev", "Staging", "Production"]
    Default: Dev
  SecurityGroupDev:                                                                                       #(B)
    Description: The local machine permitted SecurityGroup is needed as paramater for Dev.
    Type: String
    Default: ""
Conditions:                                                                                               #(C)
  DevResources: {"Fn::Equals" : [{"Ref":"EnvType"}, "Dev"]}

Mappings:
  CacheDefinitionMap:                                                                                     #(D)
    Production:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "yes"
      "AutomaticFailoverEnabled": true
      "ReplicasPerNodeGroup": 2
    Staging:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "no"
      "AutomaticFailoverEnabled": false
      "ReplicasPerNodeGroup": 1
    Dev:
      "CacheInstanceType": "cache.t2.micro"
      "CacheParameterGroupFamily": "redis5.0"
      "EngineVersion": "5.0.3"
      "Port": 6379
      "ClusterEnabled" : "no"
      "AutomaticFailoverEnabled": false
      "ReplicasPerNodeGroup": 1

Resources:
  ElastiCacheSubnetGroup:                                                                                 #(E)
    Type: AWS::ElastiCache::SubnetGroup
    Properties:
      CacheSubnetGroupName: !Sub ElastiCacheSubnetGroup-${EnvType}
      Description: SampleCloudFormation ElastiCacheSubnetGroup
      SubnetIds:
        - Fn::ImportValue: !Sub ${VPCName}-PublicSubnet1
        - Fn::ImportValue: !Sub ${VPCName}-PublicSubnet2

  ElastiCacheParameterGroup:                                                                              #(F)
    Type: AWS::ElastiCache::ParameterGroup
    Properties:
      CacheParameterGroupFamily: !FindInMap [CacheDefinitionMap, !Ref EnvType, CacheParameterGroupFamily] #(G)
      Description: SampleCloudFormation ElastiCacheParameterGroup
      Properties:
        cluster-enabled: !FindInMap [CacheDefinitionMap, !Ref EnvType, ClusterEnabled]

  ElastiCacheRedis:                                                                                       #(H)
    Type: AWS::ElastiCache::ReplicationGroup
    Properties:
      ReplicationGroupId: !Sub elasticache-${EnvType}
      Engine: redis
      ReplicationGroupDescription: SampleCloudFormation RedisCluster
      EngineVersion: !FindInMap [CacheDefinitionMap, !Ref EnvType, EngineVersion]
      Port: !FindInMap [CacheDefinitionMap, !Ref EnvType, Port]
      CacheParameterGroupName: !Ref ElastiCacheParameterGroup
      CacheNodeType: !FindInMap [CacheDefinitionMap, !Ref EnvType, CacheInstanceType]
      ReplicasPerNodeGroup: !FindInMap [CacheDefinitionMap, !Ref EnvType, ReplicasPerNodeGroup]
      AutomaticFailoverEnabled: !FindInMap [CacheDefinitionMap, !Ref EnvType, AutomaticFailoverEnabled]
      CacheSubnetGroupName: !Ref ElastiCacheSubnetGroup
      SecurityGroupIds:
        - Fn::ImportValue: !Sub ${VPCName}-SecurityGroupElastiCacheRedis
        - !If ["DevResources", !Ref SecurityGroupDev, !Ref "AWS::NoValue"]                                 #(I)

Outputs:
 // omit
  ElastiCacheRedisEndPoint:                                                                                #(J)
    Description: ElastiCache Redis EndPoint
    Value: !GetAtt ElastiCacheRedis.PrimaryEndPoint.Address
    Export:
      Name: !Sub ${VPCName}-ElastiCacheRedisEndPoint

  ElastiCacheRedisPort:                                                                                    #(K)
    Description: ElastiCache Redis Port
    Value:  !FindInMap [CacheDefinitionMap, !Ref EnvType, Port]
    Export:
      Name: !Sub ${VPCName}-ElastiCacheRedisPort-${EnvType}

ElastiCacheのテンプレートの記述の基本となるポイントは下表の通りです。

記述 説明
A ElastiCacheを商用環境、ステージング環境、開発環境用に分けるよう、EnvTypeパラメータとして指定可能にします。このパラメータに応じて、Mappingsに定義したパラメータを切り替え、リソース定義を分けて作成できるようにします
B 開発環境としてのElastiCacheにアクセス可能な端末をターゲットとしたセキュリティグループをパラメータとして受け取ります。ElastiCacheに設定するセキュリティグループは、本連載の第27回と同様、事前にセキュリティグループを定義し、IDをパラメータとして渡す前提で実装しておきますが、開発環境ではVPC内にある開発端末からのアクセスを許可するためにセキュリティグループをIで追加します
C Conditionsとして、EnvTypeがDevだった場合に、有効になる論理名を定義します。定義方法の詳細はRDSスタック構築テンプレートと同様なので適宜参照してください
D Mappingsとして、EnvTypeパラメータの値に応じて、3つの論理名を定義します。Mappings定義方法の詳細は アプリケーションロードバランサー(ALB)スタック構築テンプレート と同様なので適宜参照してください
E ElastiCacheを配置するサブネットグループのリソース定義を行います。定義するプロパティの詳細はAWS::ElastiCache::SubnetGroupを参照してください
F ElastiCacheにおけるパラメータグループのリソース定義を行います。定義するプロパティの詳細はAWS::ElastiCache::ParameterGroupを参照してください
G 環境によって異なる値を定義したい箇所は、EnvTypeパラメータを引数としたFindInMap関数でデータ取得します
H ElastiCacheのリソース定義を行います。定義するプロパティの詳細はAWS::ElastiCache::ReplicationGroup を参照してください
I 開発環境の場合のみ、パラメータとして指定したセキュリティグループが追加されるように定義します
J ElastiCacheのプライマリエンドポイントをOutputs出力します
K ElastiCacheのポートをOutputs出力します

作成したテンプレートに対して、以下のようにスタック名とテンプレートパスを変更して、ヘルパースクリプトを実行します。今回はステージング環境を想定してパラメータを指定して実行します。

#!/usr/bin/env bash

stack_name="mynavi-sample-elasticache"
template_path="sample-elasticache-cfn.yml"

parameters="EnvType=Staging"

aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --parameter-overrides ${parameters} --capabilities CAPABILITY_IAM

実行が正常に終了すると、ElastiCacheが作成されます。

ElastiCacheが作成される

以上、今回はElastiCacheを構築するCloudFormationテンプレートを実装しました。次回は、AmazonS3やAmazonSQSを構築するテンプレートを作成します。

※1 ElastiCacheには「AWS::ElastiCache::CacheCluster」というリソースタイプもありますが、Redisを使用する場合はノード数を2つ以上にするとエラーとなります。エンジンがRedisの場合は、AWS::ElastiCache::ReplicationGroupを使用しましょう。

※2 連載「AWSで作るクラウドネイティブアプリケーションの基本」の第19回では、開発環境はローカル環境にRedisServerを立てるかたちで解説しました。ElastiCacheはRDSやDynamoDBとは異なり、2020年2月時点でもパブリックアクセスが許可されていません(パブリックサブネットに配置してVPC外からエンドポイントを指定してもアクセスできません)。そのため、VPCの外にあるローカル開発環境でRedisへのアクセスを行いたい場合はローカルにRedisServerを立てる必要があります。開発環境でElastiCacheを使用したい場合はAmazon WorkspacesなどでVPC内に仮想マシン環境を用意する方法が簡易です。今回はVPC内に開発環境があることを想定して、開発環境用のElastiCacheをCloudFormationテンプレートで構築してみます。

著者紹介


川畑 光平(KAWABATA Kohei) - NTTデータ 課長代理

金融機関システム業務アプリケーション開発・システム基盤担当を経て、現在はソフトウェア開発自動化関連の研究開発・推進に従事。

Red Hat Certified Engineer、Pivotal Certified Spring Professional、AWS Certified Solutions Architect Professional等の資格を持ち、アプリケーション基盤・クラウドなどさまざまな開発プロジェクト支援にも携わる。2019 APN AWS Top Engineers & Ambassadors選出。

本連載の内容に対するご意見・ご質問は Facebook まで。

※ 本記事は掲載時点の情報であり、最新のものとは異なる場合がございます。予めご了承ください。

一覧はこちら

連載目次

関連リンク

この記事に興味を持ったら"いいね!"を Click
Facebook で IT Search+ の人気記事をお届けします
注目の特集/連載
[解説動画] Googleアナリティクス分析&活用講座 - Webサイト改善の正しい考え方
[解説動画] 個人の業務効率化術 - 短時間集中はこうして作る
ミッションステートメント
教えてカナコさん! これならわかるAI入門
知りたい! カナコさん 皆で話そうAIのコト
対話システムをつくろう! Python超入門
Kubernetes入門
AWSで作るクラウドネイティブアプリケーションの基本
PowerShell Core入門
徹底研究! ハイブリッドクラウド
マイナビニュース スペシャルセミナー 講演レポート/当日講演資料 まとめ
セキュリティアワード特設ページ

一覧はこちら

今注目のIT用語の意味を事典でチェック!

一覧はこちら

会員登録(無料)

ページの先頭に戻る