go tfe Unduh - go tfe Sumber Code Unduh

go tfe

Kode sumber lainnya

v1.70.0

Unduh

HCP Terraform dan Terraform Enterprise Go Client

Klien API GO resmi untuk HCP Terraform dan Terraform Enterprise.

Klien ini mendukung HCP Terraform V2 API. Karena Terraform Enterprise adalah distribusi hosting sendiri dari HCP Terraform, klien ini mendukung kasus HCP Terraform dan perusahaan penggunaan perusahaan Terraform. Dalam semua dokumentasi paket dan API, platform akan selalu dinyatakan sebagai 'Perusahaan Terraform' - tetapi fitur akan secara eksplisit dicatat sebagai hanya didukung dalam satu atau yang lain, jika berlaku (jarang).

Informasi versi

Hampir selalu, perubahan versi kecil akan menunjukkan fitur dan peningkatan yang kompatibel dengan mundur. Kadang -kadang, perubahan fungsi tanda tangan yang mencerminkan perbaikan bug dapat muncul sebagai perubahan versi minor. Perubahan versi patch akan digunakan untuk perbaikan bug, peningkatan kinerja, dan perubahan yang tidak menyimpang.

Contoh penggunaan

Bangun klien TFE baru, lalu gunakan berbagai titik akhir pada klien untuk mengakses berbagai bagian API Perusahaan Terraform. Contoh berikut mencantumkan semua organisasi.

(Pendekatan yang disarankan) Menggunakan konfigurasi khusus untuk memberikan detail konfigurasi kepada klien 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 )
}

Menggunakan konfigurasi default dengan vars env

Konfigurasi default memanfaatkan variabel lingkungan TFE_ADDRESS dan TFE_TOKEN .

TFE_ADDRESS - URL HCP Terraform atau Terraform Enterprise Instance. Contoh: https://tfe.local
TFE_TOKEN - Token API untuk HCP Terraform atau Terraform Enterprise Instance.

Catatan: Atau, Anda dapat mengatur TFE_HOSTNAME yang berfungsi sebagai fallback untuk TFE_ADDRESS . Ini hanya akan digunakan jika TFE_ADDRESS tidak diatur dan akan menyelesaikan host ke skema https . Contoh: tfe.local => diselesaikan menjadi https://tfe.local

Variabel lingkungan digunakan sebagai fallback untuk mengkonfigurasi klien TFE jika alamat atau nilai token tidak disediakan seperti dalam kasus di bawah ini:

Menggunakan konfigurasi default

 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 )
}

Saat alamat atau token tidak memiliki nilai

 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 )
}

Dokumentasi

Untuk penggunaan lengkap klien API, lihat dokumen paket lengkap.

Cakupan API

Klien API ini mencakup sebagian besar panggilan API HCP Terraform yang ada dan diperbarui secara berkala untuk menambahkan titik akhir baru atau yang hilang.