Terraformの出力値に説明がない

説明

outputにdescriptionがないと、利用者が値の用途や形式をコードから推測する必要があります。これは文書化と保守性の問題です。

想定される影響

出力値の誤用や、モジュールの引き継ぎ時の混乱につながるおそれがあります。

対処方法

各outputに値の意味と用途を示すdescriptionを追加し、必要に応じて単位や形式も記載してください。

例

以下はEKSクラスター名の出力に説明を追加する例です。参照するクラスターリソースは省略しています。

変更前

output "cluster_name" {
  value = aws_eks_cluster.main.name
}

変更後

output "cluster_name" {
  value       = aws_eks_cluster.main.name
  description = "作成したEKSクラスターの名前"
}

参考資料

• CWE-710
• Terraform Output Values