#terraform #tf-bindgen #macro #bindings-generator #configuration

过程宏 tf-bindgen-codegen

一套用于改进tf-bindgen代码的过程宏集合

1个不稳定版本

0.1.0 2023年4月16日

#6#tf-bindgen


3 个crate使用 (通过 tf-bindgen)

BSD-3-Clause

20KB
390

tf-bindgen

docs crates

tf-bindgen 可用于为 Terraform 提供商生成Rust绑定,并部署您的基础设施。此库将复制 CDK for Terraform 的大多数功能,但用Rust编写。

要求

必需工具

  • cargo
  • terraform

tf-bindgen 是什么?

tf-bindgen 是一个代码生成器,将生成用于使用 Terraform 配置基础设施的Rust代码。以下示例显示了如何使用 tf-bindgen 配置运行nginx的Kubernetes pod

fn init() -> Stack {
	let stack = Stack::new("nginx");

	/// Configure Resources using a builder
	let metadata = KubernetesNamespaceMetadata::builder()
		.name("nginx")
		.build();
	let namespace = KubernetesNamespace::create(&stack, "nginx-namespace")
		.metadata(metadata)
		.build();

	/// Configure Resources using the resource! macro
	resource! {
		&stack, resource "kubernetes_pod" "nginx" {
			metadata {
				namespace = &namespace.metadata[0].name
				name = "nginx"
			}
			spec {
				container {
					name = "nginx"
					image = "nginx"
					port {
						container_port = 80
					}
				}
			}
		}
	};

	stack
}

有关 tf-bindgen 的完整介绍,请参阅 文档

问题

编译性能

某些提供商(如 tf-kubernetes)将生成大型绑定,导致编译时间过长。如果您遇到此问题,请参阅 提高编译时间 部分。

路线图

v0.1

  • 为Terraform提供商生成Rust代码
    • 实现数据块
    • 实现资源块
  • 添加对变量引用的支持
  • 从Terraform模块生成Rust代码
  • 添加代码生成器 tf_bindgen::codegen::resource
  • 添加构建派生宏
  • 创建Markdown书籍

v0.2

  • 在构造中添加对输出的支持
  • 添加用于生成CLI应用程序的宏
  • 为值类型添加 format!
  • 从生成的源代码中删除派生宏

限制

如上所述,此库将复制由 CDK for Terraform 提供的功能。它不是 Rust 的一对一替代品,在实现的一些方面会有所不同。

  1. cdktf(库和 CLI 应用程序)不是使用此库所需的。
  2. tf-bindgen 构造与 CDK 构造不兼容。

贡献

许可证

本项目采用 BSD-3-Clause 许可证。

依赖关系

~2MB
~42K SLoC