Terraform 배포를 위한 VM 이미지 구성

이 문서에서는 Terraform을 사용해서 배포를 수행하기 위해 구성을 마치고 VM 이미지를 제출하는 방법을 설명합니다.

배포 패키지를 만드는 방법 결정

Producer Portal의 가이드 방식 구성 옵션을 사용하여 Google Cloud 콘솔에서 직접 배포 패키지를 만드는 것이 좋습니다.

가이드 방식 구성 옵션은 기본 방화벽 규칙을 사용한 단일 VM 배포와 같은 간단한 VM 제품을 지원하지만 여러 VM 및 컴퓨팅 외 리소스가 포함된 배포와 같은 일부 복잡한 기능은 지원하지 않습니다. 가이드 방식 구성에서 지원하지 않는 기능이 필요한 경우 수동 구성 옵션을 사용하여 배포 패키지를 만들거나 추가 기능을 통해 기존 패키지를 맞춤 설정할 수 있습니다.

가이드 방식 구성 및 수동 구성 간 전환

Producer Portal의 가이드 방식 구성 옵션을 사용하고 나중에 수동 배포 패키지 구성으로 전환하려면 수동 구성으로 이동을 클릭합니다.

가이드 방식 구성 완료

Google Cloud 콘솔을 사용해서 구성을 완료하고 간단한 배포 패키지를 제출하려면 다음 단계를 완료합니다.

  1. Producer Portal에서 배포 패키지 섹션으로 이동합니다.

  2. Terraform 구성에서 Cloud Storage 버킷 라벨이 지정된 입력 필드 옆에 있는 찾아보기를 클릭합니다.

    Cloud Storage 버킷을 이미 만들었으면 여기에서 선택합니다.

    Cloud Storage 버킷이 없으면 라벨이 새 버킷 만들기로 표시된 아이콘을 클릭합니다. 새 버킷을 만들 때는 다음을 수행합니다.

    • 버킷 이름을 선택합니다.

    • 버킷에서 데이터를 저장하는 리전을 지정합니다.

    • 데이터의 스토리지 클래스를 지정합니다.

    • 버킷 데이터의 Identity and Access Management(IAM) 권한에 적용할 세부사항 수준을 결정합니다.

    • 암호화 또는 데이터 보관 정책과 같은 선택적 고급 설정을 구성합니다.

  3. Cloud Storage 버킷에 대해 객체 버전 관리를 사용 설정합니다.

  4. 버킷 설정을 저장하고 배포 패키지 구성을 계속하려면 구성을 클릭합니다.

  5. 머신 유형 선택에서 VM 제품의 기본 영역, 최소 머신 유형기본 머신 유형을 부팅 디스크의 크기 및 유형과 함께 지정해야 합니다.

  6. 운영체제 지정에서 VM 이미지가 사용하는 OS의 이름 및 버전과 함께 VM 이미지의 버전 번호를 지정해야 합니다.

  7. 원하는 경우 VM 액세스 설정에서 사용자가 배포 후 VM에 액세스하는 데 사용할 수 있는 사용자 이름 및 비밀번호와 함께 사이트 및 관리자 URL을 지정할 수 있습니다.

  8. 원하는 경우 네트워킹 구성에서 IP 전달 설정을 지정하고 방화벽 규칙을 구성할 수 있습니다.

  9. 원하는 경우 다음 단계 정의에서 제품 사용자에게 제품 시작에 대한 가이드를 제공할 수 있습니다. 이러한 안내는 제품을 배포한 후에 표시됩니다.

  10. 이전 단계를 완료한 후 생성을 클릭하여 배포 패키지를 만듭니다.

    나중에 추가로 배포 패키지를 변경해야 할 경우 수정을 클릭하여 변경한 다음 생성을 클릭하여 해당 변경 사항이 적용된 배포 패키지를 다시 생성할 수 있습니다.

  11. Producer Portal에서 배포 패키지를 검증합니다.

  12. 배포 패키지에 대한 Cloud Marketplace 검증이 성공적으로 완료되면 게시를 클릭하여 배포 패키지 테스트를 시작합니다.

