HCP Waypoint 애드온 정의 생성 및 관리

이 페이지는 HCP Waypoint 애드온 정의를 생성, 편집, 삭제하는 방법을 설명해요. 플랫폼 엔지니어가 자주 수행하는 작업이에요. 추가 정보는 애드온 문서를 참고해 주세요.

출처: 문서

본문

개요

다음 단계는 애드온 정의를 만드는 절차를 설명해요:

만들려는 각 애드온에 대해, HCP Terraform에서 공통 인프라 패턴을 지정하는 no-code 모듈을 정의해요.
HCP Waypoint UI를 사용해 애드온을 만들어요.

애드온을 만든 후에는 애플리케이션 개발자가 애드온을 설치해 애플리케이션에 추가 기능을 더할 수 있어요.

사전 요구사항

HCP Waypoint가 활성화된 HCP 계정. 계정 생성 방법은 HCP 계정 문서를 참고해 주세요.
Standard 에디션의 HCP Terraform 조직. HCP Terraform은 HCP Terraform no-code 모듈과 프라이빗 모듈 레지스트리를 사용하려면 Standard 에디션이어야 해요.

no-code 모듈 만들기

애드온 정의를 만들려면 먼저 공통 인프라 패턴을 담은 no-code 모듈을 만들어야 해요. no-code 모듈을 만드는 방법은 No-Code 모듈 설계를 참고해 주세요.

애플리케이션 개발자가 애드온을 사용할 때 HCP Waypoint가 값을 정의하므로, 모듈에서 다음 변수를 참조할 수 있어요.

waypoint_add_on: 애드온의 이름을 참조해요.
waypoint_add_on_definition: 애드온을 만드는 데 사용된 애드온 정의의 이름을 참조해요.
waypoint_application: 앱 개발자가 애드온을 설치하는 대상 애플리케이션의 이름을 참조해요.

Terraform에서 변수를 정의하는 방법은 입력 변수를 참고해 주세요.

no-code 모듈이 클라우드 프로바이더에 인증하고 상호작용할 수 있도록 HCP Terraform 조직 내에 전역 변수 집합(global variable sets)을 만들어야 할 수도 있어요.

변수를 사용해 no-code 모듈의 인프라 리소스에 라벨을 붙여 HCP Waypoint 애플리케이션과 연결할 수 있어요.

애드온 정의 만들기

no-code 모듈을 만든 후 HCP Waypoint UI에서 다음 단계를 완료해 주세요:

HCP 포털에 로그인하고 Services 메뉴에서 Waypoint를 클릭해요.
사이드바에서 Add-ons를 클릭한 다음 Create an Add-on을 클릭해요.
Name 필드에 애드온 정의의 고유 식별자를 지정해요. 이름은 최대 24자까지 가능해요.
Summary 필드에 정의에 대한 짧은 설명을 추가해요. 이 필드는 최대 110자까지 가능해요. 사용자가 애드온을 설치할 때 HCP Waypoint가 이 설명을 보여 줘요.
Terraform no-code module 드롭다운 메뉴에서 템플릿의 소스로 사용할 no-code 모듈을 선택해요. 조직의 프라이빗 레지스트리에 게시된 no-code 모듈이 메뉴에 표시돼요.
입력 변수의 값을 입력해요.
선택 사항으로, 애드온을 설치할 때 값을 선택하고 싶은 각 변수에 대해 Enable this value to be defined when the addon is created 옵션을 활성화해요. 자세한 내용은 HCP Waypoint 변수 참조를 참고해 주세요.
HCP Terraform 프로젝트를 선택해요.
Next를 클릭해요.
Description 필드에 정의에 대한 전체 설명을 추가해요. 이 필드는 최대 500자까지 가능해요. 사용자가 애드온을 설치할 때 HCP Waypoint가 이 설명을 보여 줘요.
Developer instructions 필드에 애플리케이션 개발자가 애드온을 사용하는 방법에 대한 지침을 지정해요. HCP Waypoint는 개발자 지침에서 참조할 수 있도록 다음 변수를 노출해요. 이 필드는 마크다운을 지원해요.
- {{ .ApplicationName }}: 개발자의 애플리케이션 이름을 채워 넣어요.
- {{ .TfcOrgName }}: HCP Terraform 조직의 이름을 채워 넣어요.
- {{ .AddOnName }}: 애드온의 이름을 채워 넣어요.
Labels 필드에 애드온 정의와 연결할 임의의 메타데이터를 라벨로 지정해요.
Publish를 클릭해요.

애드온 정의 편집하기

애드온을 수정해도 기존 설치나 애드온이 만든 지원 인프라에는 영향을 주지 않아요. 변경 사항은 새 애드온 설치에만 적용돼요.

애드온 정의를 편집하려면 다음 단계를 완료해 주세요:

HCP 포털에 로그인하고 Services 메뉴에서 Waypoint를 클릭해요.
사이드바에서 Add-ons를 클릭한 다음 수정하려는 애드온 정의를 클릭해요.
원하는 필드를 업데이트해요.
Save를 클릭해요.

애드온 정의 삭제하기

애드온을 삭제해도 Terraform이 애드온으로 만든 지원 인프라는 삭제되지 않아요. 지원 인프라를 삭제하려면 애플리케이션에서 애드온을 제거하거나, HCP Waypoint 애드온과 연결된 Terraform 리소스와 HCP Terraform 워크스페이스를 삭제해야 해요. 자세한 방법은 파괴 및 삭제를 참고해 주세요.

애드온 정의를 삭제하려면 다음 단계를 완료해 주세요:

HCP 포털에 로그인하고 Services 메뉴에서 Waypoint를 클릭해요.
사이드바에서 Add-ons를 클릭한 다음 삭제하려는 애드온 정의를 클릭해요.
Delete Add-on을 클릭해요.
"DELETE"를 입력하고 Delete를 클릭해요.

다음 단계

애드온 정의를 만든 후 HCP Waypoint로 무엇을 할 수 있는지 자세히 알아보려면 다음 주제를 참고해 주세요:

HCP Waypoint 애드온 정의 생성 및 관리