命名约定
Last updated
Last updated
在任何地方(资源名称、数据源名称、变量名称、输出等)使用 _
(下划线) 而不是 -
(破折号)。
非常适合使用小写字母和数字(即使支持 UTF-8)。
不要在资源名称中重复资源类型(既不要部分,更不要完全):
resource "aws_route_table" "public" {}
resource "aws_route_table" "public_route_table" {}
resource "aws_route_table" "public_aws_route_table" {}
如果没有更多的描述性和通用名称可用,或者如果资源模块创建这种类型的单个资源,资源名称应该被命名为this
(例如,在 中有一个类型为 aws_nat_gateway
的资源和多个类型为aws_route_table
的资源,所以 aws_nat_gateway
应该命名为this
,并且aws_route_table
应该有更具描述性的名称——比如private
, public
, database)
。
始终使用单数名词作为名称。
在参数值内部和值将显示给人类的地方,使用-
(例如,在 RDS 实例的 DNS 名称内部)。
将参数count
/ for_each
包含在资源或数据源块中作为顶部的第一个参数,并在其后用换行符分隔。
包括参数tags,
如果资源支持,作为最后一个真正的参数,如果需要,后面是 depends_on
和lifecycle
。所有这些都应该用一个空行分隔。
在参数count
/ for_each
中使用条件时,首选布尔值而不是使用 length
或其他表达式。
resource
(资源)代码示例count
/ for_each
的使用tags
(标签)的放置count
(计数)条件不要在资源模块中重新造轮子:使用你正在使用的资源的“参数参考”部分中定义的变量 name,description
和 default
。
对变量验证的支持相当有限(例如,无法访问其他变量或进行查找)。 相应地计划,因为在许多情况下此功能是无用的。
当type是list(...)
或 map(...)
,在变量名中使用复数形式。
在变量块中排序键,比如:description
,type
,default
,validation
。
始终包括对所有变量的description
,即使你认为它很明显(将来你会需要它)。
优先使用简单类型(number
,string
,list(...)
,map(...)
, any
) 而不是像object()
这样的特定类型,除非您需要对每个键都有严格的约束。
如果map的所有元素都具有相同的类型(例如string
)或可以转换为它(例如number
类型可以转换为string
),则使用特定类型,如map(map(string))
。
使用类型any
来禁用从某个深度开始或者在支持多个类型时的类型验证。
值{}
有时是一个map,有时是一个对象。使用tomap(...)
制作map,因为没有办法制作对象。
使输出在其范围之外保持一致且易于理解(当用户使用模块时,它返回的值的类型和属性应该很明显)。
输出的名称应该描述它包含的属性,并且不像你通常想要的那样自由。
输出名称的良好结构类似于{name}_{type}_{attribute}
,其中:
{name}
是没有提供者前缀的资源或数据源名称。aws_subnet
的{name}是subnet
,aws_vpc
的{name}
是vpc
{type}
是一种资源来源
{attribute}
是输出返回的属性
始终包括所有输出的description
,即使你认为它很明显。
避免设置sensitive
参数, 除非您完全控制此输出在所有模块的所有位置的使用。
更喜欢try()
(自 Terraform 0.13 起可用)而不是 element(concat(...))
(0.13 之前版本的旧方法)。
output
(输出)代码示例最多返回一个安全组ID:
当有多个相同类型的资源时,this
在输出名称中应省略:
参见示例 .
如果输出返回一个带有插值函数和多个资源的值,{name}
和 {type}
应该尽可能通用(this
作为前缀应该省略), 参见示例 。
如果返回值是一个列表,它应该有一个复数名称。 参见示例 。