CodePipeline에서 사용자 지정 작업 생성 및 추가

AWS CLI로 사용자 지정 작업을 생성하려면

1. 텍스트 편집기를 열고 작업 범주, 작업 공급자 및 사용자 지정 작업에 필요한 모든 설정이 들어 있는 사용자 지정 작업용 JSON 파일을 생성합니다. 예를 들어, 하나의 속성만 필요로 하는 사용자 지정 빌드 작업을 생성하려면 다음과 같은 JSON 파일을 생성합니다.

   {
       "category": "Build",
       "provider": "My-Build-Provider-Name",
       "version": "1",
       "settings": {
           "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
           "executionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
       },
       "configurationProperties": [{
           "name": "ProjectName",
           "required": true,
           "key": true,
           "secret": false,
           "queryable": false,
           "description": "The name of the build project must be provided when this action is added to the pipeline.",
           "type": "String"
       }],
       "inputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "outputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   }

   이 예제는 사용자 지정 작업에 Project 태그 키와 ProjectA 값을 포함하여 사용자 지정 작업에 태그 지정을 추가합니다. CodePipeline의 리소스 태깅에 대한 자세한 내용은 리소스에 태그 지정 섹션을 참조하세요.

   JSON 파일에는 entityUrlTemplate과 executionUrlTemplate의 두 가지 속성이 있습니다. 구성 속성이 필수이며 보안 사항이 아닌 경우, {Config:name}의 형식을 따라 URL 템플릿 내 사용자 지정 작업의 구성 속성에 있는 이름을 참조할 수 있습니다. 예를 들어, 위의 샘플에서 entityUrlTemplate 값은 구성 속성 ProjectName을 참조합니다.

   • entityUrlTemplate: 작업의 서비스 공급자에 대한 정보를 제공하는 정적 링크입니다. 예에서는 빌드 시스템에 각 빌드 프로젝트에 대한 정적 링크가 포함되어 있습니다. 링크 형식은 빌드 제공자에 따라 다를 수 있습니다(또는 테스트나 다른 서비스 공급자와 같이 서로 다른 작업 유형을 생성하는 경우). 사용자 지정 작업이 추가될 때 사용자가 이 링크를 선택하여 빌드 프로젝트(또는 테스트 환경)에 대한 세부 사항을 제공하는 웹 사이트의 페이지로 브라우저를 열 수 있도록 이 링크 형식을 제공해야 합니다.

   • executionUrlTemplate: 작업의 현재 실행 또는 가장 최근의 실행에 대한 정보로 업데이트되는 동적 링크입니다. 사용자 지정 작업 작업자가 작업의 상태를 업데이트하면(예: 성공, 실패 또는 진행 중), 링크를 완성하는 데 사용되는 externalExecutionId도 제공됩니다. 이 링크를 사용하면 작업 실행에 대한 세부 정보를 제공할 수 있습니다.

   예를 들어, 파이프라인의 작업을 확인하면, 다음과 같은 두 개의 링크가 표시됩니다.

   

   이 정적 링크는 사용자 지정 작업을 추가하면 표시되며 entityUrlTemplate의 주소를 가리킵니다. 이 주소는 사용자 지정 작업을 생성할 때 지정합니다.

   이 동적 링크는 작업을 실행할 때마다 업데이트되며 executionUrlTemplate의 주소를 가리킵니다. 이 주소는 사용자 지정 작업을 생성할 때 지정합니다.

   이러한 링크 유형과 RevisionURLTemplate 및 ThirdPartyURL에 대한 자세한 내용은 CodePipeline API 참조의 ActionTypeSettings 및 CreateCustomActionType을 참조하세요. 작업 구조 요구사항 및 작업을 생성하는 방법에 대한 자세한 내용은 CodePipeline 파이프라인 구조 참조 단원을 참조하십시오.

2. JSON 파일을 저장하고 기억하기 쉬운 이름을 지정합니다(예: MyCustomAction.json).

3. AWS CLI를 설치한 컴퓨터에서 터미널 세션(Linux, OS X, Unix)이나 명령 프롬프트(Windows)를 엽니다.

4. AWS CLI를 사용하여 aws codepipeline create-custom-action-type 명령을 실행하고 앞에서 생성한 JSON 파일의 이름을 지정합니다.

   예를 들어, 빌드 사용자 지정 작업을 만들려면 다음과 같이 입력합니다.

   중요

   파일 이름 앞에 file://를 포함해야 합니다. 이 명령에 필수적입니다.

   aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json

