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。
參見貢獻
請參閱發行