[AWS] CloudFormation

CloudFormation은 인프라 구성요소를 미리 설정해서 시스템을 그때그때 빠르고 편리하게 구축할 수 있게 도와주는 서비스다.

예를 들어 정적페이지는 S3를 만들고, Cloudfront도 만들어서 설정해줘야 한다.

그리고 ECS로 서버를 구축할 경우에는 ECS 클러스터 만들고, 작업정의하고, 타겟그룹만들고, 로드밸런서 만들고, ECS 서비스 만들어서 띄우는 등의 많은 리소스 생성 및 설정작업이 필요하다.
이런 작업을 한번만 하는 것이라면 괜찮다. 하지만 여러개의 시스템을 만들 경우에는 이걸 2-3번 반복할 수도 있고, 그 이상을 할 수도 있다.

이걸 매번 하나하나 하려면 정말 번거롭기 그지없을 것이다. cloudformation은 이걸 모듈화해준다.

기능적으로는 오픈소스 Terraform과 비슷하다고 할 수 있다.

비용

당연히 공짜는 아니다.
엄청 비싸다고 할정도는 아닌데, 부과 방식이 조금 독특하다.

https://aws.amazon.com/ko/cloudformation/pricing/

템플릿 작성

CloudFormation에서 가장 중요한게 템플릿이다.
템플릿소스를 작성해서 어떤 리소스를 어떻게 만들고, 어떻게 설정할지를 전부 지정하기 때문이다.

나는 S3와 CloudFront만 만들어주는 비교적 간단한 형태의 템플릿을 작성하려 한다.

템플릿 사용법은 여기
https://docs.aws.amazon.com/ko_kr/AWSCloudFormation/latest/UserGuide/template-guide.html

샘플은 여기서 다운받을 수 있다.
참고해서 짜면 좋다. 딱 맞는게 있으면 그거 그냥 그대로 써도 된다.
https://docs.aws.amazon.com/ko_kr/AWSCloudFormation/latest/UserGuide/cfn-sample-templates.html

일단 템플릿의 기존적인 형태는 이렇다.
yaml도 있지만 나는 json이 더 편해서 이걸로 한다.

{
  "AWSTemplateFormatVersion": "version date",
  "Description": "JSON string",
  "Metadata": {},
  "Parameters": {},
  "Rules": {},
  "Mappings": {},
  "Conditions": {},
  "Transform": {},
  "Resources": {},
  "Outputs": {}
}

하나씩 짚어보겠다.

AWSTemplateFormatVersion, Description

일단 버전은 "2010-09-09"로 하면 된다.
설명도 알아볼 수만 있게 써주면 된다. 한글을 넣으면 오류는 나지 않지만 ????로 깨져서 나온다.

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "정적사이트 배포",

Metadata

메타데이터는 당장 필요하지도 않고, 그렇게 중요하지도 않아서 지나간다.

Parameters

파라미터는 말 그대로 파라미터를 받는 부분이다.

"Parameters": {
    "BucketName": {
      "Type": "String",
      "Description": "bucket name to generate",
      "AllowedPattern": "(?!-)[a-zA-Z0-9-.]{1,63}(?<!-)",
      "ConstraintDescription": "must be a valid S3 bucket name."
    }
  },

내 경우에는 버킷이름을 그때그때 받아서 그걸로 생성하게 하려고 한다.
해당 값에 대한 파라미터값이다.

Mappings

매핑은 말 그래도 매핑값들을 지정해주는 부분이다. 키-값의 형태로 이런저런 값들을 지정해놓고 Fn::FindInMap라는 함수로 꺼내올 수 있다.
꼭 필요한건 아니지만, 있으면 편리하다.
내 경우에는 그때그때 리전에 맞는 S3 도메인 링크를 가져오기 위해 사용할 것이다.

