1个不稳定版本

0.1.0 2023年4月16日

#285FFI


用于 2 crate

BSD-3-Clause

125KB
2.5K SLoC

tf-bindgen

docs crates

tf-bindgen 可以用来生成Rust绑定,用于Terraform提供商,并部署你的基础设施。这个库将复制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
  • 添加Construct derive宏
  • 创建Markdown手册

v0.2

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

限制

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

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

贡献

许可证

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

依赖

约2.3-3.5MB
约70K SLoC