“Amazon ECS에 배포” 작업 YAML 정의

다음은 Amazon ECS에 배포 작업에 대한 YAML 정의입니다. 이 작업을 사용하는 방법을 알아보려면 을 참조하십시오. 워크플로를 사용하여 Amazon Elastic 컨테이너 서비스 (ECS) 에 애플리케이션 배포

이 작업 정의는 광범위한 워크플로 정의 파일 내에 섹션으로 존재합니다. 이 파일에 대한 자세한 내용은 워크플로우 YAML 정의을 참조합니다.

참고

다음에 나오는 대부분의 YAML 속성에는 비주얼 에디터에 해당하는 UI 요소가 있습니다. UI 요소를 검색하려면 Ctrl+F를 사용합니다. 요소는 관련 YAML 속성과 함께 나열됩니다.


# The workflow definition starts here.
# See 최상위 속성 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  ECSDeployAction_nn: 
    Identifier: aws/ecs-deploy@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - task-definition-artifact
    Configuration: 
      region: us-east-1 
      cluster: ecs-cluster
      service: ecs-service
      task-definition: task-definition-path
      force-new-deployment: false|true
      codedeploy-appspec: app-spec-file-path
      codedeploy-application: application-name
      codedeploy-deployment-group: deployment-group-name
      codedeploy-deployment-description: deployment-description

ECSDeployAction

(필수)

액션의 이름을 지정합니다. 모든 작업 이름은 워크플로 내에서 고유해야 합니다. 액션 이름은 영숫자 (a-z, A-Z, 0-9), 하이픈 (-), 밑줄 (_) 로 제한됩니다. 공백은 허용되지 않습니다. 액션 이름에 특수 문자와 공백을 사용할 때는 따옴표를 사용할 수 없습니다.

기본값: ECSDeployAction_nn.

해당 UI: 구성 탭/ 작업 표시 이름

Identifier

(ECSDeployAction/Identifier)

(필수)

작업을 식별합니다. 버전을 변경하려는 경우가 아니면 이 속성을 변경하지 마십시오. 자세한 정보는 액션의 메이저, 마이너 또는 패치 버전 지정을 참조하세요.

기본값: aws/ecs-deploy@v1.

해당 UI: 워크플로 다이어그램/ECS _n/ aws/ecs-deploy @v1 레이블 DeployAction

DependsOn

(ECSDeployAction/DependsOn)

(선택 사항)

이 작업을 실행하기 위해 성공적으로 실행되어야 하는 작업, 작업 그룹 또는 게이트를 지정하십시오.

'종속 조건' 기능에 대한 자세한 내용은 을 참조하십시오. 다른 액션에 종속되도록 액션을 구성하기

해당 UI: 입력 탭/ 종속 - 선택사항

Compute

(ECSDeployAction/Compute)

(선택 사항)

워크플로 작업을 실행하는 데 사용되는 컴퓨팅 엔진. 워크플로 수준 또는 작업 수준에서 컴퓨팅을 지정할 수 있지만 둘 다에서 지정할 수는 없습니다. 워크플로 수준에서 지정된 경우 컴퓨팅 구성은 워크플로에 정의된 모든 작업에 적용됩니다. 워크플로 수준에서는 동일한 인스턴스에서 여러 작업을 실행할 수도 있습니다. 자세한 정보는 작업 간 컴퓨팅 공유을 참조하세요.

해당 UI: 없음

Type

(ECSDeployAction/Compute/Type)

(포함된 Compute 경우 필수)

컴퓨팅 엔진 유형. 다음 값 중 하나를 사용할 수 있습니다.

EC2 (비주얼 에디터) 또는 EC2 (YAML 에디터)

작업 실행 시 유연성을 위해 최적화되었습니다.
Lambda (비주얼 에디터) Lambda 또는 (YAML 에디터)

작업 시작 속도를 최적화했습니다.

컴퓨팅 유형에 대한 자세한 정보는 컴퓨팅 유형을 참고하세요.

해당 UI: 구성 탭/고급 - 선택 사항/ 컴퓨팅 유형

Fleet

