Data Lifecycle Manager入門 – EBSのスナップショット/AMIを定期的に作成する

2023-03-192024-04-21

Data Lifecycle Manager入門 - EBSのスナップショット/AMを定期的に作成する

Data Lifecycle Manager入門 – EBSのスナップショット/AMIを定期的に作成する

Data Lifecycle Manager(DLM)を使用すると、インスタンスやEBSのバックアップを自動化できます。

Amazon Data Lifecycle Manager を使用して、EBS スナップショットと EBS-backed AMI の作成、保持、削除を自動化できます。
Amazon Data Lifecycle Manager

本ページでは、DLMを使用して、インスタンスのAMIやEBSのスナップショットを定期的に作成します。

構築する環境

Diagram of Introduction to Data Lifecycle Manager - Create EBS Snapshot / AMI periodically.

検証用として、EC2インスタンスおよびEBSを作成します。

上記の2リソースに対して、3種類のDLMポリシーを作成します。

EC2インスタンスのAMIを定期的に作成するポリシー
EC2インスタンスのボリュームのスナップショットを定期的に作成するポリシー
EBSのスナップショットを定期的に作成するポリシー

共通して、1時間ごとにAMI・スナップショットを作成し、最新の2つが残るようにライフサイクルポリシーを設定します。

CloudFormationテンプレートファイル

上記の構成をCloudFormationで構築します。
以下のURLにCloudFormationテンプレートを配置しています。

https://github.com/awstut-an-r/awstut-soa/blob/main/02/003/soa-02-003.yaml

テンプレートファイルのポイント解説

DLM

AMI・EC2インスタンスボリュームのスナップショット・EBSのスナップショットを作成すために3つのDLMポリシーを作成します。

AMI用のポリシー

Resources:
  AmiLifecyclePolicy:
    Type: AWS::DLM::LifecyclePolicy
    Properties:
      Description: !Sub "${Prefix}-LifecyclePolicy-AMI"
      ExecutionRoleArn: !GetAtt AWSDataLifecycleManagerDefaultRoleForAMIManagement.Arn
      PolicyDetails:
        Parameters:
          NoReboot: false
        PolicyType: IMAGE_MANAGEMENT
        ResourceTypes:
          - INSTANCE
        Schedules:
          - CreateRule:
              Interval: 1
              IntervalUnit: HOURS
              Times:
                - "20:00"
            DeprecateRule: # AMI only.
              Count: 1
            Name: test-ami-policy
            RetainRule:
              Count: 2
        TargetTags:
          - Key: !Ref DLMTagKey1
            Value: !Ref DLMTagAmiValue
      State: ENABLED
Code language: YAML (yaml)

PolicyDetailsプロパティでDLMポリシーの具体的な設定を行います。

ParametersプロパティでDLMポリシーのオプション的なパラメータを設定できます。
AMI用のポリシーの場合、AMIの作成時に、インスタンスの再起動を実施するかどうかを設定できます。
本ポリシーでは「false」を指定して、再起動させません。

PolicyTypeプロパティで、ポリシーで作成するリソースを指定します。
AMIを作成する場合は、本プロパティに「IMAGE_MANAGEMENT」を指定します。

AMI用のDLMポリシーを作成する場合は、ResourceTypesプロパティに「INSTANCE」を指定します。

SchedulesプロパティでAMIを作成するタイミングや、古いAMIを削除する条件を設定します。

CreateRuleプロパティでAMIを作成するタイミングを設定します。
今回は以下の条件で動作するように設定します。

1時間ごとにAMIを作成する。
AMI作成は20時(UTC)から開始する。
AMIの数が2つになるように、古いAMIは削除する。
AMIを削除する際は、1つずつ削除する。

TargetTagsプロパティで、AMIを作成する対象のインスタンスを指定します。
今回は以下のタグが設定されたインスタンスを対象とします。

タグ名：dlm1
タグの値：ami

インスタンスボリュームのスナップショット用のポリシー

Resources:
  InstanceLifecyclePolicy:
    Type: AWS::DLM::LifecyclePolicy
    Properties:
      Description: !Sub "${Prefix}-LifecyclePolicy-Instance"
      ExecutionRoleArn: !GetAtt AWSDataLifecycleManagerDefaultRole.Arn
      PolicyDetails:
        Parameters:
          ExcludeBootVolume: false
        PolicyType: EBS_SNAPSHOT_MANAGEMENT
        ResourceTypes:
          - INSTANCE
        Schedules:
          - CreateRule:
              Interval: 1
              IntervalUnit: HOURS
              Times:
                - "12:40"
            Name: test-ami-policy
            RetainRule:
              Count: 2
        TargetTags:
          - Key: !Ref DLMTagKey2
            Value: !Ref DLMTagInstanceValue
      State: DISABLED
Code language: YAML (yaml)

概ねAMI用のポリシーと同様です。
主な異なる点を取り上げます。

インスタンスのボリュームのスナップショットを作成する場合は、PolicyTypeプロパティに「EBS_SNAPSHOT_MANAGEMENT」を指定します。

今回はTargetTagsプロパティを以下の通り指定します。

タグ名：dlm2
タグの値：instance

EBSのスナップショット用のポリシー

Resources:
  EBSLifecyclePolicy:
    Type: AWS::DLM::LifecyclePolicy
    Properties:
      Description: !Sub "${Prefix}-LifecyclePolicy-EBS"
      ExecutionRoleArn: !GetAtt AWSDataLifecycleManagerDefaultRole.Arn
      PolicyDetails:
        PolicyType: EBS_SNAPSHOT_MANAGEMENT
        ResourceTypes:
          - VOLUME
        Schedules:
          - CreateRule:
              Interval: 1
              IntervalUnit: HOURS
              Times:
                - "12:50"
            Name: test-ami-policy
            RetainRule:
              Count: 2
        TargetTags:
          - Key: !Ref DLMTagKey3
            Value: !Ref DLMTagEbsValue
      State: DISABLED
Code language: YAML (yaml)

概ね先述のポリシーと同様です。
主な異なる点を取り上げます。

インスタンスのボリュームのスナップショットを作成する場合は、ResourceTypesプロパティに「VOLUME」を指定します。

今回はTargetTagsプロパティを以下の通り指定します。

タグ名：dlm3
タグの値：ebs

DLM用IAMロール

AMI用ポリシー向けのIAMロール

Resources:
  AWSDataLifecycleManagerDefaultRoleForAMIManagement:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service:
                - dlm.amazonaws.com
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/service-role/AWSDataLifecycleManagerServiceRoleForAMIManagement
Code language: YAML (yaml)

AMI用のポリシーを実行するために必要な権限は、AWS管理ポリシーAWSDataLifecycleManagerServiceRoleForAMIManagementとして用意されています。

このAWS管理ポリシーをアタッチしたIAMロールを作成します。

インスタンスボリュームおよびEBS用ポリシー向けのIAMロール

Resources:
  AWSDataLifecycleManagerDefaultRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service:
                - dlm.amazonaws.com
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/service-role/AWSDataLifecycleManagerServiceRole
Code language: YAML (yaml)