Skip to content

fitcloud/cfn-101

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits

cross-stack

cross-stack

 
 

ec2

ec2

 
 

media

media

 
 

nested-stack

nested-stack

 
 

.gitignore

.gitignore

 
 

README.md

README.md

 
 

Repository files navigation

Infrastructure as Code

코드형 인프라 또는 인프라 코드화는 이름 자체에서 설명하듯이 인프라를 코드를 통해서 구성 및 설정하는 방법론입니다. 인프라를 일종의 소프트웨어라고 생각하고 기계가 읽을 수 언어를 (프로그래밍 언어 또는 코드) 사용해서 개발하는 Pracitce 입니다.

Lab Overview

  1. CloudFormation의 기본적인 Syntax 소개, 스택 생성 및 업데이트 실습

  2. CFN 템플릿 재사용 방안 및 모듈화된 (Nested Stack) 스택 구성 실습

  3. AWS CodePipeline으로 배포 자동화 구축 실습

  4. AWS System Manager를 이용한 Parameter 암호화 구성 실습

CloudFormation 101

CloudFormation

CloudFormation Stack 생성

  1. AWS Management Console 좌측 상단에 있는 [Services] 를 선택하고 검색창에서 CloudFormation을 검색하거나 Management & Governance 밑에 있는 [CloudFormation] 를 선택

  2. CloudFormation을 Dashboard에서 [Create stack] 클릭후,
    Prepare template = Template is ready,
    Template source = Upload a template file,
    Choose file = ec2.yml,
    [Next] 클릭

  3. Stack name = cfn-ec2,
    EC2 Instance Name = test,
    Instance Type = t2.micro,
    AMI Id = ami-0d59ddf55cdda6e21,
    EC2 Key Pair Name = EC2 인스턴스에 부여할 키페어 지정,
    VPC = EC2 인스턴스를 생성할 VPC 지정,
    Subnet = EC2 인스턴스를 생성할 Subnet 지정,
    Elastic IP = Elastic IP 부여 여부 선택,
    [Next] 클릭

  4. [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources. → [Create Stack]

CloudFormation Stack Update

  1. 텍스트 에디터에서 ec2.yml 파일을 열고 Instance 블록을 아래와 같이 수정

    Instance:
  Type: AWS::EC2::Instance
  Properties:
    ImageId: !Ref AMIId
    InstanceType: !Ref EC2InstanceType
    DisableApiTermination: false
    InstanceInitiatedShutdownBehavior: stop
    Monitoring: false
    KeyName: !Ref KeyName
    SecurityGroupIds:
      - !Ref InstanceSecurityGroup
    SubnetId: !Ref Subnet
    Tags:
      -
        Key: Name
        Value: !Ref EC2Name
    UserData:
      Fn::Base64:
        !Sub |
            #!/bin/bash -xe
            sudo yum install -y httpd
            echo "<html>Hello-World!!</html>" > /tmp/index.html
            sudo cp /tmp/index.html /var/www/html/index.html
            sudo chmod 755 /var/www/html/index.html
            sudo service httpd start
            sudo chkconfig httpd on
  DependsOn:
    - InstanceSecurityGroup

  2. 아래 블록을 추가

    HTTPIngressRule:
  Type: AWS::EC2::SecurityGroupIngress
  Properties:
    GroupId: !Ref InstanceSecurityGroup
    IpProtocol: tcp
    FromPort: 80
    ToPort: 80
    CidrIp: 0.0.0.0/0
  DependsOn:
    - InstanceSecurityGroup

  3. CloudFormation Dashboard에서 위에서 생성한 스택을 선택 후 [Update] 클릭 →
    Prepare template = Replace current template,
    Template source = Upload a template file,
    Choose file = ec2.yml,
    [Next] 클릭

  4. 기존에 입력한 Parameters를 변경하지 말고 [Next] 클릭 → [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources. → [Update Stack]

  5. 새롭게 추가된 Userdata가 적용 되었는지 확인, 안되었다면 무엇이 문제인지 확인

  6. 위에서 생성한 CloudFormation 스택을 삭제하고 ec2-lt.yml을 이용해서 스택 생성

  7. Step 1 & 2에 명시된 보안그룹 인바운드 룰 및 Userdata script를 ec2-lt.yml에 적용 후 스택 업데이트 (ec2-lt-userdata.yml 파일을 참고)

  8. Userdata 내용이 적용 되었는지 확인, Step 5와의 차이점 비교

  9. CloudFormation 스택 삭제

CloudFormation Update Behaviors: 각 Resource의 속성 변경시 해당 Resource가 재시작 또는 재생성 될수 있고 이부분은 CloudFormation Developer Guide에 명시되어 있습니다. EC2를 예로 들자면 UserData의 경우에는 Some Interruption으로 기존에 생성된 인스턴스를 유지하되 재시작 또는 리부팅이 일어날수 있고, LaunchTemplate의 경우에는 Replacement로 인스턴스가 교체됩니다. 따라서 위의 예에서 Userdata에 스크립트를 추가했을때 반영이 되지 않았던 이유는 Userdata는 인스턴스 생성시에만 실행되기 때문입니다. CloudFormation을 통해서 Resources을 업데이트 할 경우 해당 속성의 Update rule을 꼭 참고하길 권장합니다.

Mapping

  1. CloudFormation을 Dashboard에서 [Create stack] 클릭후,
    Prepare template = Template is ready,
    Template source = Upload a template file,
    Choose file = ec2-mapping.yml,
    [Next] 클릭

  2. Stack name = cfn-ec2,
    EC2 Instance Name = test,
    Environment = test,
    AMI Id = ami-0d59ddf55cdda6e21,
    EC2 Key Pair Name = EC2 인스턴스에 부여할 키페어 지정,
    VPC = EC2 인스턴스를 생성할 VPC 지정,
    Subnet = EC2 인스턴스를 생성할 Subnet 지정,
    Elastic IP = Elastic IP 부여 여부 선택,
    [Next] 클릭

  3. [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources. → [Create Stack]

  4. 인스턴스 타입 확인

  5. CloudFormation Dashboard에서 위에서 생성한 스택을 선택 후 [Update] 클릭 →
    Prepare template = Use current template,
    [Next] 클릭

  6. Environment = prod 으로 변경 후 [Next] 클릭 → [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources. → [Update Stack]

  7. 인스턴스 타입 확인

스택 생성시 Parameters를 통해서 원하는 속성값들을 지정할수 있지만 만약에 이미 규정해놓은 설정값 또는 환경 변수에 맞춰서 따라야 하는 규약이 있다면 Mapping을 사용할수 있습니다. 가장 많이 활용되는 예를 들자면 리전에 따라서 AMI ID를 지정해 놓는 방법입니다. Amazon Linux 2 - 2019.09 이라는 버전이 있다고 한다면 각 리전별로 다른 AMI ID를 가지고 있습니다. 이 정보를 Mapping에 넣어두고, Pseudo Parameter인 AWS::Region를 이용하면 모든 리전에서 사용 가능한 템플릿 작성이 가능해집니다 (Disaster Recovery 대비용으로 사용 가능)

Cross-stack reference

Architecture Overview

  1. CloudFormation을 Dashboard에서 [Create stack] 클릭후,
    Prepare template = Template is ready,
    Template source = Upload a template file,
    Choose file = vpc-cross.yml,
    [Next] 클릭

  2. Stack name = vpc-cross, [Next] 클릭 → [Next] → [Create Stack]

  3. CloudFormation을 Dashboard에서 [Create stack] 클릭후,
    Prepare template = Template is ready,
    Template source = Upload a template file,
    Choose file = ec2-cross.yml,
    [Next] 클릭

  4. Stack name = ec2-cross,
    EC2 Instance Name = test,
    Instance Type = t2.micro,
    AMI Id = ami-0d59ddf55cdda6e21,
    EC2 Key Pair Name = EC2 인스턴스에 부여할 키페어 지정,
    Elastic IP = Elastic IP 부여 여부 선택,
    NetworkStackName = vpc-cross,
    [Next] 클릭

  5. [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources. → [Create Stack]

만약에 특정 스택이 다른 스택에 의해서 레퍼런스 되고 있으면 그 스택은 수정 및 삭제가 불가능합니다. Cross-stack reference를 사용하게 되는 경우 한개를 예로 들자면, Sysadmin을 제외한 모든 유저에게 보안그룹 생성 및 수정에 대한 권한을 없애고 cross-stack reference를 통해서만 이미 정해진 보안그룹을 사용하게 하여 보안 Compliance를 유지한다거나 보안사고를 예방할수 있습니다.

Nested Stack 으로 2-tier 아키텍쳐 배포

Architecture Overview

Architecture Overview

  1. AWS Management Console에서 좌측 상단에 있는 [Services] 를 선택하고 검색창에서 S3를 검색하거나 [Storage] 바로 밑에 있는 [S3] 를 선택

  2. S3 Dashboard에서 [Create bucket] 클릭후, Bucket name = aws-cfn-lab-[임의의 문자 및 숫자], Region = Asia Pacific (Seoul), [Create] 클릭

  3. 위에서 만든 S3 버킷에 nested-stack 폴더안에 있는 템플릿들을 복사

  4. CloudFormation을 Dashboard에서 [Create stack] 클릭후,
    Prepare template = Template is ready,
    Template source = Amazon S3 URL,
    Amazon S3 URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/sample-app.yml,
    [Next] 클릭

  5. Stack name = two-tier,
    Name of Project = cfn,
    Environment = test,
    NetworkTemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/vpc.yml,
    Dedicated NAT gateways = false,
    EC2TemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/ec2.yml,
    Instance Type = t2.micro,
    AMI Id = ami-0d59ddf55cdda6e21,
    EC2 Key Pair Name = EC2 인스턴스에 부여할 키페어 지정,
    Elastic IP = Elastic IP 부여 여부 선택,
    RDSTemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/rds.yml,
    RDS instance type = db.t2.micro,
    RDS instance storage size = 20,
    RDS instance engine = mysql,
    RDS instance engine version = 8.0.16,
    RDS database master password = 원하는 비밀번호 입력(8자 이상 대소문자만 구성),
    RDS Multi-AZ deployment = false,
    RDS deletion protection = false,
    RDS backup retention period = 1,
    LaunchTemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/lt.yml,
    Instance Type = t2.micro,
    AMI Id = ami-0d59ddf55cdda6e21,
    ASGTemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/asg.yml,
    ALBTemplateS3URL = https://<BUCKET_NAME>.s3.ap-northeast-2.amazonaws.com/alb.yml,
    SSL Certificate = SSL Certificate ARN 입력,
    [Next] 클릭

  6. [Next] → ✅ I acknowledge that AWS CloudFormation might create IAM resources with custom names,
    ✅ I acknowledge that AWS CloudFormation might require the following capability: CAPABILITY_AUTO_EXPAND → [Create Stack]

  7. [Outputs] 을 탭에서 ALBEndpoint을 찾고 해당 URL로 접속 가능한지 확인

배포 파이프라인 구축

  • CloudFormation 템플릿들을 Github에 호스팅
  • AWS CodePipeline을 이용해서 코드 변경시 배포 자동화 구성

  1. 해당 Git Repository를 Fork (GitHub 계정 필수)

  2. nested-stack/config.json 파일을 열고 위에 스택 만들때 넣었던 Parameters 값 수정하고 Commit

  3. AWS Management Console에서 좌측 상단에 있는 [Services] 를 선택하고 검색창에서 IAM를 검색하거나 [Security, Identity, & Compliance] 바로 밑에 있는 [IAM] 를 선택

  4. IAM Dashboard에서 [Roles] 클릭후, [Create role] 클릭

  5. Choose the service that will use this role에 CloudFormation를 선택 → [Next: Permissions] → ✅ AdministratorAccess → [Next: Tags] → [Next: Review]

  6. Role name = cfn-lab-codepipeline, [Create Role] 클릭

  7. AWS Management Console에서 좌측 상단에 있는 [Services] 를 선택하고 검색창에서 CodePipeline를 검색하거나 [Developer Tools] 밑에 있는 [CodePipeline] 를 선택

  8. [Create pipeline] → Pipeline name = iac, Service role = New service role → [Next] → Source provider = GitHub → [Connect to GitHub] → Repository = Step 1에서 Forking한 Repository, Branch = master → [Next] → Build provider = AWS CodeBuild → [Create project]

  9. Project name = iac, Environment image = Managed Image, Operating system = Amazon Linux 2, Runtime(s) = Standard, Image = aws/codebuild/amazonlinux2-x86_64-standard:2.0, Service role = New service role, Build specifications = Insert build commands → [Switch to editor] → 아래 커맨드블록을 Build commands에 붙여놓고 <BUCKET_NAME>을 위에서 생성한 이름으로 변경후 [Continue to CodePipeline]

    version: 0.2

phases:
  install:
    runtime-versions:
      python: 3.8
  build:
    commands:
      - for f in nested-stack/*.yml; do aws cloudformation validate-template --template-body file://$f; done
      - aws s3 sync nested-stack s3://<BUCKET_NAME>
artifacts:
  files:
    - nested-stack/sample-app.yml
    - nested-stack/config.json
  discard-paths: yes

  10. CodeBuild Project 구성시 생성된 Service Role에 AWSCloudFormationReadOnlyAccess Policy 및 템플릿들이 저장되어 있는 S3 bucket에 대한 권한 부여

  11. [Next] → Deploy provider = AWS CloudFormation, Action mode = Create or update a stack, Stack name = two-tier, Artifact name = BuildArtifact, File name = sample-app.yml, ✅ Use configuration file, Artifact name = BuildArtifact, File name = config.json, Capabilities = 모두 선택, Role name = cfn-lab-codepipeline → [Next] → [Create pipeline]

Blue / Green Deployment

  1. nested-stack/lt.yml 파일을 열고 UserData에 있는 index.html 내용에서 Version 1을 2로 변경 후 Commit

  2. ALB Endpoint로 접속해서 변경된 사항이 적용 됬는지 확인

  3. Launch Template & Auto Scaling Group에 변경된 사항 적용 됐는지 확인

  4. nested-stack/asg.yml 파일을 열고 AutoScalingGroup 블록을 아래와 같이 수정 후 Commit

    AutoScalingGroup:
 Type: AWS::AutoScaling::AutoScalingGroup
 Properties:
   LaunchTemplate:
     LaunchTemplateId: !Ref LaunchTemplate
     Version: !Ref LaunchTemplateVersion
   MinSize: 1
   MaxSize: 3
   TargetGroupARNs:
     - !Ref TargetGroupARN
   VPCZoneIdentifier: !Ref Subnets
 UpdatePolicy:
   AutoScalingReplacingUpdate:
     WillReplace: true

  5. nested-stack/lt.yml 파일을 열고 UserData에 있는 index.html 내용에서 Version 2를 Blue/Green Version으로 변경 후 Commit

Auto Scaling Group의 경우 UpdatePolicy가 명시되어 있지 않을 경우에는 Launch Template 또는 Launch Configuration에 대한 정보만 업데이트 되고 현지 실행되고 있는 인스턴스에는 적용되지 않습니다. UpdatePolicy를 사용해서 Rolling Update 또는 B/G 배포를 구현할수 있습니다. 더불어 CreationPolicy를 함꼐 사용해서 Application healthcheck를 같이 확인하는 방식을 권장합니다.

Integration with SSM Parameter Store

  1. AWS Management Console 좌측 상단에 있는 [Services] 를 선택하고 검색창에서 ssm를 검색하고 [Systems Manager] 를 선택

  2. Systems Manager Dashboard 왼쪽 패널 Application Management 섹션 아래에 있는 [Parameter Store] 선택

  3. [Create parameter] → Name = rds_password, Tier = Standard, Type = SecureString, Value = 원하는 비밀번호 입력 → [Create parameter]

  4. nested-stack/rds.yml 파일을 열고 RDS에 있는 MasterUserPassword 속성을 아래와 같이 변경 후 Commit

    MasterUserPassword: '{{resolve:ssm-secure:rds_password:1}}'

해당 CodePipeline에 부여된 CloudFormation Service Role에 가지고 오려는 SSM Secure String Parameter에 대한 엑세스 권한과 해당 Parameter를 암호화한 KMS Key에 대한 엑세스 권한이 부여되어야 합니다. 또한 Secrets Manager를 통해서도 RDS MasterUserPassword를 설정할수 있습니다.

Cleanup

  1. CodePipeline 삭제
  2. CodeBuild 삭제
  3. CloudFormation 스택 삭제
  4. Systems Manager Parameter Store 파라미터 삭제
  5. S3 Bucket 삭제

About

AWS CloudFormation Hands-on Lab

Topics

aws-codepipeline aws-cloudformation aws-systemsmanager

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

4 forks
Report repository

Releases

No releases published

Packages

No packages published