(ECSDeployAction/Compute/Fleet)

(선택 사항)

워크플로 또는 워크플로 작업을 실행할 시스템 또는 플릿을 지정합니다. 온디맨드 플릿을 사용하면 작업이 시작되면 워크플로에서 필요한 리소스를 프로비저닝하고 작업이 완료되면 시스템이 폐기됩니다. 온디맨드 플릿의 예:,. Linux.x86-64.Large Linux.x86-64.XLarge 온디맨드 플릿에 대한 자세한 내용은 을 참조하십시오. 온디맨드 플릿 속성

프로비전된 플릿을 사용하면 워크플로 작업을 실행할 전용 컴퓨터 세트를 구성합니다. 이러한 시스템은 유휴 상태로 유지되므로 작업을 즉시 처리할 수 있습니다. 프로비전된 플릿에 대한 자세한 내용은 을 참조하십시오. 프로비저닝된 플릿 속성

생략된 경우 기본값은 Fleet 입니다. Linux.x86-64.Large

해당 UI: 구성 탭/고급 - 선택 사항/ 컴퓨팅 플릿

Timeout

(ECSDeployAction/Timeout)

(선택 사항)

작업이 종료되기 전에 작업을 실행할 수 있는 시간을 분 (YAML 편집기) 또는 시간과 분 (비주얼 편집기) 단위로 지정합니다. CodeCatalyst 최소값은 5분이고 최대값은 에 설명되어 있습니다. 워크플로우 할당량 기본 타임아웃은 최대 타임아웃과 동일합니다.

해당 UI: 구성 탭/ 타임아웃 - 선택 사항

Environment

(ECSDeployAction/Environment)

(필수)

작업에 사용할 CodeCatalyst 환경을 지정합니다. 작업은 선택한 환경에 지정된 AWS 계정 및 선택적 Amazon VPC에 연결됩니다. 작업은 환경에 지정된 기본 IAM 역할을 사용하여 에 연결하고 AWS 계정, Amazon VPC 연결에 지정된 IAM 역할을 사용하여 Amazon VPC에 연결합니다.

참고

기본 IAM 역할에 작업에 필요한 권한이 없는 경우 다른 역할을 사용하도록 작업을 구성할 수 있습니다. 자세한 정보는 작업에 다른 IAM 역할 할당을 참조하세요.

환경에 대한 자세한 내용은 환경을 AWS 계정 포함한 VPC에 배포 CodeCatalyst 및 을 참조하십시오. 환경 생성

해당 UI: 구성 탭/ 환경

Name

(ECSDeployAction/Environment/Name)

(포함된 Environment 경우 필수)

작업에 연결할 기존 환경의 이름을 지정합니다.

해당 UI: 구성 탭/ 환경

Connections

(ECSDeployAction/Environment/Connections)

(액션의 최신 버전에서는 선택 사항, 이전 버전에서는 필수)

액션과 연결할 계정 연결을 지정합니다. 에서 최대 1개의 계정 연결을 지정할 수 Environment 있습니다.

계정 연결을 지정하지 않은 경우:

작업에는 CodeCatalyst 콘솔 환경에 지정된 AWS 계정 연결 및 기본 IAM 역할이 사용됩니다. 환경에 계정 연결 및 기본 IAM 역할을 추가하는 방법에 대한 자세한 내용은 을 참조하십시오. 환경 생성
기본 IAM 역할에는 작업에 필요한 정책 및 권한이 포함되어야 합니다. 이러한 정책 및 권한이 무엇인지 확인하려면 작업의 YAML 정의 설명서에서 역할 속성에 대한 설명을 참조하십시오.

계정 연결에 대한 자세한 내용은 을 참조하십시오연결된 AWS 리소스에 대한 액세스 허용 AWS 계정. 환경에 계정 연결을 추가하는 방법에 대한 자세한 내용은 을 참조하십시오환경 생성.

해당 UI: 액션 버전에 따라 다음 중 하나

(최신 버전) 구성 탭/환경/내 환경에는 무엇이 있습니까? /점 3개 메뉴/ 역할 전환
(이전 버전) 구성 탭/'환경/계정/역할'/ 계정 연결AWS

