Download go tfe - Download do código -fonte go tfe

go tfe

Outro código-fonte

v1.70.0

Baixar

HCP Terraform e Terraform Enterprise Go Client

O cliente oficial da API GO da HCP Terraform e Terraform Enterprise.

Este cliente suporta a API HCP Terraform V2. Como a Terraform Enterprise é uma distribuição auto-hospedada da HCP Terraform, esse cliente suporta casos de uso da HCP Terraform e Terraform Enterprise. Em toda a documentação do pacote e da API, a plataforma sempre será declarada como 'Terraform Enterprise' - mas um recurso será explicitamente conhecido como suportado apenas em um ou outro, se aplicável (raro).

Informações da versão

Quase sempre, as alterações menores da versão indicarão recursos e aprimoramentos compatíveis com versões anteriores. Ocasionalmente, as alterações de assinatura da função que refletem uma correção de bug podem aparecer como uma mudança de versão menor. As alterações na versão de patch serão usadas para correções de bugs, melhorias de desempenho e alterações sem impactos.

Exemplo de uso

Construa um novo cliente TFE e use os vários terminais do cliente para acessar diferentes partes da API Enterprise Terraform. O exemplo a seguir lista todas as organizações.

(Abordagem recomendada) Usando a configuração personalizada para fornecer detalhes de configuração ao cliente da 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 a configuração padrão com ENV VARS

A configuração padrão utiliza as variáveis de ambiente TFE_ADDRESS e TFE_TOKEN .

TFE_ADDRESS - URL de uma instância HCP Terraform ou Terraform Enterprise. Exemplo: https://tfe.local
TFE_TOKEN - Um token da API para a instância do HCP Terraform ou Terraform Enterprise.

NOTA: Como alternativa, você pode definir TFE_HOSTNAME , que serve como um retorno para TFE_ADDRESS . Ele só será usado se TFE_ADDRESS não estiver definido e resolverá o host em um esquema https . Exemplo: tfe.local => resolve https://tfe.local

As variáveis de ambiente são usadas como um retorno para configurar o cliente TFE se o endereço ou os valores do token não forem fornecidos como nos casos abaixo:

Usando a configuração padrão

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

Quando o endereço ou o token não tem 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 )
}

Documentação

Para uso completo do cliente da API, consulte os documentos completos do pacote.

Cobertura da API

Este cliente da API abrange a maioria das chamadas de API do HCP HCP Terraform e é atualizado regularmente para adicionar pontos de extremidade novos ou ausentes.