Terraform Output 变量输出

2024-04-09 23:20
文章标签 输出 变量 output terraform

本文主要是介绍Terraform Output 变量输出,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

如果把Terraform代码看作是一个函数的话,那么“输入变量”是函数的参数,而“局部值”是函数内部的局部变量,“输出值”就是函数的返回值。
在Terraform代码中可以定义多个输出值。
在执行terraform apply命令成功之后会打印出定义的输出值信息,还可以通过terraform output打印出上一次执行terraform apply成功之后得到的输出值。

output可以理解为它是一个变量,只不过它是输出变量,它主要的是帮我们打印变量。

下面是一个输出变量:

Changes to Outputs:+ first_image_id = [+ "centos_7_9_uefi_x64_20G_alibase_20210611.vhd",+ "centos_7_9_uefi_x64_20G_scc_20220906.vhd",+ "centos_7_9_x64_20G_alibase_20220824.vhd",+ "centos_7_8_amd_x64_20G_alibase_20200806.vhd",+ "centos_7_8_tpm_x64_20G_alibase_20200810.vhd",+ "centos_7_8_x64_20G_alibase_20211130.vhd",+ "centos_7_7_x64_20G_alibase_20211130.vhd",+ "centos_7_6_x64_20G_alibase_20211130.vhd",+ "centos_7_5_x64_20G_alibase_20211130.vhd",+ "centos_7_05_64_40G_scc_20190415.raw",+ "centos_7_04_64_20G_alibase_201701015.vhd",+ "centos_7_03_64_20G_alibase_20170818.vhd",+ "centos_7_02_64_20G_alibase_20170818.vhd",]+ my_env         = "prod"

想输出的东西都可以输出。

输出值声明

Terraform的输出值使用output关键字声明,如:

output "instance_ip_addr" {value = aws_instance.server.private_ip
}

output关键字后紧跟的就是输出值的名称,在当前模块内所有输出值的名称都必须是唯一的。
output块内的value参数就是输出值,它可以引用某个资源的输出属性,也可以是一个合法的表达式。

Terraform输出值只有在执行terraform apply之后才会被计算,仅仅执行terraform plan时并不会计算输出值。

注: 不能在output块中引用当前模块下定义的其他输出值。

输出值属性

output块中除了定义必须的value属性之后,还可以定义一些其他的可选属性。

输出值描述

output块中使用description属性描述输出值的含义,如:

output "instance_ip_addr" {value = aws_instance.server.private_ipdescription = "The private IP address of the main server instance."
}

隐藏输出值

如果一个输出值设置sensitive属性为true,表示该输出值含有敏感信息,在执行terraform apply命令成功之后会打印<sensitive>取代真实的输出值。
执行terraform output时也是输出<sensitive>取代真实的输出值,但是依然可以通过执行terraform output -json看到真实的输出值。
另外,标记为sensitive的输出值仍然会被记录在状态文件中,任何有权限读取状态文件的人仍然可以读取到敏感数据。

如下代码片段:

terraform {required_providers {local = {source = "hashicorp/local"version = "2.4.0"}}
}provider "local" {# Configuration options
}resource "local_file" "terraform-introduction" {content = "Hi guys, this is the sample of Terraform"filename = "${path.module}/terraform-sample.txt"
}output "file" {value = local_file.terraform-introduction.filename # 输出值引用资源的输出属性sensitive = true # 将输出值标记为包含敏感信息
}

在执行terraform apply之后不显示真实的输出值:

$ terraform apply
省略部分输出...
Outputs:file = <sensitive>

执行terraform apply成功之后再次执行terraform output依然不显示真实的输出值:

$ terraform output
file = <sensitive>

执行terraform apply成功之后再次执行terraform output -json时会显示真实的输出值:

