Fornecedor Equinix
O provedor de Equinix é usado para interagir com os recursos fornecidos pela Plataforma Equinix. O provedor precisa ser configurado com as credenciais adequadas antes de poder ser usado.
Para obter informações sobre como obter a chave API e o segredo necessários para Equinix Fabric e Network Edge, consulte Gerando ID do cliente e chave secreta do cliente no portal da plataforma do desenvolvedor Equinix .
O Equinix Fabric também oferece suporte à autenticação usando um token de identidade de carga de trabalho , que pode ser usado no lugar client_iddos argumentos e.client_secret Requer um escopo de autorização e token OIDC de um IdP confiável pelo STS da Equinix. Este é um recurso alfa não disponível para todos os usuários. O uso de tokens de identidade da carga de trabalho substituirá o ID/segredo do cliente. Você deve usar aliases de provedor para gerenciar tokens de identidade da carga de trabalho e o ID/segredo do cliente em uma única configuração do terraform.
Utilize a navegação à esquerda para ler sobre os recursos disponíveis.
Exemplo de uso
Exemplo de HCL com configuração de provedor e uma definição de provedor obrigatória :
terraform {
required_providers {
equinix = {
source = "equinix/equinix"
}
}
}
# Credentials for all Equinix resources
provider "equinix" {
client_id = "someEquinixAPIClientID"
client_secret = "someEquinixAPIClientSecret"
}
Os tokens de identidade da carga de trabalho podem ser usados em cenários de autorização de serviço, como o terraform HCP. Ao usar esse método, outras variáveis de credenciais são opcionais para equinix_fabric_* recursos e fontes de dados.
# Configuration for using Workload Identity Federation
provider "equinix" {
# Desired scope of the requested security token. Must be an Access Policy ERN or a string of the form `roleassignments:<organization_id>`
token_exchange_scope = "roleassignments:<organization_id>"
# The name of the environment variable containing the token exchange subject token
# For example, HCP Terraform automatically sets TFC_WORKLOAD_IDENTITY_TOKEN
token_exchange_subject_token_env_var = "TFC_WORKLOAD_IDENTITY_TOKEN"
}
Exemplo de configuração de provedor usando environment variables:
export EQUINIX_API_CLIENTID=someEquinixAPIClientID
export EQUINIX_API_CLIENTSECRET=someEquinixAPIClientSecret
Autenticação por token
Os tokens podem ser gerados para o Cliente API usando os recursos do token OAuth2 descritos na documentação doAPI do OAuth2.
Os tokens API podem ser fornecidos usando o tokenargumento provider ou a EQUINIX_API_TOKENvariável de ambiente. Os client_idargumentos e client_secretserão ignorados na presença de um token argumento.
Consulte o guiade teste Equinix API para obter detalhes sobre as práticas de teste recomendadas.
provider "equinix" {
token = "someToken"
}
Referência do argumento
O provedor de Equinix requer alguns parâmetros básicos. Embora os argumentos de autenticação sejam individualmente opcionais, tokenou client_id e client_secret devem ser definidos por meio de argumentos ou configurações de ambiente para interagir com os serviços Equinix Fabric e Network Edge.
Esses parâmetros podem ser fornecidos em arquivos de variáveis terraform ou como variáveis de ambiente. Não é recomendado manter dados confidenciais em arquivos de texto simples .
Esquema
Opcional
client_id(String) Chave do consumidor API disponível em "Meus aplicativos" no Developer Portal. Esse argumento também pode ser especificado com aEQUINIX_API_CLIENTIDvariável de ambiente shell.client_secret(String) Segredo do consumidor API disponível em "Meus aplicativos" no Developer Portal. Esse argumento também pode ser especificado com aEQUINIX_API_CLIENTSECRETvariável de ambiente shell.endpoint(String) o URL base do Equinix API para indicar o ambiente desejado. Esse argumento também pode ser especificado com aEQUINIX_API_ENDPOINTvariável de ambiente shell. (O padrão éhttps://api.equinix.com)max_retries(Number) Número máximo de tentativas em caso de falha na rede.max_retry_wait_seconds(Number) Número máximo de segundos para aguardar antes de tentar novamente uma solicitação.request_timeout(Number) O tempo, em segundos, que o Cliente API da Plataforma Equinix deve aguardar antes de cancelar uma solicitação API. As solicitações canceladas ainda podem resultar em recursos provisionados. (O padrão é30)response_max_page_size(Number) O número máximo de registros em uma única resposta para consultas REST que produzem respostas paginadas. (O padrão é específico do cliente)sts_endpoint(String) o URL base do STS API para apontar para o ambiente desejado. Esse argumento também pode ser especificado com aEQUINIX_STS_ENDPOINTvariável de ambiente shell. (O padrão éhttps://sts.eqix.equinix.com). O STS é um recurso alfa e não está disponível para todos os usuários.token(String) Os tokens API são gerados a partir de clientes de consumidor API usando o API OAuth2 . Esse argumento também pode ser especificado com aEQUINIX_API_TOKENvariável de ambiente shell.token_exchange_scope(String) o escopo do token de autenticação. Deve ser um ERN de política de acesso ou uma string do formulárioroleassignments:<org_id>. Esse argumento também pode ser especificado com aEQUINIX_TOKEN_EXCHANGE_SCOPEvariável de ambiente shell. A troca de token é um recurso alfa e não está disponível para todos os usuários.token_exchange_subject_token(String) o token do assunto a ser usado para autenticação de troca de token. Deve ser um token de ID do OIDC emitido por um provedor de OIDC confiável pelo STS da Equinix. Se não estiver definido, o provedor usará a variável de ambiente especificada emtoken_exchange_subject_token_env_var. A troca de token é um recurso alfa e não está disponível para todos os usuários.token_exchange_subject_token_env_var(String) o nome da variável de ambiente que contém o token do assunto para troca de token. Esse argumento também pode ser especificado com aEQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VARvariável de ambiente shell. (O padrão éEQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). A troca de token é um recurso alfa e não está disponível para todos os usuários.