수동 구성 완료

이 섹션에서는 수동 구성 옵션을 사용하여 배포 패키지를 만들고 검토를 위해 제출하는 방법을 설명합니다.

기본 또는 커스텀 Terraform 모듈을 사용하도록 지정

고객이 제품을 배포할 때 기본 또는 커스텀 Terraform 모듈을 사용하도록 선택할 수 있습니다.

기본 Terraform 모듈을 사용하도록 선택하면 Google Cloud에서 고객이 제품 배포에 사용할 수 있는 자동 생성된 Terraform 코드가 고객에게 제공됩니다.

커스텀 Terraform 모듈을 사용하도록 선택하면 자체 Terraform 템플릿을 고객에게 제공해야 합니다. 명령줄 인터페이스(CLI)를 사용하거나 고객이 Cloud Marketplace에서 직접 모듈을 배포할 수 있게 해주는 추가 메타데이터를 사용해서 고객이 배포할 수 있는 양식으로 이러한 템플릿을 제공하도록 선택할 수 있습니다.

고객이 기본 또는 커스텀 Terraform 모듈을 사용하도록 지정하고 커스텀 Terraform 모듈의 경우 고객의 모듈 배포 방법을 지정하려면 다음 단계를 완료합니다.

  1. Producer Portal에서 배포 패키지 섹션으로 이동합니다.

  2. Terraform 구성유형 아래에서 기본값, 커스텀(CLI 배포), 커스텀(UI 배포)를 선택합니다.

커스텀 Terraform 모듈의 요구사항

커스텀 Terraform 모듈을 사용하도록 선택할 경우 커스텀 모듈이 다음 요구사항을 충족해야 합니다.

  • 커스텀 모듈에는 Cloud Marketplace에서 요구사항 충족 여부를 확인하기 위해 사용할 수 있는 모듈이 포함되어야 합니다. 자세한 내용은 모듈의 인증 통과 테스트를 참조하세요.

  • 모듈에는 고객이 모듈을 배포하는 데 사용하는 프로젝트 ID를 저장하는 project_id라는 변수가 있어야 합니다.

  • 이미지 이름에 대한 참조를 projects/PROJECT_NAME/global/images/IMAGE_NAME 형식의 Terraform 변수로 지정해야 합니다. default의 값은 VM 이미지의 이름으로 설정해야 하며, 그러면 VM 제품이 게시될 때 Cloud Marketplace 소유의 이미지 사본이 모듈로 대체될 수 있습니다.

  • 모듈이 함께 패키징되지 않은 외부 모듈에 종속되면 안 됩니다.

  • 모듈은 다음과 같은 승인된 제공업체만 사용해야 합니다.

    • archive
    • cloud-init
    • dns
    • google
    • google-beta
    • http
    • null
    • random
    • time
    • tls

이러한 요구사항을 준수하는 커스텀 모듈의 예시를 보려면 샘플 커스텀 Terraform 모듈을 참조하세요.

UI 배포를 위한 커스텀 Terraform 모듈의 추가 요구사항

커스텀 모듈이 UI 배포를 지원하는 경우 다음과 같은 추가 요구사항을 충족해야 합니다.

  • 모듈에는 goog_cm_deployment_name이라는 변수가 포함되어야 합니다. Cloud Marketplace는 이 변수를 사용해서 배포 페이지 내에서 고객의 배포 이름을 지정합니다. 한 프로젝트에서 여러 배포 사이에 리소스 이름 충돌을 방지하려면 이 변수를 사용해야 합니다. 예를 들어 샘플 커스텀 Terraform 모듈에서 goog_cm_deployment_name을 참조하세요.

  • metadata.display.yaml 파일에서 ET_GCE_DISK_IMAGE를 모든 이미지 변수의 xGoogleProperty 유형으로 지정해야 합니다. 예를 들어 샘플 커스텀 Terraform 모듈에서 metadata.display.yaml을 참조하세요.

  • 제품에 다중 VM 이미지 또는 다중 CPU 아키텍처를 지원하는 이미지가 포함된 경우 고객이 사용하려는 VM 이미지를 선택할 수 있도록 enumValueLabels를 추가해야 합니다. 예를 들어 샘플 커스텀 Terraform 모듈을 참조하세요.

  • 모듈은 Terraform 프로비저닝 도구 지원에 의존하지 않아야 합니다.

