go tfe descargar - go tfe código fuente descargar

go tfe

Otro código fuente

v1.70.0

Descargar

HCP Terraform y Terraform Enterprise Go Client

El cliente oficial de GO API para HCP Terraform y Terraform Enterprise.

Este cliente admite la API HCP Terraform V2. Como Terraform Enterprise es una distribución autohospedada de HCP Terraform, este cliente respalda los casos de uso de Terraform y Terraform Enterprise de HCP. En toda la documentación del paquete y la API, la plataforma siempre se establecerá como 'Terraform Enterprise', pero una característica se observará explícitamente como solo compatible con uno u otro, si corresponde (raro).

Información de la versión

Casi siempre, los cambios de versión menor indicarán características y mejoras compatibles con el revés. Ocasionalmente, los cambios de firma de funciones que reflejan una corrección de errores pueden aparecer como un cambio de versión menor. Los cambios en la versión del parche se utilizarán para correcciones de errores, mejoras de rendimiento y cambios poco impactantes.

Uso de ejemplo

Construya un nuevo cliente TFE, luego use los diversos puntos finales en el cliente para acceder a diferentes partes de la API de TerraForm Enterprise. El siguiente ejemplo enumera todas las organizaciones.

(Enfoque recomendado) Uso de la configuración personalizada para proporcionar detalles de configuración al cliente 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 )
}

Usando la configuración predeterminada con env vars

La configuración predeterminada utiliza las variables de entorno TFE_ADDRESS y TFE_TOKEN .

TFE_ADDRESS - URL de una instancia de HCP Terraform o Terraform Enterprise. Ejemplo: https://tfe.local
TFE_TOKEN : un token API para la instancia HCP Terraform o Terraform Enterprise.

Nota: Alternativamente, puede establecer TFE_HOSTNAME , que sirve como un alternativo para TFE_ADDRESS . Solo se usará si no se establece TFE_ADDRESS y resolverá el host a un esquema https . Ejemplo: tfe.local => se resuelve a https://tfe.local

Las variables de entorno se utilizan como un respaldo para configurar el cliente TFE si la dirección o los valores de token no se proporcionan como en los casos a continuación:

Usando la configuración predeterminada

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

Cuando la dirección o el token no tienen valor

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

Documentación

Para el uso completo del cliente API, consulte los documentos del paquete completo.

Cobertura de API

Este cliente API cubre la mayoría de las llamadas de API de Terraform HCP existentes y se actualiza regularmente para agregar puntos finales nuevos o faltantes.