"Mappings": {
    "Region2S3WebsiteSuffix": {
      "af-south-1": { "Suffix": ".s3-website.af-south-1.amazonaws.com" },
      "ap-east-1": { "Suffix": ".s3-website.ap-east-1.amazonaws.com" },
      "ap-northeast-1": {
        "Suffix": ".s3-website-ap-northeast-1.amazonaws.com"
      },
      "ap-northeast-2": {
        "Suffix": ".s3-website.ap-northeast-2.amazonaws.com"
      },
      "ap-northeast-3": {
        "Suffix": ".s3-website.ap-northeast-3.amazonaws.com"
      },
      "ap-south-1": { "Suffix": ".s3-website.ap-south-1.amazonaws.com" },
      "ap-southeast-1": {
        "Suffix": ".s3-website-ap-southeast-1.amazonaws.com"
      },
      "ap-southeast-2": {
        "Suffix": ".s3-website-ap-southeast-2.amazonaws.com"
      },
      "ca-central-1": { "Suffix": ".s3-website.ca-central-1.amazonaws.com" },
      "cn-north-1": { "Suffix": ".s3-website.cn-north-1.amazonaws.com.cn" },
      "cn-northwest-1": {
        "Suffix": ".s3-website.cn-northwest-1.amazonaws.com.cn"
      },
      "eu-central-1": { "Suffix": ".s3-website.eu-central-1.amazonaws.com" },
      "eu-north-1": { "Suffix": ".s3-website.eu-north-1.amazonaws.com" },
      "eu-south-1": { "Suffix": ".s3-website.eu-south-1.amazonaws.com" },
      "eu-west-1": { "Suffix": ".s3-website-eu-west-1.amazonaws.com" },
      "eu-west-2": { "Suffix": ".s3-website.eu-west-2.amazonaws.com" },
      "eu-west-3": { "Suffix": ".s3-website.eu-west-3.amazonaws.com" },
      "me-south-1": { "Suffix": ".s3-website.me-south-1.amazonaws.com" },
      "sa-east-1": { "Suffix": ".s3-website-sa-east-1.amazonaws.com" },
      "us-east-1": { "Suffix": ".s3-website-us-east-1.amazonaws.com" },
      "us-east-2": { "Suffix": ".s3-website.us-east-2.amazonaws.com" },
      "us-west-1": { "Suffix": ".s3-website-us-west-1.amazonaws.com" },
      "us-west-2": { "Suffix": ".s3-website-us-west-2.amazonaws.com" }
    }
  },

Resources

그리고 리소스가 가장 중요한 부분이다.
각 AWS 리소스들을 어떤 설정값으로 생성할 것인지를 여기서 정의한다.

각 리소스에 대한건 다음 문서를 참조하면 좋다.
https://docs.aws.amazon.com/ko_kr/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

내 경우에는 먼저 S3를 만든다.

    "S3BucketForWebsiteContent": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "AccessControl": "PublicRead",
        "WebsiteConfiguration": {
          "IndexDocument": "index.html",
          "ErrorDocument": "error.html"
        },
        "BucketName": { "Ref": "BucketName" }
      }
    },

여기서 "Type": "AWS::S3::Bucket"은 버킷을 생성하는 명령이란 뜻이다.
{ "Ref": "BucketName" }는 변수 "BucketName"를 참조한다는 것인데, 위에서 파라미터로 받은 그 "BucketName"를 가리킨다.
그냥 버킷명 받은대로 만들어주는게 다다.

그다음에는 CloudFront 배포를 생성한다.

    "WebsiteCDN": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "Comment": "CDN for S3-backed website",
          "Enabled": "true",
          "DefaultCacheBehavior": {
            "ForwardedValues": { "QueryString": "true" },
            "TargetOriginId": "only-origin",
            "ViewerProtocolPolicy": "allow-all"
          },
          "DefaultRootObject": "index.html",
          "Origins": [
            {
              "CustomOriginConfig": {
                "HTTPPort": "80",
                "HTTPSPort": "443",
                "OriginProtocolPolicy": "http-only"
              },
              "DomainName": {
                "Fn::Join": [
                  "",
                  [
                    { "Ref": "S3BucketForWebsiteContent" },
                    {
                      "Fn::FindInMap": [
                        "Region2S3WebsiteSuffix",
                        { "Ref": "AWS::Region" },
                        "Suffix"
                      ]
                    }
                  ]
                ]
              },
              "Id": "only-origin"
            }
          ]
        }
      }
    }

조금 더 설정이 많긴 한데, DomainName 속성에 방금 만든 S3 버킷 경로를 넣어주는 것만 알아도 된다.
나머지는 거의 기본값이다.

Outputs

아웃풋은 말 그대로 출력이다.
배포된 Cloudfront의 ID를 알고싶다면 다음과 같이 할 수 있다.

  "Outputs": {
    "WebsiteID": {
      "Value": {
        "Ref": "WebsiteCDN" 
      },
      "Description": "The URL of the newly created website"
    }
  }