커스텀 Terraform 모듈의 추가 단계

커스텀 Terraform 모듈을 사용하도록 선택했으면 다음 추가 단계를 완료해서 배포할 VM 이미지를 구성해야 합니다.

  1. Producer Portal에서 배포 패키지 섹션으로 이동합니다.

  2. Terraform 구성이미지 변수 아래에서 변수 추가를 클릭합니다.

    제품의 Terraform 배포를 사용 설정하려면 Marketplace 소유 이미지를 사용하도록 설정한 상태여야 합니다. Cloud Marketplace는 여기에 추가된 변수를 사용해서 고객이 제품을 배포할 때 VM 이미지를 Marketplace 소유 버전으로 바꿉니다.

  3. 이미지 변수 텍스트 필드에서 'image'와 같은 변수 이름을 입력합니다.

  4. 커스텀 Terraform 모듈에서 이전 단계에서 만든 변수의 기본값을 제품의 VM 이미지 이름(projects/YOUR_PROJECT/global/images/YOUR_IMAGE 형식)으로 설정합니다.

  5. GCS 객체 위치 지정 아래에서 찾아보기를 클릭합니다.

    Cloud Storage 버킷을 이미 만들었으면 여기에서 선택합니다.

    Cloud Storage 버킷이 없으면 라벨이 새 버킷 만들기로 표시된 아이콘을 클릭합니다. 새 버킷을 만들 때는 다음을 수행합니다.

    • 버킷 이름을 선택합니다.

    • 버킷에서 데이터를 저장하는 리전을 지정합니다.

    • 데이터의 스토리지 클래스를 지정합니다.

    • 버킷 데이터의 Identity and Access Management(IAM) 권한에 적용할 세부사항 수준을 결정합니다.

    • 암호화 또는 데이터 보관 정책과 같은 선택적 고급 설정을 구성합니다.

  6. Cloud Storage 버킷에서 객체 버전 관리가 사용 설정되어 있는지 확인합니다.

  7. 버킷 설정을 저장하고 배포 패키지 구성을 계속하려면 구성을 클릭합니다.

  8. 필요한 역할에서 고객이 제품을 배포하는 데 필요한 IAM 역할을 지정합니다.

(UI 배포만 해당) 커스텀 Terraform 모듈의 메타데이터 만들기

커스텀 모듈이 UI 배포를 지원하도록 하려면 Cloud Marketplace가 모듈을 올바르게 파싱하고 고객을 위해 UI에서 렌더링하기 위해 사용하는 메타데이터를 만들고 추가해야 합니다.

이 메타데이터를 만들고 추가하려면 오픈소스 CFT CLI 도구를 사용하면 됩니다. CFT를 사용해서 메타데이터를 만들고 커스텀 모듈에 추가하려면 다음 단계를 완료합니다.

  1. CFT CLI 도구를 설치합니다. 자세한 내용은 CFT CLI 문서를 참조하세요. VERSION 값을 latest로 지정하고 PLATFORM을 다음 값 중 하나로 설정하는 것이 좋습니다.

    • linux

    • windows

    • darwin

  2. 다음 명령어를 실행합니다.

     cft blueprint metadata -p TF_PACKAGE_PATH -q -d --nested=false
    

    이전 명령어에서 -p 플래그는 Terraform 패키지의 경로를 제공하고, -q 플래그는 원격 저장소에 대한 정보 요구 없이 메타데이터를 생성하고, -d 플래그는 metadata.display.yaml 파일을 생성하고, --nested=false 플래그는 루트 모듈에 대한 메타데이터를 생성하고 modules/ 폴더의 모듈은 건너뜁니다.

