AWS CodeBuild에서 빌드 프로젝트 생성
AWS CodeBuild 콘솔, AWS CLI 또는 AWS SDK를 사용하여 빌드 프로젝트를 생성할 수 있습니다.
사전 조건
빌드 프로젝트를 생성하기 전에 빌드 계획의 질문에 답변하세요.
빌드 프로젝트 만들기(콘솔)
https://console.aws.amazon.com/codesuite/codebuild/home
CodeBuild 정보 페이지가 나타나면 빌드 프로젝트 생성을 선택합니다. 그렇지 않을 경우, 탐색 창에서 빌드를 확장한 후 빌드 프로젝트를 선택하고 빌드 프로젝트 생성을 선택합니다.
빌드 프로젝트 생성을 선택합니다.
다음 섹션을 채웁니다. 완료되면 페이지 하단에서 빌드 프로젝트 생성을 선택합니다.
프로젝트 구성
- 프로젝트 이름
-
이 빌드 프로젝트의 이름을 입력합니다. 각 AWS 계정에서 빌드 프로젝트 이름은 고유해야 합니다.
- 설명
-
선택적으로 빌드 프로젝트에 대한 설명을 입력하여 다른 사용자가 이 프로젝트의 용도를 이해하도록 도울 수 있습니다.
- 빌드 배지
-
(선택 사항) 프로젝트의 빌드 상태를 표시하고 삽입 가능하게 하려면 빌드 배치 활성화를 선택합니다. 자세한 내용은 빌드 배지 샘플 단원을 참조하십시오.
참고
소스 공급자가 Amazon S3인 경우 빌드 배지가 적용되지 않습니다.
- 동시 빌드 제한 활성화
-
(선택 사항) 이 프로젝트의 동시 빌드 수를 제한하려면 다음 단계를 수행합니다.
-
이 프로젝트에서 시작할 수 있는 동시 빌드 수 제한을 선택합니다.
-
동시 빌드 제한에 이 프로젝트에 허용되는 최대 동시 빌드 수를 입력합니다. 이 제한은 계정에 설정된 동시 빌드 제한보다 클 수 없습니다. 계정 제한보다 큰 숫자를 입력하려고 하면 오류 메시지가 표시됩니다.
현재 빌드 수가 이 한도 이하인 경우에만 새 빌드가 시작됩니다. 현재 빌드 수가 이 한도에 도달하면 새 빌드가 제한되고 실행되지 않습니다.
-
- 추가 정보
-
(선택 사항) 태그의 경우 지원되는 AWS 서비스에서 사용할 태그의 이름과 값을 입력합니다. [Add row]를 사용하여 태그를 추가합니다. 최대 50개의 태그를 추가할 수 있습니다.
소스
- 소스 공급자
-
소스 코드 공급자 유형을 선택합니다. 다음 목록을 사용하여 소스 공급자에 알맞은 유형을 선택합니다.
참고
CodeBuild에서는 Bitbucket Server를 지원하지 않습니다.
환경
- 프로비저닝 모델
-
다음 중 하나를 수행합니다.
-
AWS CodeBuild에서 관리하는 온디맨드 플릿을 사용하려면 온디맨드를 선택합니다. CodeBuild는 온디맨드 플릿을 통해 빌드에 맞는 컴퓨팅 기능을 제공합니다. 빌드가 완료되면 머신이 파괴됩니다. 온디맨드 플릿은 완전 관리형이며, 수요 급증을 처리할 수 있는 자동 규모 조정 기능이 포함되어 있습니다.
-
AWS CodeBuild에서 관리하는 예약 용량 플릿을 사용하려면 예약 용량을 선택한 다음 플릿 이름을 선택합니다. 예약 용량 플릿을 사용하면 빌드 환경을 위한 전용 인스턴스 세트를 구성할 수 있습니다. 이러한 머신은 유휴 상태로 유지되므로 빌드 또는 테스트를 즉시 처리하고 빌드 기간을 단축할 수 있습니다. 예약 용량 플릿을 사용하면 머신이 상시 가동되므로 프로비저닝하는 한 계속해서 비용이 발생합니다.
자세한 내용은 예약 용량 플릿에서 빌드 실행을 참조하세요.
-
- 환경 이미지
-
다음 중 하나를 수행합니다.
-
AWS CodeBuild가 관리하는 도커 이미지를 사용하려면 Managed image(관리형 이미지)를 선택한 후 운영 체제, 런타임, 이미지 및 이미지 버전에서 항목을 선택합니다. 사용 가능한 경우 환경 유형에서 항목을 선택합니다.
-
다른 도커 이미지를 사용하려면 사용자 지정 이미지를 선택합니다. 환경 유형에서 ARM, Linux, Linux GPU 또는 Windows를 선택합니다. Other registry(다른 레지스트리)를 선택한 경우 External registry URL(외부 레지스트리 URL)에 Docker Hub의 도커 이미지 이름 및 태그를
docker repository/docker image name -
프라이빗 도커 이미지를 사용하려면 사용자 지정 이미지를 선택합니다. 환경 유형에서 ARM, Linux, Linux GPU 또는 Windows를 선택합니다. Image registry(이미지 레지스트리)에서 Other registry(다른 레지스트리)를 선택한 다음 프라이빗 도커 이미지에 대한 보안 인증 정보의 ARN을 입력합니다. 보안 인증은 Secrets Manager에서 생성됩니다. 자세한 내용은 AWS Secrets Manager 사용 설명서의 AWS Secrets Manager이란? 섹션을 참조하세요.
참고
CodeBuild는 사용자 지정 도커 이미지에 대해
ENTRYPOINT를 재정의합니다. -
- 컴퓨팅
-
다음 중 하나를 수행합니다.
-
EC2 컴퓨팅을 사용하려면 EC2를 선택합니다. EC2 컴퓨팅은 작업 실행 중에 최적화된 유연성을 제공합니다.
-
Lambda 컴퓨팅을 사용하려면 Lambda를 선택합니다. Lambda 컴퓨팅은 빌드에 최적화된 시작 속도를 제공합니다. Lambda는 시작 지연 시간이 짧아 더 빠른 빌드를 지원합니다. Lambda도 자동으로 확장되므로 빌드가 실행 대기열에서 대기하지 않습니다. 자세한 내용은 AWS Lambda 컴퓨팅에서 빌드 실행을 참조하세요.
-
- 서비스 역할
다음 중 하나를 수행합니다.
-
CodeBuild 서비스 역할이 없는 경우 새 서비스 역할을 선택합니다. 역할 이름에 새 역할의 이름을 입력합니다.
-
CodeBuild 서비스 역할이 있는 경우 기존 서비스 역할을 선택합니다. 역할 ARN에서 서비스 역할을 선택합니다.
참고
콘솔을 사용하여 빌드 프로젝트를 생성하는 경우, 이와 동시에 CodeBuild 서비스 역할을 생성할 수 있습니다. 기본적으로 역할은 해당 빌드 프로젝트에서만 작동합니다. 콘솔을 사용하여 이 서비스 역할을 다른 빌드 프로젝트와 연결하는 경우 다른 빌드 프로젝트에서 작동하도록 역할이 업데이트됩니다. 하나의 서비스 역할은 최대 10개의 빌드 프로젝트에서 작동할 수 있습니다.
-
- 추가 구성
-
- 자동 재시도 제한
-
빌드 실패 후 추가 자동 재시도 횟수를 지정합니다. 예를 들어 자동 재시도 제한이 2로 설정된 경우 CodeBuild는
RetryBuildAPI를 호출하여 빌드를 추가로 최대 2회 자동 재시도합니다. - 제한 시간
-
빌드가 완료되지 않는 경우 CodeBuild가 해당 빌드를 중지할 제한 시간으로 5분에서 36시간 사이의 값을 지정합니다. [hours] 및 [minutes]가 비어 있는 경우 기본값인 60분이 사용됩니다.
- 권한 있음
-
(선택 사항) 이 빌드 프로젝트를 사용하여 Docker 이미지를 빌드하려는 경우에만 Docker 이미지를 빌드하거나 빌드에서 승격된 권한을 얻으려는 경우 이 플래그 활성화를 선택합니다. 그렇지 않으면 Docker 데몬과 상호 작용을 시도하는 모든 연결된 빌드가 실패합니다. 또한 빌드가 상호 작용할 수 있도록 Docker 데몬을 시작해야 합니다. 이를 수행하는 한 가지 방법은 다음 빌드 명령을 실행하여 빌드 사양의
install단계에서 Docker 데몬을 초기화하는 것입니다. 선택한 빌드 환경 이미지가 Docker 지원을 통해 CodeBuild에서 제공되지 않는 경우 이 명령을 실행하지 마세요.참고
기본적으로 비 VPC 빌드에는 Docker 데몬이 활성화됩니다. VPC 빌드에 Docker 컨테이너를 사용하려면 Docker Docs 웹 사이트의 런타임 권한 및 Linux 기능
을 참조하고 권한 부여 모드를 활성화합니다. 또한 Windows는 권한 모드를 지원하지 않습니다. - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay2 & - timeout 15 sh -c "until docker info; do echo .; sleep 1; done" - VPC
CodeBuild를 사용하여 VPC에서 작업을 수행하려는 경우:
-
VPC에서 CodeBuild가 사용하는 VPC ID를 선택합니다.
-
VPC 서브넷에서 CodeBuild가 사용하는 리소스가 포함된 서브넷을 선택합니다.
-
VPC 보안 그룹에서 CodeBuild가 VPC의 리소스에 대한 액세스를 허용하기 위해 사용하는 보안 그룹을 선택합니다.
자세한 내용은 Amazon Virtual Private Cloud에서 AWS CodeBuild 사용 단원을 참조하십시오.
-
- 컴퓨팅
-
사용 가능한 옵션 중 하나를 선택합니다.
- 환경 변수
-
사용할 빌드의 각 환경 변수에 대해 이름 및 값을 입력하고 유형을 선택합니다.
참고
CodeBuild는 AWS 리전의 환경 변수를 자동으로 설정합니다. buildspec.yml에 추가하지 않은 경우 다음 환경 변수를 설정해야 합니다.
-
AWS_ACCOUNT_ID
-
IMAGE_REPO_NAME
-
IMAGE_TAG
콘솔 및 AWS CLI 사용자는 환경 변수를 확인할 수 있습니다. 환경 변수의 가시성에 대한 문제가 없다면 [Name] 및 [Value] 필드를 설정한 다음 [Type]을 [Plaintext]로 설정합니다.
AWS 액세스 키 ID, AWS 비밀 액세스 키 또는 암호와 같은 중요한 값을 가진 환경 변수는 Amazon EC2 Systems Manager Parameter Store 또는 AWS Secrets Manager에 파라미터로 저장하는 것이 좋습니다.
Amazon EC2 Systems Manager Parameter Store를 사용하는 경우 유형에서 파라미터를 선택합니다. 이름에 CodeBuild가 참조할 식별자를 입력합니다. 값에 Amazon EC2 Systems Manager Parameter Store에 저장되는 파라미터의 이름을 입력합니다. 예를 들어
/CodeBuild/dockerLoginPassword라는 이름의 파라미터를 사용하여 유형에서 파라미터를 선택합니다. 이름에LOGIN_PASSWORD을 입력합니다. 값에/CodeBuild/dockerLoginPassword를 입력합니다.중요
Amazon EC2 Systems Manager Parameter Store를 사용하는 경우
/CodeBuild/로 시작하는 파라미터 이름(예:/CodeBuild/dockerLoginPassword)으로 파라미터를 저장하는 것이 좋습니다. CodeBuild 콘솔을 사용하여 Amazon EC2 Systems Manager에서 파라미터를 생성할 수 있습니다. 파라미터 생성을 선택하고 대화 상자에 표시되는 지시에 따릅니다. 대화 상자의 KMS 키에 해당 계정의 AWS KMS 키에 대한 ARN을 지정할 수 있습니다. Amazon EC2 Systems Manager는 이 키를 사용하여 저장 시 파라미터의 값을 암호화하고 검색 시 암호를 해독합니다. CodeBuild 콘솔을 사용하여 파라미터를 생성하는 경우 콘솔은 이름이/CodeBuild/인 파라미터가 저장되면 시작합니다. 자세한 내용은 Amazon EC2 Systems Manager 사용 설명서의 Systems Manager Parameter Store 및 Systems Manager Parameter Store 콘솔 연습을 참조하세요.빌드 프로젝트가 Amazon EC2 Systems Manager Parameter Store에 저장된 파라미터를 참조하는 경우 해당 빌드 프로젝트의 서비스 역할은
ssm:GetParameters작업을 허용해야 합니다. 앞에서 새 서비스 역할을 선택한 경우에는 CodeBuild는 빌드 프로젝트의 기본 서비스 역할에 이 작업을 포함합니다. Existing service role(기존 서비스 역할)을 선택한 경우에는 이 작업을 서비스 역할에 별도로 포함해야 합니다.빌드 프로젝트가
/CodeBuild/로 시작되지 않는 파라미터 이름으로 Amazon EC2 Systems Manager Parameter Store에 저장된 파라미터를 참조하는 경우 새 서비스 역할을 선택하면/CodeBuild/로 시작하지 않는 파라미터 이름에 액세스할 수 있도록 해당 서비스 역할을 업데이트해야 합니다. 이는 서비스 역할이/CodeBuild/로 시작하는 파라미터 이름에만 액세스할 수 있기 때문입니다.새 서비스 역할을 선택하면 Amazon EC2 Systems Manager Parameter Store에 있는
/CodeBuild/네임스페이스의 모든 파라미터를 해독할 권한이 서비스 역할에 포함됩니다.사용자가 설정한 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 도커 이미지에 값이
my_value인MY_VAR이라는 환경 변수가 이미 포함되어 있는데, 사용자가MY_VAR환경 변수의 값을other_value로 설정하면,my_value가other_value로 바뀝니다. 마찬가지로, 도커 이미지에 값이/usr/local/sbin:/usr/local/bin인PATH라는 환경 변수가 이미 포함되어 있는데, 사용자가PATH환경 변수의 값을$PATH:/usr/share/ant/bin으로 설정하면,/usr/local/sbin:/usr/local/bin이$PATH:/usr/share/ant/bin리터럴 값으로 바뀝니다.CODEBUILD_로 시작하는 이름으로 환경 변수를 설정하지 마십시오. 이 접두사는 내부 전용으로 예약되어 있습니다.여러 위치에서 동일한 이름의 환경 변수가 정의되는 경우, 다음과 같이 값이 결정됩니다.
-
시작 빌드 작업 호출의 값이 가장 높은 우선 순위를 갖습니다.
-
빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다.
-
buildspec 선언의 값이 가장 낮은 우선 순위를 갖습니다.
Secrets Manager를 사용하는 경우 유형으로 Secrets Manager로 선택합니다. 이름에 CodeBuild가 참조할 식별자를 입력합니다. 값에
secret-id:json-key:version-stage:version-idreference-key를 입력합니다. 자세한 내용은 Secrets Manager reference-key in the buildspec file을 참조하세요.중요
Secrets Manager를 사용하는 경우 이름이
/CodeBuild/로 시작하는 암호를 저장하는 것이 좋습니다(예:/CodeBuild/dockerLoginPassword). 자세한 내용은 AWS Secrets Manager 사용 설명서의 AWS Secrets Manager이란? 섹션을 참조하세요.빌드 프로젝트가 Secrets Manager에 저장된 암호를 참조하는 경우 해당 빌드 프로젝트의 서비스 역할은
secretsmanager:GetSecretValue작업을 허용해야 합니다. 앞에서 새 서비스 역할을 선택한 경우에는 CodeBuild는 빌드 프로젝트의 기본 서비스 역할에 이 작업을 포함합니다. Existing service role(기존 서비스 역할)을 선택한 경우에는 이 작업을 서비스 역할에 별도로 포함해야 합니다.빌드 프로젝트가
/CodeBuild/로 시작되지 않는 보안 암호 이름으로 Secrets Manager에 저장된 암호를 참조하는 경우 새 서비스 역할을 선택하면/CodeBuild/로 시작하지 않는 보안 암호 이름에 액세스할 수 있도록 해당 서비스 역할을 업데이트해야 합니다. 이는 서비스 역할이/CodeBuild/로 시작하는 암호 이름에만 액세스할 수 있기 때문입니다.새 서비스 역할을 선택하면 에 있는
/CodeBuild/네임스페이스의 모든 암호를 해독할 권한이 서비스 역할에 포함됩니다. -
Buildspec
- 빌드 사양
-
다음 중 하나를 수행합니다.
-
소스 코드에 buildspec 파일이 있는 경우 Use a buildspec file(빌드 사양 파일 사용) 을 선택합니다. 기본적으로 CodeBuild는 소스 코드 루트 디렉터리에서
buildspec.yml이라는 파일을 찾습니다. buildspec 파일이 다른 이름이나 위치를 사용하는 경우 Buildspec 이름에 소스 루트의 경로를 입력합니다(예:buildspec-two.yml또는configuration/buildspec.yml). buildspec 파일이 S3 버킷에 있는 경우 해당 파일은 빌드 프로젝트와 동일한 AWS 리전에 있어야 합니다. ARN을 사용하여 buildspec 파일을 지정합니다(예:arn:aws:s3:::).<my-codebuild-sample2>/buildspec.yml -
소스 코드에 buildspec 파일이 포함되어 있지 않거나, 소스 코드의 루트 디렉터리에 있는
buildspec.yml파일의build단계에 지정된 것과 다른 빌드 명령 세트를 실행하려는 경우 빌드 명령 삽입을 선택합니다. 빌드 명령의build단계에서 실행하려는 명령을 입력합니다. 명령이 여러 개인 경우 각 명령을&&로 구분합니다(예:mvn test && mvn package). 다른 구문에서 명령을 실행하려는 경우 또는build단계에 대해 특히 긴 명령 목록이 있는 경우에는 소스 코드 루트 디렉터리에buildspec.yml파일을 추가하고, 이 파일에 명령을 추가한 다음, 소스 코드 루트 디렉터리에서 buildspec.yml 사용을 선택합니다.
자세한 내용은 buildspec 참조을 참조하세요.
-
배치 구성
빌드 그룹을 단일 작업으로 실행할 수 있습니다. 자세한 내용은 배치로 빌드 실행 단원을 참조하십시오.
- 배치 구성 정의
-
이 프로젝트에서 배치 빌드를 허용하려면 선택합니다.
- 배치 서비스 역할
-
배치 빌드에 대한 서비스 역할을 제공합니다.
다음 중 하나를 선택합니다.
-
배치 서비스 역할이 없는 경우 새 서비스 역할을 선택합니다. 서비스 역할에 새 역할의 이름을 입력합니다.
-
배치 서비스 역할이 있는 경우 기존 서비스 역할을 선택합니다. 서비스 역할에서 서비스 역할을 선택합니다.
배치 빌드는 배치 구성에 새로운 보안 역할을 도입합니다. CodeBuild가 사용자 대신
StartBuild,StopBuild및RetryBuild작업을 호출하여 배치의 일부로 빌드를 실행할 수 있어야 하므로 이 새 역할이 필요합니다. 고객은 다음과 같은 두 가지 이유로 빌드에 사용하는 것과 동일한 역할이 아닌 새 역할을 사용해야 합니다.-
빌드 역할
StartBuild,StopBuild및RetryBuild권한을 부여하면 단일 빌드에서 buildspec을 통해 더 많은 빌드를 시작할 수 있습니다. -
CodeBuild 배치 빌드는 배치의 빌드에 사용할 수 있는 빌드 및 컴퓨팅 유형의 수를 제한하는 제한을 제공합니다. 빌드 역할에 이러한 권한이 있는 경우 빌드 자체가 이러한 제한을 우회할 수 있습니다.
-
- 배치에 허용되는 컴퓨팅 유형
-
배치에 허용되는 컴퓨팅 유형을 선택합니다. 해당하는 항목을 모두 선택합니다.
- 배치에 허용되는 최대 빌드 수
-
배치에 허용되는 최대 빌드 수를 입력합니다. 이 제한을 초과하는 배치는 실패합니다.
- 배치 제한 시간
-
배치 빌드가 완료되는 최대 시간을 입력합니다.
- 아티팩트 결합
-
배치의 모든 아티팩트를 단일 위치로 결합을 선택하면 배치의 모든 아티팩트가 단일 위치로 결합됩니다.
- 배치 보고서 모드
-
배치 빌드에 대해 원하는 빌드 상태 보고서 모드를 선택합니다.
참고
이 필드는 프로젝트 소스가 Bitbucket, GitHub 또는 GitHub Enterprise이고 소스에서 빌드 시작 및 종료 시 소스 공급자에게 빌드 상태 보고를 선택한 경우에만 사용할 수 있습니다.
- 빌드 집계
-
배치의 모든 빌드 상태를 단일 상태 보고서로 통합하려면 선택합니다.
- 개별 빌드
-
배치에 있는 모든 빌드의 빌드 상태를 별도로 보고하려면 선택합니다.
아티팩트
- 유형
-
다음 중 하나를 수행합니다.
-
빌드 출력 결과물을 생성하지 않으려면 [No artifacts]를 선택합니다. 빌드 테스트만 실행하고 있는 경우 또는 Amazon ECR 리포지토리에 도커 이미지를 푸시하려는 경우에 이 작업을 원할 수 있습니다.
-
S3 버킷에 빌드 출력을 저장하려면 Amazon S3를 선택하고 다음 작업을 수행합니다.
-
빌드 출력 ZIP 파일이나 폴더에 프로젝트 이름을 사용하려는 경우 이름을 비워 둡니다. 그렇지 않으면 이름을 입력합니다. (ZIP 파일을 출력하고 ZIP 파일에 파일 확장명을 넣으려는 경우, ZIP 파일 이름 뒤에 이를 포함하십시오.)
-
buildspec 파일에 지정된 이름으로 콘솔에서 지정한 이름을 재정의하려는 경우 의미 체계 버전 관리 사용을 선택합니다. buildspec 파일의 이름은 빌드 시 계산되며 Shell 명령 언어를 사용합니다. 예를 들어 결과물 이름이 항상 고유하도록 날짜와 시간을 결과물 이름에 추가할 수 있습니다. 고유한 결과물 이름을 사용하면 결과물을 덮어쓰지 않을 수 있습니다. 자세한 내용은 buildspec 구문 단원을 참조하십시오.
-
[Bucket name]에서 출력 버킷의 이름을 선택합니다.
-
이 절차의 앞부분에서 빌드 명령 삽입을 선택한 경우 출력 파일에 빌드 출력 ZIP 파일 또는 폴더에 넣으려는 빌드의 파일 위치를 입력합니다. 위치가 여러 개인 경우 각 위치를 쉼표로 구분합니다(예:
appspec.yml, target/my-app.jar). 자세한 내용은 buildspec 구문의files설명을 참조하십시오. -
빌드 아티팩트를 암호화하지 않으려면 Remove artifacts encryption(결과물 암호화 제거)을 선택합니다.
-
각각 원하는 보조 아티팩트 세트마다 다음과 같이 실행합니다.
-
Atrifact identifier(아티팩트 식별자)에서 128자 미만으로 영숫자와 밑줄만 포함된 값을 입력합니다.
-
Add artifact(아티팩트 추가)를 선택합니다.
-
이전 단계에 따라 보조 결과물을 구성합니다.
-
Save artifact(아티팩트 저장)를 선택합니다.
-
- 추가 구성
-
- 암호화 키
-
(선택 사항) 다음 중 하나를 수행하십시오.
-
계정에서 Amazon S3에 대한 AWS 관리형 키를 사용하여 빌드 출력 아티팩트를 암호화하려면 암호화 키를 비워 둡니다. 이 값이 기본값입니다.
-
고객 관리형 키를 사용하여 빌드 출력 아티팩트를 암호화하려면 암호화 키에 KMS 키의 ARN을 입력합니다.
arn:aws:kms:형식을 사용합니다.region-ID:account-ID:key/key-ID
-
- 캐시 유형
Cache type(캐시 유형)에서 다음 중 하나를 선택합니다.
-
캐시를 사용하지 않으려면 [No cache]를 선택합니다.
-
Amazon S3 캐시를 사용하려면 Amazon S3를 선택하고 다음을 수행합니다.
-
버킷에서 캐시가 저장된 S3 버킷의 이름을 선택합니다.
-
(선택 사항) 캐시 경로 접두사에 Amazon S3 경로 접두사를 입력합니다. Cache path prefix(캐시 경로 접두사) 값은 디렉터리 이름과 비슷합니다. 따라서 캐시를 버킷의 동일한 디렉터리에 저장할 수 있습니다.
중요
경로 접두사 끝에 후행 슬래시(/)를 추가하지 마십시오.
-
-
로컬 캐시를 사용하려면 로컬을 선택한 다음 하나 이상의 로컬 캐시 모드를 선택해야 합니다.
참고
Docker 계층 캐시 모드는 Linux에서만 사용할 수 있습니다. 이 모드를 선택할 경우 프로젝트를 권한이 있는 모드에서 실행해야 합니다.
캐시를 사용하면 빌드 환경의 재사용 가능한 특정 부분이 캐시에 저장되고 빌드 전반에서 사용되기 때문에 상당한 빌드 시간을 절약할 수 있습니다. buildspec 파일에 캐시를 지정하는 것에 대한 자세한 정보는 buildspec 구문 단원을 참조하십시오. 캐싱에 대한 자세한 정보는 성능을 개선하기 위한 캐시 빌드을 참조하십시오.
-
로그
생성하려는 로그를 선택합니다. Amazon CloudWatch Logs 또는 Amazon S3 로그 중 하나 또는 둘 다를 생성할 수 있습니다.
- CloudWatch
-
Amazon CloudWatch Logs 로그를 원할 경우:
- CloudWatch 로그
-
CloudWatch 로그를 선택합니다.
- 그룹 이름
-
Amazon CloudWatch Logs 로그 그룹의 이름을 입력합니다.
- 스트림 이름
-
Amazon CloudWatch Logs 로그 스트림 이름을 입력합니다.
- S3
-
Amazon S3 로그를 원할 경우:
- S3 로그
-
S3 로그를 선택합니다.
- 버킷
-
로그에 대한 S3 버킷 이름을 선택합니다.
- 경로 접두사
-
로그의 접두사를 입력합니다.
- S3 로그 암호화 비활성화
-
S3 로그를 암호화하지 않으려면 선택합니다.
빌드 프로젝트 생성(AWS CLI)
AWS CLI와 CodeBuild를 함께 사용하는 방법에 대한 자세한 내용은 명령줄 참조 섹션을 참조하세요.
AWS CLI를 사용하여 CodeBuild 빌드 프로젝트를 생성하려면 JSON 형식의 프로젝트 구조를 생성하고, 구조를 채우고, create-project 명령을 호출하여 프로젝트를 생성합니다.
JSON 파일 생성
--generate-cli-skeleton 옵션을 사용하여 create-project 명령으로 스켈레톤 JSON 파일을 생성합니다.
aws codebuild create-project --generate-cli-skeleton ><json-file>
이렇게 하면 <json-file>로 지정된 경로와 파일 이름을 가진 JSON 파일이 생성됩니다.
JSON 파일 채우기
JSON 데이터를 다음과 같이 수정하고 결과를 저장합니다.
{ "name": "<project-name>", "description": "<description>", "source": { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>", "gitCloneDepth": "<git-clone-depth>", "buildspec": "<buildspec>", "InsecureSsl": "<insecure-ssl>", "reportBuildStatus": "<report-build-status>", "buildStatusConfig": { "context": "<context>", "targetUrl": "<target-url>" }, "gitSubmodulesConfig": { "fetchSubmodules": "<fetch-submodules>" }, "auth": { "type": "<auth-type>", "resource": "<auth-resource>" }, "sourceIdentifier": "<source-identifier>" }, "secondarySources": [ { "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE", "location": "<source-location>", "gitCloneDepth": "<git-clone-depth>", "buildspec": "<buildspec>", "InsecureSsl": "<insecure-ssl>", "reportBuildStatus": "<report-build-status>", "auth": { "type": "<auth-type>", "resource": "<auth-resource>" }, "sourceIdentifier": "<source-identifier>" } ], "secondarySourceVersions": [ { "sourceIdentifier": "<secondary-source-identifier>", "sourceVersion": "<secondary-source-version>" } ], "sourceVersion": "<source-version>", "artifacts": { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<artifacts-location>", "path": "<artifacts-path>", "namespaceType": "<artifacts-namespacetype>", "name": "<artifacts-name>", "overrideArtifactName": "<override-artifact-name>", "packaging": "<artifacts-packaging>" }, "secondaryArtifacts": [ { "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS", "location": "<secondary-artifact-location>", "path": "<secondary-artifact-path>", "namespaceType": "<secondary-artifact-namespaceType>", "name": "<secondary-artifact-name>", "packaging": "<secondary-artifact-packaging>", "artifactIdentifier": "<secondary-artifact-identifier>" } ], "cache": { "type": "<cache-type>", "location": "<cache-location>", "mode": [ "<cache-mode>" ] }, "environment": { "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER", "image": "<image>", "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE", "certificate": "<certificate>", "environmentVariables": [ { "name": "<environmentVariable-name>", "value": "<environmentVariable-value>", "type": "<environmentVariable-type>" } ], "registryCredential": [ { "credential": "<credential-arn-or-name>", "credentialProvider": "<credential-provider>" } ], "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE", "privilegedMode": "<privileged-mode>" }, "serviceRole": "<service-role>", "autoRetryLimit":<auto-retry-limit>, "timeoutInMinutes":<timeout>, "queuedTimeoutInMinutes":<queued-timeout>, "encryptionKey": "<encryption-key>", "tags": [ { "key": "<tag-key>", "value": "<tag-value>" } ], "vpcConfig": { "securityGroupIds": [ "<security-group-id>" ], "subnets": [ "<subnet-id>" ], "vpcId": "<vpc-id>" }, "badgeEnabled": "<badge-enabled>", "logsConfig": { "cloudWatchLogs": { "status": "<cloudwatch-logs-status>", "groupName": "<group-name>", "streamName": "<stream-name>" }, "s3Logs": { "status": "<s3-logs-status>", "location": "<s3-logs-location>", "encryptionDisabled": "<s3-logs-encryption-disabled>" } }, "fileSystemLocations": [ { "type": "EFS", "location": "<EFS-DNS-name-1>:/<directory-path>", "mountPoint": "<mount-point>", "identifier": "<efs-identifier>", "mountOptions": "<efs-mount-options>" } ], "buildBatchConfig": { "serviceRole": "<batch-service-role>", "combineArtifacts":<combine-artifacts>, "restrictions": { "maximumBuildsAllowed":<max-builds>, "computeTypesAllowed": [ "<compute-type>" ] }, "timeoutInMins":<batch-timeout>, "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS" }, "concurrentBuildLimit":<concurrent-build-limit>}
다음을 바꿉니다.
이름
필수 사항입니다. 이 빌드 프로젝트의 이름입니다. 이 이름은 AWS 계정에 있는 모든 빌드 프로젝트에서 고유해야 합니다.
description
선택 사항입니다. 이 빌드 프로젝트의 설명입니다.
source
필수 사항입니다. 이 빌드 프로젝트의 소스 코드 설정에 대한 정보가 들어 있는 ProjectSource 객체입니다. source 객체를 추가한 후에는 secondarySources를 사용해 소스를 최대 12개까지 더 추가할 수 있습니다. 이러한 설정에는 다음이 포함됩니다.
- source/type
-
필수 사항입니다. 빌드할 소스 코드가 포함된 리포지토리의 유형입니다. 유효한 값으로는 다음이 포함됩니다.
-
CODECOMMIT -
CODEPIPELINE -
GITHUB -
GITHUB_ENTERPRISE -
GITLAB -
GITLAB_SELF_MANAGED -
BITBUCKET -
S3 -
NO_SOURCE
NO_SOURCE를 사용할 경우 프로젝트에 소스가 없으므로 buildspec은 파일이 될 수 없습니다. 대신에buildspec속성을 사용하여 buildspec에 대해 YAML 형식이 지정된 문자열을 지정해야 합니다. 자세한 내용은 소스 없이 빌드 프로젝트 생성 단원을 참조하십시오. -
- source/location
-
<source-type>을CODEPIPELINE으로 설정하지 않은 경우 필수입니다. 지정한 리포지토리 유형의 소스 코드 위치입니다.-
CodeCommit의 경우 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다(예:
https://git-codecommit.).<region-id>.amazonaws.com/v1/repos/<repo-name> -
Amazon S3의 경우 빌드 입력 버킷 이름 다음에 소스 코드 및 buildspec이 포함된 ZIP 파일의 경로와 이름이 옵니다. 예:
-
입력 버킷의 루트에 있는 ZIP 파일의 경우:
<bucket-name>/<object-name>.zip -
입력 버킷의 하위 폴더에 있는 ZIP 파일의 경우:
<bucket-name>/<subfoler-path>/<object-name>.zip
-
-
GitHub의 경우 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다. URL에 github.com이 포함되어야 합니다. AWS 계정을 GitHub 계정에 연결해야 합니다. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 생성합니다.
-
[Authorize application]을 선택합니다. (GitHub 계정에 연결했으면 빌드 프로젝트 생성을 완료하지 않아도 됩니다. CodeBuild 콘솔을 닫아도 됩니다.)
-
-
GitHub Enterprise Server의 경우 HTTP 또는 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다. 또한 AWS 계정을 GitHub Enterprise Server 계정에도 연결해야 합니다. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 생성합니다.
-
GitHub Enterprise Server에서 개인용 액세스 토큰을 생성합니다.
-
CodeBuild 프로젝트를 생성할 때 사용할 수 있도록 이 토큰을 클립보드에 복사합니다. 자세한 내용은 GitHub Help 웹 사이트의 Creating a personal access token for the command line
을 참조하십시오. -
콘솔을 사용하여 CodeBuild 프로젝트를 생성하는 경우, 소스의 소스 공급자에서 GitHub Enterprise를 선택합니다.
-
[Personal Access Token]에서 클리보드에 복사한 토큰을 붙여 넣습니다. 토큰 저장을 선택합니다. 이제 CodeBuild 계정이 GitHub Enterprise Server 계정에 연결되었습니다.
-
-
GitLab 및 GitLab self-managed의 경우 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다. GitLab을 사용하는 경우 URL에 gitlab.com이 포함되어야 합니다. GitLab self-managed를 사용하는 경우 URL에 gitlab.com을 포함할 필요가 없습니다. AWS 계정을 GitLab 또는 GitLab self-managed 계정에 연결해야 합니다. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 생성합니다.
-
개발자 도구 탐색 창에서 설정, 연결을 선택한 다음, 연결 생성을 선택합니다. 이 페이지에서 GitLab 또는 GitLab self-managed 연결을 생성한 다음 GitLab에 연결을 선택합니다.
-
-
Bitbucket의 경우 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다. URL에 bitbucket.org가 포함되어야 합니다. 또한 AWS 계정을 Bitbucket 계정에도 연결해야 합니다. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 생성합니다.
-
콘솔을 사용하여 Bitbucket에 연결(또는 재연결)하면 Bitbucket [Confirm access to your account] 페이지에서 [Grant access]를 선택합니다. (Bitbucket 계정에 연결했으면 빌드 프로젝트 생성을 완료하지 않아도 됩니다. CodeBuild 콘솔을 닫아도 됩니다.)
-
-
AWS CodePipeline의 경우
source에location값을 지정하지 마십시오. CodePipeline에서 파이프라인을 생성하면 파이프라인의 소스 단계에서 소스 코드 위치를 지정하게 되므로 이 값이 무시됩니다.
-
- source/gitCloneDepth
-
선택 사항입니다. 다운로드할 이력의 수준입니다. 최소값은 0입니다. 이 값이 0이거나, 25를 초과하거나, 지정되지 않은 경우 각 빌드 프로젝트에서 전체 이력이 다운로드됩니다. 소스 유형이 Amazon S3일 경우 이 값이 지원되지 않습니다.
- source/buildspec
-
선택 사항입니다. 사용할 빌드 사양 정의 또는 파일입니다. 이 값을 제공하지 않거나 빈 문자열로 설정하는 경우 소스 코드에 루트 디렉터리의
buildspec.yml파일이 포함되어 있어야 합니다. 이 값이 설정된 경우 인라인 buildspec 정의, 기본 소스의 루트 디렉터리에 상대적인 대체 buildspec 파일의 경로 또는 S3 버킷의 경로가 될 수 있습니다. 버킷은 빌드 프로젝트와 동일한 AWS 리전에 있어야 합니다. ARN을 사용하여 buildspec 파일을 지정합니다(예:arn:aws:s3:::). 자세한 내용은 buildspec 파일 이름 및 스토리지 위치 단원을 참조하십시오.<my-codebuild-sample2>/buildspec.yml - source/auth
-
CodeBuild가 빌드할 소스 코드에 액세스하기 위한 권한 부여 설정에 대한 정보를 포함합니다.
- 소스/인증/유형
-
필수 사항입니다. 사용할 권한 부여 유형입니다. 유효한 값은 다음과 같습니다.
-
OAUTH -
CODECONNECTIONS -
SECRETS_MANAGER
-
- 소스/인증/리소스
-
선택 사항입니다. 지정된 권한 부여 유형에 적용되는 리소스 값입니다. Secrets Manager ARN 또는 CodeConnections ARN일 수 있습니다.
- source/reportBuildStatus
-
빌드의 시작 및 완료 상태를 소스 공급자에게 보낼지 여부를 지정합니다. GitHub, GitHub Enterprise Server 또는 Bitbucket이 아닌 소스 공급자로 설정하는 경우,
invalidInputException이 발생합니다.소스 공급자에게 빌드 상태를 보고하려면 소스 공급자와 연결된 사용자에게 리포지토리에 대한 쓰기 권한이 있어야 합니다. 사용자에게 쓰기 권한이 없는 경우 빌드 상태를 업데이트할 수 없습니다. 자세한 내용은 소스 공급자 액세스 단원을 참조하십시오.
- source/buildStatusConfig
-
CodeBuild 빌드 프로젝트가 빌드 상태를 소스 공급자에게 보고하는 방법을 정의하는 정보를 포함합니다. 이 옵션은 소스 유형이
GITHUB,GITHUB_ENTERPRISE또는BITBUCKET인 경우에만 사용됩니다.- source/buildStatusConfig/context
-
Bitbucket 소스의 경우 이 파라미터는 Bitbucket 커밋 상태의
name파라미터에 사용됩니다. GitHub 소스의 경우 이 파라미터는 GitHub 커밋 상태의context파라미터에 사용됩니다.예를 들어 CodeBuild 환경 변수를 사용하여
context에 빌드 번호와 webhook 트리거를 포함할 수 있습니다.AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER그 결과 webhook 풀 요청 이벤트에 의해 트리거된 빌드 #24에 대해 다음과 같은 컨텍스트가 나타납니다.
AWS CodeBuild sample-project Build #24 - pr/8
- source/buildStatusConfig/targetUrl
-
Bitbucket 소스의 경우 이 파라미터는 Bitbucket 커밋 상태의
url파라미터에 사용됩니다. GitHub 소스의 경우 이 파라미터는 GitHub 커밋 상태의target_url파라미터에 사용됩니다.예를 들어
targetUrl를https://aws.amazon.com/codebuild/로 설정하면 커밋 상태가 이 URL에 연결됩니다.<path to build>CodeBuild 환경 변수를
targetUrl에 포함하여 URL에 추가 정보를 추가할 수도 있습니다. 예를 들어 URL에 빌드 리전을 영역을 추가하려면 다음과 같이targetUrl을 설정합니다."targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"빌드 리전이
us-east-2이면 다음과 같이 확장됩니다.https://aws.amazon.com/codebuild/<path to build>?region=us-east-2
- source/gitSubmodulesConfig
-
선택 사항입니다. Git 하위 모듈 구성에 대한 정보입니다. CodeCommit, GitHub, GitHub Enterprise Server 및 Bitbucket에서만 사용됩니다.
- source/gitSubmodulesConfig/fetchSubmodules
-
리포지토리에 Git 하위 모듈을 포함하려면
fetchSubmodules를true로 설정합니다. 포함된 Git 하위 모듈은 HTTPS로 구성해야 합니다.
- source/InsecureSsl
-
선택 사항입니다. GitHub Enterprise Server에서만 사용됩니다. GitHub Enterprise Server 프로젝트 리포지토리에 연결되어 있는 동안 TLS 경고를 무시하려면 이 값을
true로 설정합니다. 기본값은false입니다.InsecureSsl은 테스트 용도로만 사용해야 합니다. 프로덕션 환경에 사용하면 안 됩니다. - source/sourceIdentifier
-
프로젝트 소스의 사용자 정의 식별자입니다. 기본 소스의 경우 선택 사항입니다. 보조 소스에 필요합니다.
secondarySources
선택 사항입니다. 빌드 프로젝트의 보조 소스에 대한 정보가 들어 있는 ProjectSource 객체의 배열입니다. 보조 소스는 12개까지 추가할 수 있습니다. secondarySources 객체는 source 객체에서 사용하는 것과 동일한 속성을 사용합니다. 보조 소스 객체에는 sourceIdentifier가 필요합니다.
secondarySourceVersions
선택 사항입니다. ProjectSourceVersion 객체의 배열입니다. 빌드 레벨에서 secondarySourceVersions이 지정되어 있으면 그 버전이 이 버전보다 우선합니다.
sourceVersion
선택 사항입니다. 이 프로젝트에 대해 빌드할 빌드 입력의 버전입니다. 지정하지 않으면 최신 버전이 사용됩니다. 지정하면 다음 중 하나여야 합니다.
-
CodeCommit의 경우 사용할 커밋 ID, 분기 또는 Git 태그입니다.
-
GitHub의 경우, 빌드하려는 소스 코드의 버전에 해당하는 커밋 ID, 풀 요청 ID, 분기 이름 또는 태그 이름입니다. 풀 요청 ID가 지정된 경우
pr/pull-request-ID형식을 사용해야 합니다(예:pr/25). 분기 이름이 지정되어 있으면 분기의 HEAD 커밋 ID가 사용됩니다. 지정되지 않은 경우 기본 분기의 HEAD 커밋 ID가 사용됩니다. -
GitLab의 경우 커밋 ID, pull 요청 ID, 분기 이름, 태그 이름 또는 참조와 커밋 ID를 입력합니다. 자세한 내용은 AWS CodeBuild를 사용한 소스 버전 샘플 단원을 참조하십시오.
-
Bitbucket의 경우, 빌드하려는 소스 코드의 버전에 해당하는 커밋 ID, 분기 이름 또는 태그 이름입니다. 분기 이름이 지정되어 있으면 분기의 HEAD 커밋 ID가 사용됩니다. 지정되지 않은 경우 기본 분기의 HEAD 커밋 ID가 사용됩니다.
-
Amazon S3의 경우 사용할 빌드 입력 ZIP 파일을 나타내는 객체의 버전 ID입니다.
빌드 수준에서 sourceVersion이 지정되어 있으면 (프로젝트 수준에서) 그 버전이 이 sourceVersion보다 우선합니다. 자세한 내용은 AWS CodeBuild를 사용한 소스 버전 샘플 단원을 참조하십시오.
artifacts
필수 사항입니다. 이 빌드 프로젝트의 출력 아티팩트 설정에 대한 정보가 들어 있는 ProjectArtifacts 객체입니다. artifacts 객체를 추가한 후에는 secondaryArtifacts를 사용해 아티팩트를 최대 12개까지 더 추가할 수 있습니다. 이러한 설정에는 다음이 포함됩니다.
- artifacts/type
-
필수 사항입니다. 빌드 출력 결과물의 유형입니다. 유효한 값은 다음과 같습니다.
-
CODEPIPELINE -
NO_ARTIFACTS -
S3
-
- artifacts/location
-
S3아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.사전 요구 사항에서 생성했거나 식별한 출력 버킷의 이름입니다.
- artifacts/path
-
S3아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.ZIP 파일 또는 폴더를 배치할 출력 버킷의 경로입니다.
path의 값을 지정하지 않으면 CodeBuild가namespaceType(지정된 경우) 및name을 사용하여 빌드 출력 ZIP 파일이나 폴더의 경로 및 이름을 결정합니다. 예를 들어path에 대해MyPath,name에 대해MyArtifact.zip을 를 지정하면 경로와 이름은MyPath/MyArtifact.zip이 됩니다. - artifacts/namespaceType
-
S3아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.빌드 출력 ZIP 파일 또는 폴더의 네임스페이스입니다. 유효한 값에는
BUILD_ID및NONE(이)가 있습니다. 빌드 출력 ZIP 파일 또는 폴더의 경로에 빌드 ID를 삽입하려면BUILD_ID를 사용하고 그렇지 않은 경우NONE을 사용합니다.namespaceType의 값을 지정하지 않으면 CodeBuild가path(지정된 경우) 및name을 사용하여 빌드 출력 ZIP 파일이나 폴더의 경로 및 이름을 결정합니다. 예를 들어path에 대해MyPath,namespaceType에 대해BUILD_ID,name에 대해MyArtifact.zip을 지정하면 경로와 이름은MyPath/이 됩니다.build-ID/MyArtifact.zip - artifacts/name
-
S3아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.location안에 있는 빌드 출력 ZIP 파일 또는 폴더의 경로 및 이름입니다. 예를 들어path에 대해MyPath,name에 대해MyArtifact.zip을 를 지정하면 경로와 이름은MyPath/MyArtifact.zip이 됩니다. - artifacts/overrideArtifactName
-
S3 아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.
선택 사항입니다.
true로 설정할 경우 buildspec 파일의artifacts블록에서 지정한 이름이name을 재정의합니다. 자세한 내용은 CodeBuild의 빌드 사양 참조 단원을 참조하십시오. - artifacts/packaging
-
S3아티팩트 유형에만 사용됩니다. 다른 아티팩트 유형에는 사용되지 않습니다.선택 사항입니다. 아티팩트를 패키징하는 방법을 지정합니다. 허용되는 값:
- NONE
-
빌드 아티팩트가 포함된 폴더를 생성합니다. 이것이 기본값입니다.
- ZIP
-
빌드 아티팩트가 포함된 ZIP 파일을 생성합니다.
secondaryArtifacts
선택 사항입니다. 빌드 프로젝트의 보조 아티팩트 설정에 대한 정보가 들어 있는 ProjectArtifacts 객체의 배열입니다. 보조 아티팩트는 최대 12개까지 추가할 수 있습니다. secondaryArtifacts는 artifacts 객체에서 사용하는 것과 동일한 수의 설정을 사용합니다.
cache
필수 사항입니다. 이 빌드 프로젝트의 캐시 설정에 대한 정보가 들어 있는 ProjectCache 객체입니다. 자세한 내용은 캐시 빌드 단원을 참조하십시오.
환경
필수 사항입니다. 이 프로젝트의 빌드 환경 설정에 대한 정보가 들어 있는 ProjectEnvironment 객체입니다. 이러한 설정은 다음과 같습니다.
- environment/type
-
필수 사항입니다. 빌드 환경의 유형입니다. 자세한 내용은 CodeBuild API 참조의 유형을 참조하세요.
- environment/image
-
필수 사항입니다. 이 빌드 환경에서 사용하는 도커 이미지 식별자입니다. 일반적으로 이 식별자는
image-name:tag로 표현됩니다. 예를 들어 CodeBuild가 도커 이미지를 관리하는 데 사용하는 Docker 리포지토리에서 이 값은aws/codebuild/standard:5.0이 될 수 있습니다. Docker Hub에서는maven:3.3.9-jdk-8입니다. Amazon ECR에서는account-id.dkr.ecr.region-id.amazonaws.com/your-Amazon-ECR-repo-name:tag - environment/computeType
-
필수 사항입니다. 이 빌드 환경에서 사용하는 컴퓨팅 리소스를 지정합니다. 자세한 내용은 CodeBuild API 참조의 computeType을 참조하세요.
- environment/certificate
-
선택 사항입니다. PEM 인코딩된 인증서를 포함하는 Amazon S3 버킷, 경로 접두사 및 객체 키의 ARN입니다. 객체 키는 단지 .pem 파일일 수도 있고 PEM 인코딩된 인증서를 포함하는 .zip 파일일 수도 있습니다. 예를 들어 Amazon S3 버킷 이름이
<my-bucket><cert><certificate.pem>certificate에 허용되는 형식은<my-bucket/cert/certificate.pem>arn:aws:s3:::입니다.<my-bucket/cert/certificate.pem> - environment/environmentVariables
-
선택 사항입니다. 이 빌드 환경에 지정하려는 환경 변수를 포함하는 EnvironmentVariable 객체의 배열입니다. 각 환경 변수는
name,value,type의name,value,type을 포함하는 객체로 표현됩니다.콘솔 및 AWS CLI 사용자는 환경 변수를 확인할 수 있습니다. 환경 변수의 가시성에 대한 문제가 없으면
name및value를 설정하고type을PLAINTEXT로 설정합니다.AWS 액세스 키 ID, AWS 비밀 액세스 키 또는 암호와 같은 중요한 값을 가진 환경 변수를 Amazon EC2 Systems Manager Parameter Store 또는 AWS Secrets Manager에 파라미터로 저장하는 것이 좋습니다.
name의 저장된 파라미터의 경우 CodeBuild가 참조할 식별자를 설정합니다.Amazon EC2 Systems Manager Parameter Store를 사용하는 경우,
value에 대해 파라미터 이름을 Parameter Store에 저장된 것으로 설정합니다.type를PARAMETER_STORE으로 설정합니다. 이름이/CodeBuild/dockerLoginPassword인 파라미터를 예제로 사용하여name을LOGIN_PASSWORD로 설정합니다.value을/CodeBuild/dockerLoginPassword으로 설정합니다.type를PARAMETER_STORE로 설정합니다.중요
Amazon EC2 Systems Manager Parameter Store를 사용하는 경우
/CodeBuild/로 시작하는 파라미터 이름(예:/CodeBuild/dockerLoginPassword)으로 파라미터를 저장하는 것이 좋습니다. CodeBuild 콘솔을 사용하여 Amazon EC2 Systems Manager에서 파라미터를 생성할 수 있습니다. 파라미터 생성을 선택하고 대화 상자에 표시되는 지시에 따릅니다. 대화 상자의 KMS 키에 해당 계정의 AWS KMS 키에 대한 ARN을 지정할 수 있습니다. Amazon EC2 Systems Manager는 이 키를 사용하여 저장 시 파라미터의 값을 암호화하고 검색 시 암호를 해독합니다. CodeBuild 콘솔을 사용하여 파라미터를 생성하는 경우 콘솔은 이름이/CodeBuild/인 파라미터가 저장되면 시작합니다. 자세한 내용은 Amazon EC2 Systems Manager 사용 설명서의 Systems Manager Parameter Store 및 Systems Manager Parameter Store 콘솔 연습을 참조하세요.빌드 프로젝트가 Amazon EC2 Systems Manager Parameter Store에 저장된 파라미터를 참조하는 경우 해당 빌드 프로젝트의 서비스 역할은
ssm:GetParameters작업을 허용해야 합니다. 앞에서 새 서비스 역할을 선택한 경우에는 CodeBuild는 빌드 프로젝트의 기본 서비스 역할에 이 작업을 포함합니다. Existing service role(기존 서비스 역할)을 선택한 경우에는 이 작업을 서비스 역할에 별도로 포함해야 합니다.빌드 프로젝트가
/CodeBuild/로 시작되지 않는 파라미터 이름으로 Amazon EC2 Systems Manager Parameter Store에 저장된 파라미터를 참조하는 경우 새 서비스 역할을 선택하면/CodeBuild/로 시작하지 않는 파라미터 이름에 액세스할 수 있도록 해당 서비스 역할을 업데이트해야 합니다. 이는 서비스 역할이/CodeBuild/로 시작하는 파라미터 이름에만 액세스할 수 있기 때문입니다.새 서비스 역할을 선택하면 Amazon EC2 Systems Manager Parameter Store에 있는
/CodeBuild/네임스페이스의 모든 파라미터를 해독할 권한이 서비스 역할에 포함됩니다.사용자가 설정한 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 도커 이미지에 값이
my_value인MY_VAR이라는 환경 변수가 이미 포함되어 있는데, 사용자가MY_VAR환경 변수의 값을other_value로 설정하면,my_value가other_value로 바뀝니다. 마찬가지로, 도커 이미지에 값이/usr/local/sbin:/usr/local/bin인PATH라는 환경 변수가 이미 포함되어 있는데, 사용자가PATH환경 변수의 값을$PATH:/usr/share/ant/bin으로 설정하면,/usr/local/sbin:/usr/local/bin이$PATH:/usr/share/ant/bin리터럴 값으로 바뀝니다.CODEBUILD_로 시작하는 이름으로 환경 변수를 설정하지 마십시오. 이 접두사는 내부 전용으로 예약되어 있습니다.여러 위치에서 동일한 이름의 환경 변수가 정의되는 경우, 다음과 같이 값이 결정됩니다.
-
시작 빌드 작업 호출의 값이 가장 높은 우선 순위를 갖습니다.
-
빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다.
-
buildspec 선언의 값이 가장 낮은 우선 순위를 갖습니다.
Secrets Manager를
value사용하는 경우 파라미터 이름을 Secrets Manager에 저장된 항목으로 설정합니다.type를SECRETS_MANAGER으로 설정합니다. 이름이/CodeBuild/dockerLoginPassword인 보안 암호를 예제로 사용하여name을LOGIN_PASSWORD로 설정합니다.value을/CodeBuild/dockerLoginPassword으로 설정합니다.type를SECRETS_MANAGER로 설정합니다.중요
Secrets Manager를 사용하는 경우 이름이
/CodeBuild/로 시작하는 암호를 저장하는 것이 좋습니다(예:/CodeBuild/dockerLoginPassword). 자세한 내용은 AWS Secrets Manager 사용 설명서의 AWS Secrets Manager이란? 섹션을 참조하세요.빌드 프로젝트가 Secrets Manager에 저장된 암호를 참조하는 경우 해당 빌드 프로젝트의 서비스 역할은
secretsmanager:GetSecretValue작업을 허용해야 합니다. 앞에서 새 서비스 역할을 선택한 경우에는 CodeBuild는 빌드 프로젝트의 기본 서비스 역할에 이 작업을 포함합니다. Existing service role(기존 서비스 역할)을 선택한 경우에는 이 작업을 서비스 역할에 별도로 포함해야 합니다.빌드 프로젝트가
/CodeBuild/로 시작되지 않는 보안 암호 이름으로 Secrets Manager에 저장된 암호를 참조하는 경우 새 서비스 역할을 선택하면/CodeBuild/로 시작하지 않는 보안 암호 이름에 액세스할 수 있도록 해당 서비스 역할을 업데이트해야 합니다. 이는 서비스 역할이/CodeBuild/로 시작하는 암호 이름에만 액세스할 수 있기 때문입니다.새 서비스 역할을 선택하면 에 있는
/CodeBuild/네임스페이스의 모든 암호를 해독할 권한이 서비스 역할에 포함됩니다. -
- environment/registryCredential
-
선택 사항입니다. 프라이빗 Docker 레지스트리에 대한 액세스를 제공하는 보안 인증을 지정하는 RegistryCredential 객체입니다.
- environment/registryCredential/credential
-
AWS Managed Services를 사용하여 생성한 보안 인증의 ARN 또는 이름을 지정합니다. 현재 리전에 있는 자격 증명의 이름만 사용할 수 있습니다.
- environment/registryCredential/credentialProvider
-
유일한 유효 값은
SECRETS_MANAGER입니다.
이를 설정할 경우 다음과 같이 해야 합니다.
-
imagePullCredentials를SERVICE_ROLE로 설정해야 합니다. -
이 이미지는 큐레이트된 이미지 또는 Amazon ECR 이미지일 수 없습니다.
- environment/imagePullCredentialsType
-
선택 사항입니다. CodeBuild가 빌드에 이미지를 가져올 때 사용하는 보안 인증 유형입니다. 두 가지 값을 사용할 수 있습니다.
- CODEBUILD
-
CODEBUILD는 CodeBuild가 자체 보안 인증을 사용하도록 지정합니다. CodeBuild 서비스 보안 주체를 신뢰하려면 Amazon ECR 리포지토리 정책을 편집해야 합니다. - SERVICE_ROLE
-
CodeBuild가 해당 빌드 프로젝트의 서비스 역할을 사용하도록 지정합니다.
교차 계정 또는 프라이빗 레지스트리 이미지를 사용할 경우
SERVICE_ROLE자격 증명을 사용해야 합니다. CodeBuild 큐레이트 이미지를 사용할 경우CODEBUILD보안 인증을 사용해야 합니다. - environment/privilegedMode
-
이 빌드 프로젝트를 사용하여 도커 이미지를 빌드하려는 경우에만
true로 설정합니다. 그렇지 않으면 Docker 데몬과 상호 작용을 시도하는 모든 연결된 빌드가 실패합니다. 또한 빌드가 상호 작용할 수 있도록 Docker 데몬을 시작해야 합니다. 이를 수행하는 한 가지 방법은 다음 빌드 명령을 실행하여 buildspec 파일의install단계에서 Docker 데몬을 초기화하는 것입니다. 지정한 빌드 환경 이미지가 Docker 지원을 통해 CodeBuild에서 제공하지 않은 경우 이 명령을 실행하지 마세요.참고
기본적으로 비 VPC 빌드에는 Docker 데몬이 활성화됩니다. VPC 빌드에 Docker 컨테이너를 사용하려면 Docker Docs 웹 사이트의 런타임 권한 및 Linux 기능
을 참조하고 권한 부여 모드를 활성화합니다. 또한 Windows는 권한 모드를 지원하지 않습니다. - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://127.0.0.1:2375 --storage-driver=overlay2 & - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
serviceRole
필수 사항입니다. CodeBuild가 사용자 대신 서비스와 상호 작용하기 위해 사용하는 서비스 역할의 ARN입니다(예: arn:aws:iam::).account-id:role/role-name
autoRetryLimit
선택 사항입니다. 빌드 실패 후 추가 자동 재시도 횟수입니다. 예를 들어 자동 재시도 제한이 2로 설정된 경우 CodeBuild는 RetryBuild API를 호출하여 빌드를 추가로 최대 2회 자동 재시도합니다.
timeoutInMinutes
선택 사항입니다. 빌드가 완료되지 않는 경우 CodeBuild가 해당 빌드를 중지하는 시간(5분에서 2160분(36시간) 사이)입니다. 지정하지 않을 경우 기본값인 60을 사용합니다. 시간 제한으로 인해 CodeBuild가 빌드를 중지했는지 및 중지한 시간을 확인하려면 batch-get-builds 명령을 실행합니다. 빌드가 중지되었는지 확인하려면 출력에서 FAILED의 buildStatus 값을 살펴봅니다. 빌드가 시간 초과된 시간을 확인하려면 출력에서 TIMED_OUT의 phaseStatus와 연결된 endTime 값을 살펴봅니다.
queuedTimeoutInMinutes
선택 사항입니다. 빌드가 완료되지 않는 경우 CodeBuild가 해당 빌드를 중지하는 시간(5분에서 480분(8시간) 사이)입니다. 지정하지 않을 경우 기본값인 60을 사용합니다.
encryptionKey
선택 사항입니다. CodeBuild에서 빌드 출력을 암호화하는 데 사용하는 AWS KMS key의 별칭 또는 ARN입니다. 별칭을 지정하는 경우 arn:aws:kms: 형식을 사용하고, 별칭이 있는 경우 region-ID:account-ID:key/key-IDalias/ 형식을 사용합니다. 지정하지 않으면 Amazon S3의 AWS 관리형 KMS 키가 사용됩니다.key-alias
tags
선택 사항입니다. 이 빌드 프로젝트와 연결할 태그를 제공하는 Tag 객체 배열입니다. 최대 50개의 태그를 지정할 수 있습니다. 이러한 태그는 CodeBuild 빌드 프로젝트 태그를 지원하는 AWS 서비스가 사용할 수 있습니다. 각 태그는 key와 value가 있는 객체로 표현됩니다.
vpcConfig
선택 사항입니다. 프로젝트의 VPC 구성에 대한 정보가 들어 있는 VpcConfig 객체입니다. 자세한 내용은 Amazon Virtual Private Cloud에서 AWS CodeBuild 사용 단원을 참조하십시오.
이러한 속성은 다음과 같습니다.
- vpcId
-
필수 사항입니다. CodeBuild가 사용하는 VPC ID입니다. 리전의 모든 VPC ID 목록을 가져오려면 다음 명령을 실행합니다.
aws ec2 describe-vpcs --region<region-ID> - subnets
-
필수 사항입니다. CodeBuild에서 사용되는 리소스가 포함된 서브넷 ID의 배열입니다. 이 ID를 얻으려면 다음 명령을 실행합니다.
aws ec2 describe-subnets --filters "Name=vpc-id,Values=<vpc-id>" --region<region-ID> - securityGroupIds
-
필수 사항입니다. CodeBuild가 VPC의 리소스에 대한 액세스를 허용하기 위해 사용하는 보안 그룹 ID 배열입니다. 이 ID를 얻으려면 다음 명령을 실행합니다.
aws ec2 describe-security-groups --filters "Name=vpc-id,Values=<vpc-id>" --<region-ID>
badgeEnabled
선택 사항입니다. CodeBuild 프로젝트에 빌드 배지를 포함할지 여부를 지정합니다. 빌드 배지를 활성화하려면 true로 설정하고, 그렇지 않으면 false로 설정합니다. 자세한 내용은 CodeBuild의 빌드 배지 샘플 단원을 참조하십시오.
logsConfig
이 빌드의 로그가 있는 위치에 대한 정보가 들어 있는 LogsConfig 객체입니다.
- logsConfig/cloudWatchLogs
-
로그를 CloudWatch Logs로 푸시하는 것과 관련된 정보가 들어 있는 CloudWatchLogsConfig 객체입니다.
- logsConfig/s3Logs
-
로그를 Amazon S3로 푸시하는 방법에 대한 정보가 들어 있는 S3LogsConfig 객체입니다.
fileSystemLocations
선택 사항입니다. Amazon EFS 구성에 대한 정보가 들어 있는 ProjectFileSystemsLocation 객체의 배열입니다.
buildBatchConfig
선택 사항입니다. buildBatchConfig 객체는 프로젝트에 대한 배치 빌드 구성 정보를 포함하는 ProjectBuildBatchConfig 구조입니다.
- buildBatchConfig/serviceRole
-
배치 빌드 프로젝트에 대한 서비스 역할 ARN입니다.
- buildBatchConfig/combineArtifacts
-
배치 빌드의 빌드 아티팩트를 단일 아티팩트 위치로 결합할지 여부를 지정하는 부울 값입니다.
- buildBatchConfig/restrictions/maximumBuildsAllowed
-
허용되는 최대 빌드 수입니다.
- buildBatchConfig/restrictions/computeTypesAllowed
-
배치 빌드에 허용되는 컴퓨팅 유형을 지정하는 문자열 배열입니다. 이러한 값은 빌드 환경 컴퓨팅 유형를 참조하세요.
- buildBatchConfig/timeoutInMinutes
-
배치 빌드를 완료해야 하는 최대 시간(분)입니다.
- buildBatchConfig/batchReportMode
-
배치 빌드를 위해 빌드 상태 보고서를 소스 제공자에게 보내는 방법을 지정합니다. 유효한 값으로는 다음이 포함됩니다.
REPORT_AGGREGATED_BATCH-
(기본값) 모든 빌드 상태를 단일 상태 보고서로 집계합니다.
REPORT_INDIVIDUAL_BUILDS-
각 개별 빌드에 대해 별도의 상태 보고서를 보냅니다.
concurrentBuildLimit
이 프로젝트에 허용된 최대 동시 실행 빌드 수입니다.
현재 빌드 수가 이 한도 이하인 경우에만 새 빌드가 시작됩니다. 현재 빌드 수가 이 한도에 도달하면 새 빌드가 제한되고 실행되지 않습니다.
프로젝트 생성
프로젝트를 생성하려면 JSON 파일을 전달하여 create-project 명령을 다시 실행합니다.
aws codebuild create-project --cli-input-json file://<json-file>
성공하면 Project 객체의 JSON 표현이 콘솔 출력에 나타납니다. 이 데이터의 예는 CreateProject 응답 구문을 참조하세요.
빌드 프로젝트 이름을 제외한 모든 빌드 프로젝트 설정은 나중에 변경할 수 있습니다. 자세한 내용은 빌드 프로젝트 설정 변경(AWS CLI) 단원을 참조하십시오.
빌드 실행을 시작하려면 빌드 실행(AWS CLI) 단원을 참조하십시오.
소스 코드가 GitHub 리포지토리에 저장되고 코드 변경이 리포지토리로 푸시될 때마다 CodeBuild가 자동으로 소스 코드를 다시 빌드하게 하려면 빌드 실행 자동 시작(AWS CLI) 섹션을 참조하세요.
빌드 프로젝트 생성(AWS SDK)
AWS CodeBuild를 AWS SDK와 함께 사용하는 방법에 대한 자세한 정보는 AWS SDK 및 도구 참조 단원을 참조하십시오.
빌드 프로젝트 생성(AWS CloudFormation)
AWS CloudFormation에서 AWS CodeBuild를 사용하는 방법에 대한 자세한 내용은 AWS CloudFormation 사용 설명서의 CodeBuild용 AWS CloudFormation 템플릿을 참조하세요.