Name

(ECSDeployAction/Environment/Connections/Name)

(포함된 경우 필수Connections)

계정 연결 이름을 지정합니다.

해당 UI: 액션 버전에 따라 다음 중 하나

(최신 버전) 구성 탭/환경/내 환경에는 무엇이 있습니까? /점 3개 메뉴/ 역할 전환
(이전 버전) 구성 탭/'환경/계정/역할'/ 계정 연결AWS

Role

(ECSDeployAction/Environment/Connections/Role)

(포함된 경우 필수Connections)

Amazon ECS에 배포 작업에서 액세스하는 데 사용하는 IAM 역할의 이름을 지정합니다. AWS CodeCatalyst 스페이스에 역할을 추가했는지, 역할에 다음 정책이 포함되어 있는지 확인하십시오.

IAM 역할을 지정하지 않으면 콘솔 환경에 나열된 기본 IAM 역할이 작업에 사용됩니다. CodeCatalyst 환경에서 기본 역할을 사용하는 경우 해당 역할에 다음 정책이 적용되는지 확인하십시오.

다음 권한 정책:

주의

권한을 다음 정책에 표시된 권한으로 제한하십시오. 더 광범위한 권한이 있는 역할을 사용하면 보안 위험이 발생할 수 있습니다.


{
    "Version": "2012-10-17",
    "Statement": [{
    "Action":[
      "ecs:DescribeServices",
      "ecs:CreateTaskSet",
      "ecs:DeleteTaskSet",
      "ecs:ListClusters",
      "ecs:RegisterTaskDefinition",
      "ecs:UpdateServicePrimaryTaskSet",
      "ecs:UpdateService",
      "elasticloadbalancing:DescribeTargetGroups",
      "elasticloadbalancing:DescribeListeners",
      "elasticloadbalancing:ModifyListener",
      "elasticloadbalancing:DescribeRules",
      "elasticloadbalancing:ModifyRule",
      "lambda:InvokeFunction",
      "lambda:ListFunctions",
      "cloudwatch:DescribeAlarms",
      "sns:Publish",
      "sns:ListTopics", 
      "s3:GetObject",
      "s3:GetObjectVersion",
      "codedeploy:CreateApplication", 
      "codedeploy:CreateDeployment", 
      "codedeploy:CreateDeploymentGroup", 
      "codedeploy:GetApplication", 
      "codedeploy:GetDeployment", 
      "codedeploy:GetDeploymentGroup", 
      "codedeploy:ListApplications", 
      "codedeploy:ListDeploymentGroups", 
      "codedeploy:ListDeployments", 
      "codedeploy:StopDeployment", 
      "codedeploy:GetDeploymentTarget", 
      "codedeploy:ListDeploymentTargets", 
      "codedeploy:GetDeploymentConfig", 
      "codedeploy:GetApplicationRevision", 
      "codedeploy:RegisterApplicationRevision", 
      "codedeploy:BatchGetApplicationRevisions", 
      "codedeploy:BatchGetDeploymentGroups", 
      "codedeploy:BatchGetDeployments", 
      "codedeploy:BatchGetApplications", 
      "codedeploy:ListApplicationRevisions", 
      "codedeploy:ListDeploymentConfigs", 
      "codedeploy:ContinueDeployment"           
   ],
   "Resource":"*",
   "Effect":"Allow"
},{"Action":[
      "iam:PassRole"
   ],
   "Effect":"Allow",
   "Resource":"*",
   "Condition":{"StringLike":{"iam:PassedToService":[
            "ecs-tasks.amazonaws.com",
            "codedeploy.amazonaws.com"
         ]
      }
   }
}]
}

참고

역할을 처음 사용할 때는 리소스 정책 설명에 다음 와일드카드를 사용하고 사용 가능한 상태가 되면 리소스 이름을 지정하여 정책의 범위를 좁히십시오.


"Resource": "*"

다음과 같은 사용자 지정 신뢰 정책:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

참고