이전 단계를 완료하면 CFT CLI 도구가 metadata.yamlmetadata.display.yaml의 두 가지 새 파일을 생성합니다.

커스텀 Terraform 모듈의 메타데이터 맞춤설정

Cloud Marketplace는 metadata.display.yaml 파일을 사용해서 고객이 UI를 통해 제품을 배포하기 위해 사용하는 양식을 맞춤설정합니다. 이 양식을 맞춤설정하려면 메타데이터를 만든 후 metadata.display.yaml에서 필드 값을 수정할 수 있습니다. 사용 가능한 맞춤설정 옵션에 대한 자세한 내용은 오픈소스 BlueprintUI 문서 또는 BlueprintUI 스키마를 참조하세요.

메타데이터를 수정하려면 GooglePropertyExtensions 확장 프로그램을 사용하는 것이 좋습니다. GooglePropertyExtensions에서는 고객이 프로젝트에 이미 있는 Virtual Private Cloud(VPC) 네트워크만 선택할 수 있도록 강제하는 것과 같은 Google Cloud 관련 검증을 사용할 수 있습니다. 예를 들어 샘플 커스텀 Terraform 모듈을 참조하세요.

커스텀 모듈의 메타데이터 검증

커스텀 모듈의 메타데이터를 검증하려면 다음 명령어를 실행합니다.

cft blueprint metadata -p TF_PACKAGE_PATH -v

이전 명령어에서 -p 플래그는 Terraform 패키지의 경로를 제공하고, -v 플래그는 BlueprintMetadata 스키마에 따라 제공된 경로의 모든 메타데이터 파일을 검증합니다.

모듈의 인증 통과 테스트

다음 명령어가 성공적으로 실행되면 커스텀 모듈이 인증을 통과합니다.

terraform plan -var project_id=YOUR_PROJECT -var-file marketplace_test.tfvars

이전 명령어에서 marketplace_test.tfvars는 Cloud Marketplace에서 이러한 모듈 인증을 위해서만 사용되는 Terraform 변수 파일입니다. 템플릿에 기본값이 없는 변수를 선언하고 이러한 변수의 값을 설정하지 않으면 명령어가 성공적으로 실행되지 않습니다. 명령어가 성공적으로 실행되도록 하려면 템플릿에 선언되는 변수에 대해 값을 설정하도록 marketplace_test.tfvars 파일을 만들 수 있습니다. marketplace_test.tfvars 파일 예시는 샘플 커스텀 Terraform 모듈을 참조하세요.

(선택사항)(CLI 배포만 해당) 테스트 모듈 포함

선택적으로 커스텀 모듈에서 CLI 배포가 지원되는 경우 examples/marketplace_test라는 폴더를 포함하도록 선택할 수 있습니다. 제품에 기능 확인을 위해 별개의 테스트 모듈을 포함해야 하는 경우 이를 수행해야 할 수 있습니다. 이 폴더를 포함할 경우 모듈이 인증을 통과하려면 다음 명령어가 성공적으로 실행되어야 합니다.

terraform -chdir=examples/marketplace_test plan -var project_id=YOUR_PROJECT

배포 검증 및 테스트

배포 패키지를 만들고 구성한 후에는 Cloud Marketplace 팀에서 검토 및 승인하기 전에 패키지를 검증하고 테스트해야 합니다.

  1. Producer Portal에서 배포 패키지 섹션으로 이동합니다.

  2. 검증을 클릭합니다. 검증 프로세스를 완료하는 데 최대 2시간이 걸릴 수 있으며 실행 중에 화면을 종료할 수 있습니다.

  3. 검증이 성공적으로 완료된 후 배포 미리보기를 클릭하여 배포를 테스트합니다.

다음 단계

배포를 성공적으로 검증하고 테스트한 후에는 게시를 클릭하여 전체 제품을 제출하여 검토하고 Cloud Marketplace에 게시할 수 있습니다. 자세한 내용은 제품 제출하기를 참조하세요.