go tfe
v1.70.0
HCP Terraform和Terraform Enterprise的官方GO API客户端。
该客户端支持HCP Terraform V2 API。由于Terraform Enterprise是HCP Terraform的自托管分布,因此该客户端支持HCP Terraform和Terraform Enterprise用例。在所有软件包文档和API中,该平台将始终称为“ Terraform Enterprise” - 但如果适用(罕见),将明确指出功能仅在一个或另一个中支持。
几乎总是,次要版本更改将表明向后兼容的功能和增强功能。有时,反映错误修复的功能签名更改可能会显示为次要版本。补丁版更改将用于错误修复,性能改进以及其他不影响的更改。
构建一个新的TFE客户端,然后使用客户端上的各个端点访问Terraform Enterprise API的不同部分。以下示例列出了所有组织。
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
config := & tfe. Config {
Address : "https://tfe.local" ,
Token : "insert-your-token-here" ,
RetryServerErrors : true ,
}
client , err := tfe . NewClient ( config )
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
默认配置使用TFE_ADDRESS
和TFE_TOKEN
环境变量。
TFE_ADDRESS
HCP Terraform或Terraform Enterprise实例的URL。示例: https://tfe.local
TFE_TOKEN
HCP Terraform或Terraform Enterprise实例的API令牌。注意:或者,您可以设置TFE_HOSTNAME
,以作为TFE_ADDRESS
的后备。仅当未设置TFE_ADDRESS
并将主机解析为https
方案时,才会使用它。示例: tfe.local
=>解决到https://tfe.local
如果地址或令牌值未提供如下:
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
// Passing nil to tfe.NewClient method will also use the default configuration
client , err := tfe . NewClient ( tfe . DefaultConfig ())
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
config := & tfe. Config {
Address : "" ,
Token : "" ,
}
client , err := tfe . NewClient ( config )
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
有关API客户端的完整使用,请参阅完整的软件包文档。
该API客户端涵盖了大多数现有的HCP Terraform API调用,并定期更新以添加新的或缺少的端点。
请参阅示例目录。
请参阅tests.md。
参见贡献
请参阅版本