説明
変数にdescriptionがないと、利用者がどの値を渡すべきか、いつ既定値を変更すべきか分かりにくくなります。
想定される影響
意味の誤解によって設定を間違えたり、同じ問い合わせが繰り返されたりする場合があります。
対処方法
各variableに目的と期待する値を示すdescriptionを追加してください。値の制約を強制する場合は、別途バリデーションを構成してください。
例
以下はクラスター名の変数に説明を追加する例です。変数名、型、既定値は維持しています。
変更前
hcl
variable "cluster_name" {
type = string
default = "example"
}
変更後
hcl
variable "cluster_name" {
type = string
default = "example"
description = "作成するKubernetesクラスターの名前"
}