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

相关文章

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php

从基础到高级详解Python数值格式化输出的完全指南

《从基础到高级详解Python数值格式化输出的完全指南》在数据分析、金融计算和科学报告领域,数值格式化是提升可读性和专业性的关键技术,本文将深入解析Python中数值格式化输出的相关方法,感兴趣的小伙... 目录引言:数值格式化的核心价值一、基础格式化方法1.1 三种核心格式化方式对比1.2 基础格式化示例

GO语言短变量声明的实现示例

《GO语言短变量声明的实现示例》在Go语言中,短变量声明是一种简洁的变量声明方式,使用:=运算符,可以自动推断变量类型,下面就来具体介绍一下如何使用,感兴趣的可以了解一下... 目录基本语法功能特点与var的区别适用场景注意事项基本语法variableName := value功能特点1、自动类型推

java -jar example.jar 产生的日志输出到指定文件的方法

《java-jarexample.jar产生的日志输出到指定文件的方法》这篇文章给大家介绍java-jarexample.jar产生的日志输出到指定文件的方法,本文给大家介绍的非常详细,对大家的... 目录怎么让 Java -jar example.jar 产生的日志输出到指定文件一、方法1:使用重定向1、

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

c++ 类成员变量默认初始值的实现

《c++类成员变量默认初始值的实现》本文主要介绍了c++类成员变量默认初始值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录C++类成员变量初始化c++类的变量的初始化在C++中,如果使用类成员变量时未给定其初始值,那么它将被

在Linux中改变echo输出颜色的实现方法

《在Linux中改变echo输出颜色的实现方法》在Linux系统的命令行环境下,为了使输出信息更加清晰、突出,便于用户快速识别和区分不同类型的信息,常常需要改变echo命令的输出颜色,所以本文给大家介... 目python录在linux中改变echo输出颜色的方法技术背景实现步骤使用ANSI转义码使用tpu

Python变量与数据类型全解析(最新整理)

《Python变量与数据类型全解析(最新整理)》文章介绍Python变量作为数据载体,命名需遵循字母数字下划线规则,不可数字开头,大小写敏感,避免关键字,本文给大家介绍Python变量与数据类型全解析... 目录1、变量变量命名规范python数据类型1、基本数据类型数值类型(Number):布尔类型(bo

一文全面详解Python变量作用域

《一文全面详解Python变量作用域》变量作用域是Python中非常重要的概念,它决定了在哪里可以访问变量,下面我将用通俗易懂的方式,结合代码示例和图表,带你全面了解Python变量作用域,需要的朋友... 目录一、什么是变量作用域?二、python的四种作用域作用域查找顺序图示三、各作用域详解1. 局部作