전체 템플릿 소스

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "정적사이트 배포",
  "Metadata": {},
  "Parameters": {
    "BucketName": {
      "Type": "String",
      "Description": "bucket name to generate",
      "AllowedPattern": "(?!-)[a-zA-Z0-9-.]{1,63}(?<!-)",
      "ConstraintDescription": "must be a valid S3 bucket name."
    }
  },
  "Rules": {},
  "Mappings": {
    "Region2S3WebsiteSuffix": {
      "af-south-1": { "Suffix": ".s3-website.af-south-1.amazonaws.com" },
      "ap-east-1": { "Suffix": ".s3-website.ap-east-1.amazonaws.com" },
      "ap-northeast-1": {
        "Suffix": ".s3-website-ap-northeast-1.amazonaws.com"
      },
      "ap-northeast-2": {
        "Suffix": ".s3-website.ap-northeast-2.amazonaws.com"
      },
      "ap-northeast-3": {
        "Suffix": ".s3-website.ap-northeast-3.amazonaws.com"
      },
      "ap-south-1": { "Suffix": ".s3-website.ap-south-1.amazonaws.com" },
      "ap-southeast-1": {
        "Suffix": ".s3-website-ap-southeast-1.amazonaws.com"
      },
      "ap-southeast-2": {
        "Suffix": ".s3-website-ap-southeast-2.amazonaws.com"
      },
      "ca-central-1": { "Suffix": ".s3-website.ca-central-1.amazonaws.com" },
      "cn-north-1": { "Suffix": ".s3-website.cn-north-1.amazonaws.com.cn" },
      "cn-northwest-1": {
        "Suffix": ".s3-website.cn-northwest-1.amazonaws.com.cn"
      },
      "eu-central-1": { "Suffix": ".s3-website.eu-central-1.amazonaws.com" },
      "eu-north-1": { "Suffix": ".s3-website.eu-north-1.amazonaws.com" },
      "eu-south-1": { "Suffix": ".s3-website.eu-south-1.amazonaws.com" },
      "eu-west-1": { "Suffix": ".s3-website-eu-west-1.amazonaws.com" },
      "eu-west-2": { "Suffix": ".s3-website.eu-west-2.amazonaws.com" },
      "eu-west-3": { "Suffix": ".s3-website.eu-west-3.amazonaws.com" },
      "me-south-1": { "Suffix": ".s3-website.me-south-1.amazonaws.com" },
      "sa-east-1": { "Suffix": ".s3-website-sa-east-1.amazonaws.com" },
      "us-east-1": { "Suffix": ".s3-website-us-east-1.amazonaws.com" },
      "us-east-2": { "Suffix": ".s3-website.us-east-2.amazonaws.com" },
      "us-west-1": { "Suffix": ".s3-website-us-west-1.amazonaws.com" },
      "us-west-2": { "Suffix": ".s3-website-us-west-2.amazonaws.com" }
    }
  },
  "Resources": {
    "S3BucketForWebsiteContent": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "AccessControl": "PublicRead",
        "WebsiteConfiguration": {
          "IndexDocument": "index.html",
          "ErrorDocument": "error.html"
        },
        "BucketName": { "Ref": "BucketName" }
      }
    },
    "WebsiteCDN": {
      "Type": "AWS::CloudFront::Distribution",
      "Properties": {
        "DistributionConfig": {
          "Comment": "CDN for S3-backed website",
          "Enabled": "true",
          "DefaultCacheBehavior": {
            "ForwardedValues": { "QueryString": "true" },
            "TargetOriginId": "only-origin",
            "ViewerProtocolPolicy": "allow-all"
          },
          "DefaultRootObject": "index.html",
          "Origins": [
            {
              "CustomOriginConfig": {
                "HTTPPort": "80",
                "HTTPSPort": "443",
                "OriginProtocolPolicy": "http-only"
              },
              "DomainName": {
                "Fn::Join": [
                  "",
                  [
                    { "Ref": "S3BucketForWebsiteContent" },
                    {
                      "Fn::FindInMap": [
                        "Region2S3WebsiteSuffix",
                        { "Ref": "AWS::Region" },
                        "Suffix"
                      ]
                    }
                  ]
                ]
              },
              "Id": "only-origin"
            }
          ]
        }
      }
    }
  },
  "Outputs": {
    "WebsiteID": {
      "Value": {
        "Ref": "WebsiteCDN" 
      },
      "Description": "The URL of the newly created website"
    }
  }
}

스택 생성

그럼 이제 스택을 만들어보자.
스택은 CloudFormation을 통해 생성되는 리소스의 묶음 단위다.
리소스들을 하나의 단위로 묶어서 한번에 만들거나 지울수 있게 해준다.

생성 페이지로 이동해, 방금 작성한 템플릿 소스를 업로드한다.

이름을 잘 짓고, 템플릿에서 요구하는 파라미터값을 넣어준다.

아까 파라미터로 지정한 버킷명이다.

다른건 슥슥 넘겨도 된다.

그렇게 해서 만들어졌다면

하나라도 실패하면 통째로 롤백이 되고

잘 된다면, 이렇게 하나씩 다 깔아줄 것이다.

버킷도 만들어졌고

CloudFront도 만들어졌다.

이대로 버킷에 리소스를 올려보면, 잘 될 것이다.

스택 삭제

Cloudformation의 장점 중 하나는, 삭제도 하나의 스택 단위로 처리할 수 있다는 것이다.

그래서 스택을 삭제하면 그 안에 포함된 리소스들도 역순으로 삭제가 된다.

참조
https://docs.aws.amazon.com/ko_kr/AWSCloudFormation/latest/UserGuide/Welcome.html