5. 이 명령은 생성한 사용자 지정 작업의 전체 구조뿐만 아니라 자동으로 추가된 JobList 작업 구성 속성도 반환합니다. 파이프라인에 사용자 지정 작업을 추가하면 JobList를 사용하여 작업에 대해 폴링할 수 있는 공급자의 프로젝트를 지정할 수 있습니다. 이를 구성하지 않으면 사용자 지정 작업 작업자가 작업에 대해 폴링할 때 사용 가능한 모든 작업이 반환됩니다.

   예를 들어 이전 명령은 다음과 유사한 구조를 반환할 수 있습니다.

   {
       "actionType": {
           "inputArtifactDetails": {               
               "maximumCount": 1,                
               "minimumCount": 1
          },
          "actionConfigurationProperties": [
               {
                   "secret": false,
                   "required": true,
                   "name": "ProjectName",
                   "key": true,
                   "description": "The name of the build project must be provided when this action is added to the pipeline."
               }
           ],
           "outputArtifactDetails": {               
               "maximumCount": 0,                
               "minimumCount": 0
           },
           "id": {
               "category": "Build",
               "owner": "Custom",
               "version": "1",
               "provider": "My-Build-Provider-Name"
           },
           "settings": {
               "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
               "executionUrlTemplate": "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild/{ExternalExecutionId}/"
           }
       }
   }

   참고

   id 섹션에는 create-custom-action-type 명령 출력의 일부로 "owner": "Custom"이 포함됩니다. CodePipeline은 Custom을 사용자 지정 작업 유형의 소유자로 자동으로 할당합니다. 이 값은 create-custom-action-type 명령이나 update-pipeline 명령을 사용할 때는 할당하거나 변경할 수 없습니다.

Amazon EC2 인스턴스를 설정하려면

1. Amazon EC2에 대해 자세히 알아보고 해당 통합 사례에 적합한 선택인지 확인합니다. 자세한 내용은 Amazon EC2 - 가상 서버 호스팅을 참조하세요.

2. Amazon EC2 인스턴스 생성을 시작합니다. 자세한 내용은 Amazon EC2 Linux 인스턴스 시작하기를 참조하세요.

ID 페더레이션을 설정하려면

1. IAM ID 페더레이션에 대해 자세히 알아봅니다. 자세한 내용은 연동 관리를 참조하십시오.

2. 임시 액세스 부여를 위한 시나리오의 예를 검토하여 사용자 지정 작업의 요구에 가장 잘 맞는 시나리오를 식별하고 일시적으로 액세스합니다.

3. 다음과 같이 자신의 인프라와 관련 있는 자격 증명 연동의 코드 예제를 살펴봅니다.

   • Active Directory 사용 사례를 위한 자격 증명 연동 샘플 애플리케이션

4. 자격 증명 연동 구성을 시작합니다. 자세한 내용은 IAM 사용 설명서의 자격 증명 공급자 및 페더레이션 섹션을 참조하세요.

1. 터미널 세션(Linux, macOS 또는 Unix) 또는 명령 프롬프트(Windows)를 열고 get-pipeline 명령을 실행하여 편집하려는 파이프라인 구조를 JSON 파일에 복사합니다. 예를 들어 MyFirstPipeline이라는 파이프라인에 대해 다음 명령을 입력합니다.

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   이 명령은 아무 것도 반환하지 않지만 생성한 파일이 명령을 실행한 디렉터리에 표시되어야 합니다.

2. 텍스트 편집기에서 JSON 파일을 열고 파일 구조를 수정하여 사용자 지정 작업을 기존 단계에 추가합니다.

   참고

   해당 단계의 다른 작업과 동시에 작업을 실행하려면 작업에 해당 작업과 동일한 runOrder 값을 지정해야 합니다.

   예를 들어, 파이프라인의 구조를 수정하여 Build라는 이름의 단계를 추가하고 해당 단계에 빌드 사용자 지정 작업을 추가하려는 경우, 다음과 같이 JSON을 수정하여 배포 단계 전에 Build 단계를 추가해야 할 수 있습니다.

   ,
       {
         "name": "MyBuildStage",
         "actions":  [
                 {
                   "inputArtifacts": [
                   {
                      "name": "MyApp"
                    }
                      ],
                       "name": "MyBuildCustomAction",
                       "actionTypeId": {
                           "category": "Build",
                           "owner": "Custom",
                           "version": "1",
                           "provider": "My-Build-Provider-Name"
                       },
                       "outputArtifacts": [
                           {
                             "name": "MyBuiltApp"
                           }
                       ],
                       "configuration": {
                           "ProjectName": "MyBuildProject"
                       },
                       "runOrder": 1
                   }
               ]
           },      
           {
               "name": "Staging",
               "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyBuiltApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
                }      
       ]
   }

3. 변경 사항을 적용하려면 다음과 유사하게 파이프라인 JSON 파일을 지정하여 update-pipeline 명령을 실행합니다.

   중요

   파일 이름 앞에 file://를 포함해야 합니다. 이 명령에 필수적입니다.

   aws codepipeline update-pipeline --cli-input-json file://pipeline.json

   이 명령은 편집한 파이프라인의 전체 구조를 반환합니다.

4. CodePipeline 콘솔을 열고 방금 편집한 파이프라인의 이름을 선택합니다.

   파이프라인에 변경 사항이 표시됩니다. 다음에 사용자가 소스 위치를 변경할 경우, 파이프라인의 개정된 구조를 통해 해당 개정이 실행됩니다.