Fournisseur Equinix
Le fournisseur Equinix est utilisé pour interagir avec les ressources fournies par la plateforme Equinix. Le fournisseur doit être configuré avec les identifiants appropriés avant de pouvoir être utilisé.
Pour plus d'informations sur l'obtention de la clé API et du secret requis pour Equinix Fabric et Network Edge, reportez-vous à la section génération d'un identifiant client et d'une clé secrète client à partir du portail de la plateforme pour développeurs Equinix .
Equinix Fabric prend également en charge l'authentification à l'aide d'un jeton d'identité de charge de travail , qui peut être utilisé à la place des client_idarguments et client_secret. Nécessite un périmètre d’autorisation et un jeton OIDC d’un fournisseur d’identité approuvé par les STS Equinix. Il s'agit d'une fonctionnalité alpha qui n'est pas disponible pour tous les utilisateurs. L'utilisation de jetons d'identité de charge de travail remplacera l'identifiant/secret du client. Vous devez utiliser des alias de fournisseur pour gérer à la fois les jetons d'identité de charge de travail et l'identifiant/secret du client dans une seule configuration Terraform.
Utilisez la navigation à gauche pour découvrir les ressources disponibles.
Exemple d'utilisation
Exemple de HCL avec configuration de fournisseur et définition de fournisseurs requise :
terraform {
required_providers {
equinix = {
source = "equinix/equinix"
}
}
}
# Credentials for all Equinix resources
provider "equinix" {
client_id = "someEquinixAPIClientID"
client_secret = "someEquinixAPIClientSecret"
}
Les jetons d'identité de charge de travail peuvent être utilisés dans des scénarios d'autorisation de service, tels que HCP Terraform. Lors de l'utilisation de cette méthode, d'autres variables d'informations d'identification sont facultatives pour les equinix_fabric_* ressources et les sources de données.
# 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"
}
Exemple de configuration de fournisseur à l'aide environment variablesde :
export EQUINIX_API_CLIENTID=someEquinixAPIClientID
export EQUINIX_API_CLIENTSECRET=someEquinixAPIClientSecret
Authentification par jeton
Les jetons peuvent être générés pour le client API à l'aide des fonctionnalités de jetons OAuth2 décrites dans la documentation OAuth2 API.
Les jetons API peuvent être fournis à l'aide de l'tokenargument Provider ou de la EQUINIX_API_TOKENvariable evironnement. Les client_idarguments et client_secretseront ignorés en présence d'un token argument.
Pour plus de détails sur les pratiques de test recommandées, consultez le guide detest Equinix API.
provider "equinix" {
token = "someToken"
}
Référence de l'argument
Le fournisseur Equinix nécessite quelques paramètres de base. Bien que les arguments d'authentification soient facultatifs individuellement, soit token ou client_id et client_secret doivent être définis via des arguments ou des paramètres d'environnement pour interagir avec les services Equinix Fabric et Network Edge.
Ces paramètres peuvent être fournis dans des fichiers variables Terraform ou en tant que variables d'environnement. Il n'est pas recommandé de conserver les données sensibles dans des fichiers texte brut .
Schéma
Facultatif
client_id(String) clé client API disponible sous « mes applications » dans Developer Portal. Cet argument peut également être spécifié avec laEQUINIX_API_CLIENTIDvariable d'environnement shell.client_secret(String) secret du consommateur API disponible sous « mes applications » dans Developer Portal. Cet argument peut également être spécifié avec laEQUINIX_API_CLIENTSECRETvariable d'environnement shell.endpoint(String) URL de base Equinix API pour indiquer l'environnement souhaité. Cet argument peut également être spécifié avec laEQUINIX_API_ENDPOINTvariable d'environnement shell. (Valeur par défauthttps://api.equinix.com)max_retries(Number) nombre maximal de tentatives en cas de panne du réseau.max_retry_wait_seconds(Number) nombre maximal de secondes à attendre avant de réessayer une demande.request_timeout(Nombre) durée, en secondes, pendant laquelle le client API de la plateforme Equinix doit attendre avant d'annuler une demande API. Les demandes annulées peuvent tout de même entraîner le provisionnement de ressources. (Valeur par défaut30)response_max_page_size(Nombre) nombre maximal d'enregistrements dans une seule réponse pour les requêtes REST qui produisent des réponses paginées. (La valeur par défaut est spécifique au client)sts_endpoint(Chaîne) URL de base API STS pour pointer vers l'environnement souhaité. Cet argument peut également être spécifié avec laEQUINIX_STS_ENDPOINTvariable d'environnement shell. (Valeur par défauthttps://sts.eqix.equinix.com). STS est une fonctionnalité alpha qui n'est pas disponible pour tous les utilisateurs.token(Chaîne) les jetons API sont générés à partir de clients consommateurs API à l'aide de l'API OAuth2 . Cet argument peut également être spécifié avec laEQUINIX_API_TOKENvariable d'environnement shell.token_exchange_scope(Chaîne) portée du jeton d'authentification. Il doit s'agir d'un ERN de politique d'accès ou d'une chaîne du formulaireroleassignments:<org_id>. Cet argument peut également être spécifié avec laEQUINIX_TOKEN_EXCHANGE_SCOPEvariable d'environnement shell. L’échange de jetons est une fonctionnalité alpha qui n’est pas disponible pour tous les utilisateurs.token_exchange_subject_token(Chaîne) jeton d'objet à utiliser pour l'authentification d'échange de jetons. Il doit s'agir d'un jeton d'identifiant OIDC émis par un fournisseur OIDC approuvé par Equinix STS. Si elle n'est pas définie, le fournisseur utilisera la variable d'environnement spécifiée danstoken_exchange_subject_token_env_var. L’échange de jetons est une fonctionnalité alpha qui n’est pas disponible pour tous les utilisateurs.token_exchange_subject_token_env_var(Chaîne) nom de la variable d'environnement contenant le jeton d'objet pour l'échange de jetons. Cet argument peut également être spécifié avec laEQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VARvariable d'environnement shell. (Valeur par défautEQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). L’échange de jetons est une fonctionnalité alpha qui n’est pas disponible pour tous les utilisateurs.