go tfe Download - go tfe Source Code Download

go tfe

Anderer Quellcode

v1.70.0

Herunterladen

HCP Terraform und Terraform Enterprise GO Kunde

Der offizielle GO -API -Kunde für HCP Terraform und Terraform Enterprise.

Dieser Kunde unterstützt die HCP -Terraform V2 -API. Da Terraform Enterprise eine selbst gehostete Verteilung von HCP-Terraform ist, unterstützt dieser Kunde sowohl HCP-Gebrauchsfälle als auch Terraform Enterprise. In allen Paketdokumentation und API wird die Plattform immer als "Terraform Enterprise" angegeben. Eine Funktion wird jedoch ausdrücklich als nur in der einen oder anderen, gegebenenfalls (selten) festgestellt.

Versionsinformationen

Fast immer sind geringfügige Versionsänderungen nach rückwärtskompatiblen Funktionen und Verbesserungen. Gelegentlich können Änderungen der Funktionssignatur, die eine Fehlerbehebung widerspiegeln, als geringfügige Versionsänderung angezeigt werden. Änderungen der Patch -Version werden für Fehlerbehebungen, Leistungsverbesserungen und ansonsten uneingeschränkte Änderungen verwendet.

Beispiel Verwendung

Konstruieren Sie einen neuen TFE -Client und verwenden Sie die verschiedenen Endpunkte des Kunden, um auf verschiedene Teile der Terraform Enterprise -API zuzugreifen. Das folgende Beispiel listet alle Organisationen auf.

(Empfohlener Ansatz) Verwenden der benutzerdefinierten Konfiguration, um dem API -Client Konfigurationsdetails bereitzustellen

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

Verwenden der Standardkonfiguration mit Env VARs

Die Standardkonfiguration verwendet die Umgebungsvariablen TFE_ADDRESS und TFE_TOKEN .

TFE_ADDRESS - URL einer HCP -Terraform- oder Terraform -Enterprise -Instanz. Beispiel: https://tfe.local
TFE_TOKEN - Ein API -Token für die Instanz der HCP -Terraform oder der Terraform Enterprise.

Hinweis: Alternativ können Sie TFE_HOSTNAME festlegen, der als Fallback für TFE_ADDRESS dient. Es wird nur verwendet, wenn TFE_ADDRESS nicht eingestellt ist und den Host in ein https -Schema auflöst. Beispiel: tfe.local => beschichtet sich an https://tfe.local

Die Umgebungsvariablen werden als Fallback verwendet, um den TFE -Client zu konfigurieren, wenn die Adresse oder Token -Werte nicht wie in den folgenden Fällen bereitgestellt werden:

Verwenden der Standardkonfiguration

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

Wenn Adresse oder Token keinen Wert hat

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

Dokumentation

Für die vollständige Verwendung des API -Clients finden Sie in den vollständigen Paketdokumenten.

API -Abdeckung

Dieser API -Client deckt die meisten vorhandenen HCP -Terraform -API -Anrufe ab und wird regelmäßig aktualisiert, um neue oder fehlende Endpunkte hinzuzufügen.