원하는 경우 이 작업에 CodeCatalystWorkflowDevelopmentRole-spaceName 역할을 사용할 수 있습니다. 이에 대한 자세한 내용은 계정 및 스페이스에 대한 CodeCatalystWorkflowDevelopmentRole-spaceName역할 만들기 섹션을 참조하세요. CodeCatalystWorkflowDevelopmentRole-spaceName역할에는 보안 위험을 초래할 수 있는 전체 액세스 권한이 있다는 점을 이해하세요. 보안이 덜 우려되는 자습서 및 시나리오에서만 이 역할을 사용하는 것이 좋습니다.

해당 UI: 액션 버전에 따라 다음 중 하나가 표시됩니다.

(최신 버전) 구성 탭/환경/내 환경에는 무엇이 있습니까? /점 3개 메뉴/ 역할 전환
(이전 버전) 구성 탭/'환경/계정/역할'/ 역할

Inputs

(ECSDeployAction/Inputs)

(선택 사항)

이 Inputs 섹션에서는 워크플로우 실행 중에 필요한 데이터를 정의합니다. ECSDeployAction

참고

Amazon ECS에 배포 작업당 하나의 입력 (소스 또는 아티팩트) 만 허용됩니다.

해당 UI: 입력 탭

Sources

(ECSDeployAction/Inputs/Sources)

(작업 정의 파일이 소스 리포지토리에 저장되어 있는 경우 필수)

작업 정의 파일이 소스 리포지토리에 저장되어 있는 경우 해당 소스 리포지토리의 레이블을 지정하세요. 현재 지원되는 레이블은 뿐입니다WorkflowSource.

작업 정의 파일이 소스 리포지토리에 포함되어 있지 않은 경우 이 파일은 다른 작업에서 생성된 아티팩트에 있어야 합니다.

소스에 대한 자세한 내용은 워크플로를 소스 리포지토리에 연결 단원을 참조하십시오.

해당 UI: 입력 탭/ 소스 - 선택 사항

Artifacts - input

(ECSDeployAction/Inputs/Artifacts)

(작업 정의 파일이 이전 작업의 출력 아티팩트에 저장되어 있는 경우 필수)

배포하려는 작업 정의 파일이 이전 작업에서 생성된 아티팩트에 포함되어 있는 경우 여기에 해당 아티팩트를 지정하세요. 작업 정의 파일이 아티팩트에 포함되어 있지 않은 경우 해당 파일은 소스 리포지토리에 있어야 합니다.

예제를 포함한 아티팩트에 대한 자세한 내용은 을 참조하십시오. 아티팩트를 사용하여 워크플로의 작업 간 데이터 공유

해당 UI: 구성 탭/ 아티팩트 - 선택 사항

Configuration

(ECSDeployAction/Configuration)

(필수)

작업의 구성 속성을 정의할 수 있는 섹션입니다.

해당 UI: 구성 탭

region

(Configuration/region)

(필수)

Amazon ECS 클러스터 및 서비스가 위치한 AWS 지역을 지정합니다. 지역 코드 목록은 의 지역 엔드포인트를 참조하십시오. AWS 일반 참조

해당 UI: 구성 탭/ 지역

cluster

(ECSDeployAction/Configuration/cluster)

(필수)

기존 Amazon ECS 클러스터의 이름을 지정합니다. Amazon ECS로 배포 작업은 컨테이너식 애플리케이션을 태스크로 이 클러스터에 배포합니다. Amazon ECS 클러스터에 대한 자세한 내용은 Amazon Elastic 컨테이너 서비스 개발자 안내서의 클러스터를 참조하십시오.

해당 UI: 구성 탭/ 클러스터

service

(ECSDeployAction/Configuration/service)

(필수)

작업 정의 파일을 인스턴스화할 기존 Amazon ECS 서비스의 이름을 지정합니다. 이 서비스는 필드에 지정된 클러스터 아래에 있어야 합니다. cluster Amazon ECS 서비스에 대한 자세한 내용은 Amazon Elastic 컨테이너 서비스 개발자 안내서의 Amazon ECS 서비스를 참조하십시오.

해당 UI: 구성 탭/ 서비스

