설명
변수에 description이 없으면 사용자가 어떤 값을 전달해야 하는지, 기본값을 언제 바꿔야 하는지 이해하기 어렵습니다.
잠재적 영향
변수의 의미를 오해해 잘못된 설정을 전달하거나 같은 문의를 반복할 수 있습니다.
해결 방법
각 variable에 목적과 기대하는 값을 설명하는 description을 추가하세요. 값의 제한을 강제해야 한다면 별도 검증도 구성하세요.
예시
클러스터 이름 변수에 설명을 추가하는 예시입니다. 변수의 이름, 자료형과 기본값은 유지합니다.
변경 전
hcl
variable "cluster_name" {
type = string
default = "example"
}
변경 후
hcl
variable "cluster_name" {
type = string
default = "example"
description = "생성할 Kubernetes 클러스터 이름"
}