$ terraform output -json
{"file": {"sensitive": true,"type": "string","value": "./terraform-sample.txt" # 这里显示的是真实的输出值}
}

输出值依赖

一般output很少会需要显示依赖某些资源,但是在一些特殊场景,例如:在当前代码中调用另一个模块时,调用者希望在模块资源全部创建完毕以后才继续后续的创建工作,这时可以为模块设计一个output,通过depends_on显示声明依赖关系,以确保该output必须在所有模块资源都成功创建以后才能被读取,这样就可以在模块尺度上控制资源的创建顺序。

使用depends_on定义输出值的依赖属性:

output "instance_ip_addr" {value       = aws_instance.server.private_ipdescription = "The private IP address of the main server instance."depends_on = [# 先创建安全组,再创建实例aws_security_group_rule.local_access,]
}

不鼓励针对output定义depends_on,只能作为最后的手段加以应用。如果不得不针对output定义depends_on,请务必通过注释说明原因,方便维护。

输出值条件检查

从Terraform v1.2.0开始可以在output块中包含一个条件检查块:precondition属性。
output块中定义precondition块用于确保输出值满足某种要求,可以通过precondition来防止Terraform把一个不合法的处置值写入到状态文件中,可以在合适的场景下通过precondition来保护上一次执行terraform apply时留下的合法的输出值。

Terraform在计算输出value值之前执行precondition检查,这可以防止value表达式中的潜在错误被激发。

Terraform输出值的precondition对应于输入变量的validation块。

代码示例如下:

output "api_base_url" {value = "https://${aws_instance.example.private_dns}:8433/"# EC2实例必须拥有一个加密的根卷precondition {condition     = data.aws_ebs_volume.example.encryptederror_message = "The server's root volume is not encrypted."}
}

output-子模块间的引用

引用的语法:

module.<module_name>.<output_name>

其实每一个目录都可以理解为一个模块,最外层的模块叫做根模块。

比如在写esc代码的时候,创建两台ecs,总不能定义两个ecs资源吧,定义一次,改改参数就行了,或者直接引用。模块其实也帮我们节省代码了,这是管理terraform最佳实践。

如果在自己在本模块当中,资源引用output变量会报错,在本模块当中,还是直接引用资源的属性即可。

output "security_group_id" {value = alicloud_security_group.group.id
}│ Error: Reference to undeclared input variable
│
│   on alicloud_security_group_rule.tf line 19, in resource "alicloud_security_group_rule" "allow_22_tcp":
│   19:   security_group_id = var.security_group_id
│
│ An input variable with the name "security_group_id" has not been declared. This variable can be declared with a        
│ variable "security_group_id" {} block.

正确的引用方式:

provider "alicloud" {region  = var.REGION
}module "data_vpcs" {source = "../modules/data/vpc"REGION = var.REGIONBUSSINESS_DOMAIN=var.BUSSINESS_DOMAINENV = var.ENVBUSSINESS = var.BUSSINESSCIDR_BLOCK = var.CIDR_BLOCK
}module "create_nas" {depends_on = [module.data_vpcs]source = "../modules/nas"VPC_ID = module.data_vpcs.vpcs.vpcs.0.idVSW_ID = module.data_vpcs.vpcs.vpcs.0.vswitch_ids[0]LIFECYCLE_RULE_NAME = var.LIFECYCLE_RULE_NAMERESERVED_DAYS = var.RESERVED_DAYSUSE = var.USEUID_TYPE = var.UID_TYPEUID = var.UIDENV = var.ENVREGION = var.REGIONBUSSINESS_DOMAIN = var.BUSSINESS_DOMAINBUSSINESS = var.BUSSINESSPROTOCOL_TYPE = var.PROTOCOL_TYPESTORAGE_TYPE = var.STORAGE_TYPEFILE_SYSTEM_TYPE = var.FILE_SYSTEM_TYPE
}

这篇关于Terraform Output 变量输出的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/889494

相关文章

使用Java将实体类转换为JSON并输出到控制台的完整过程

《使用Java将实体类转换为JSON并输出到控制台的完整过程》在软件开发的过程中,Java是一种广泛使用的编程语言,而在众多应用中,数据的传输和存储经常需要使用JSON格式,用Java将实体类转换为J... 在软件开发的过程中,Java是一种广泛使用的编程语言,而在众多应用中,数据的传输和存储经常需要使用j

java变量内存中存储的使用方式

《java变量内存中存储的使用方式》:本文主要介绍java变量内存中存储的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、介绍2、变量的定义3、 变量的类型4、 变量的作用域5、 内存中的存储方式总结1、介绍在 Java 中,变量是用于存储程序中数据

python多种数据类型输出为Excel文件

《python多种数据类型输出为Excel文件》本文主要介绍了将Python中的列表、元组、字典和集合等数据类型输出到Excel文件中,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录一.列表List二.字典dict三.集合set四.元组tuplepython中的列表、元组、字典

Spring AI集成DeepSeek实现流式输出的操作方法

《SpringAI集成DeepSeek实现流式输出的操作方法》本文介绍了如何在SpringBoot中使用Sse(Server-SentEvents)技术实现流式输出,后端使用SpringMVC中的S... 目录一、后端代码二、前端代码三、运行项目小天有话说题外话参考资料前面一篇文章我们实现了《Spring

Rust格式化输出方式总结

《Rust格式化输出方式总结》Rust提供了强大的格式化输出功能,通过std::fmt模块和相关的宏来实现,主要的输出宏包括println!和format!,它们支持多种格式化占位符,如{}、{:?}... 目录Rust格式化输出方式基本的格式化输出格式化占位符Format 特性总结Rust格式化输出方式

使用TomCat,service输出台出现乱码的解决

《使用TomCat,service输出台出现乱码的解决》本文介绍了解决Tomcat服务输出台中文乱码问题的两种方法,第一种方法是修改`logging.properties`文件中的`prefix`和`... 目录使用TomCat,service输出台出现乱码问题1解决方案问题2解决方案总结使用TomCat,

浅析Rust多线程中如何安全的使用变量

《浅析Rust多线程中如何安全的使用变量》这篇文章主要为大家详细介绍了Rust如何在线程的闭包中安全的使用变量,包括共享变量和修改变量,文中的示例代码讲解详细,有需要的小伙伴可以参考下... 目录1. 向线程传递变量2. 多线程共享变量引用3. 多线程中修改变量4. 总结在Rust语言中,一个既引人入胜又可

C++中实现调试日志输出

《C++中实现调试日志输出》在C++编程中,调试日志对于定位问题和优化代码至关重要,本文将介绍几种常用的调试日志输出方法,并教你如何在日志中添加时间戳,希望对大家有所帮助... 目录1. 使用 #ifdef _DEBUG 宏2. 加入时间戳:精确到毫秒3.Windows 和 MFC 中的调试日志方法MFC

Python使用Colorama库美化终端输出的操作示例

《Python使用Colorama库美化终端输出的操作示例》在开发命令行工具或调试程序时,我们可能会希望通过颜色来区分重要信息,比如警告、错误、提示等,而Colorama是一个简单易用的Python库... 目录python Colorama 库详解:终端输出美化的神器1. Colorama 是什么?2.

java如何调用kettle设置变量和参数

《java如何调用kettle设置变量和参数》文章简要介绍了如何在Java中调用Kettle,并重点讨论了变量和参数的区别,以及在Java代码中如何正确设置和使用这些变量,避免覆盖Kettle中已设置... 目录Java调用kettle设置变量和参数java代码中变量会覆盖kettle里面设置的变量总结ja