task-definition

(ECSDeployAction/Configuration/task-definition)

(필수)

기존 작업 정의 파일의 경로를 지정합니다. 파일이 소스 리포지토리에 있는 경우 경로는 소스 리포지토리 루트 폴더를 기준으로 합니다. 파일이 이전 워크플로 작업의 아티팩트에 있는 경우 경로는 아티팩트 루트 폴더를 기준으로 합니다. 작업 정의 파일에 대한 자세한 내용은 Amazon Elastic Container Service 개발자 안내서의 작업 정의를 참조하십시오.

해당 UI: 구성 탭/ 작업 정의

force-new-deployment

(ECSDeployAction/Configuration/force-new-deployment)

(필수)

활성화된 경우 Amazon ECS 서비스는 서비스 정의를 변경하지 않고도 새 배포를 시작할 수 있습니다. 강제로 배포하면 서비스가 현재 실행 중인 모든 작업을 중지하고 새 작업을 시작합니다. 새 배포를 강제하는 방법에 대한 자세한 내용은 Amazon Elastic Container Service 개발자 안내서의 서비스 업데이트를 참조하십시오.

기본값: false

해당 UI: 구성 탭/ 서비스를 강제로 새로 배포합니다.

codedeploy-appspec

(ECSDeployAction/Configuration/codedeploy-appspec)

(블루/그린 배포를 사용하도록 Amazon ECS 서비스를 구성한 경우 필수, 그렇지 않으면 생략)

기존 CodeDeploy 애플리케이션 사양 () 파일의 이름과 경로를 지정합니다. AppSpec 이 파일은 CodeCatalyst 소스 저장소의 루트에 있어야 합니다. AppSpec 파일에 대한 자세한 내용은 AWS CodeDeploy 사용 설명서의 CodeDeploy 응용 프로그램 사양 (AppSpec) 파일을 참조하십시오.

참고

CodeDeploy 블루/그린 배포를 수행하도록 Amazon ECS 서비스를 구성한 경우에만 정보를 제공하십시오. 롤링 업데이트 배포 (기본값) 의 경우 정보를 생략하십시오. CodeDeploy Amazon ECS 배포에 대한 자세한 내용은 Amazon Elastic 컨테이너 서비스 개발자 안내서의 Amazon ECS 배포 유형을 참조하십시오.

참고

비주얼 에디터에서는 CodeDeploy필드가 숨겨질 수 있습니다. 표시되도록 하려면 을 참조하십시오비주얼 에디터에서 CodeDeploy 필드가 누락된 이유는 무엇입니까?.

해당 UI: 구성 탭/ CodeDeploy AppSpec

codedeploy-application

(ECSDeployAction/Configuration/codedeploy-application)

(포함된 codedeploy-appspec 경우 필수)

기존 CodeDeploy 애플리케이션의 이름을 지정합니다. CodeDeploy 응용 프로그램에 대한 자세한 내용은 사용 설명서의 응용 프로그램AWS CodeDeploy 사용을 참조하십시오. CodeDeploy

해당 UI: 구성 탭/ 애플리케이션 CodeDeploy

codedeploy-deployment-group

(ECSDeployAction/Configuration/codedeploy-deployment-group)

(포함된 codedeploy-appspec 경우 필수)

기존 CodeDeploy 배포 그룹의 이름을 지정합니다. CodeDeploy 배포 그룹에 대한 자세한 내용은 AWS CodeDeploy 사용 설명서의 배포 그룹 작업을 참조하십시오. CodeDeploy

해당 UI: 구성 탭/ CodeDeploy 배포 그룹

codedeploy-deployment-description

(ECSDeployAction/Configuration/codedeploy-deployment-description)

(선택 사항)

이 작업으로 생성될 배포에 대한 설명을 지정합니다. 자세한 내용은 AWS CodeDeploy 사용 설명서의 배포 작업을 참조하십시오. CodeDeploy

해당 UI: 구성 탭/ 배포 설명 CodeDeploy

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

“Amazon ECS에 배포” 작업에 의해 생성된 변수

아마존 EKS에 배포