Equinix 提供商
Equinix提供商用于与Equinix平台提供的资源进行交互。提供商需要使用适当的凭据来配置提供商,然后才能使用。
获取Equinix Fabric和Network Edge所需的API密钥和机密信息,请参阅从Equinix开发者平台门户网站生成客户端ID和客户端机密钥。
Equinix Fabric还支持使用Workload身份令牌进行身份验证,该令牌可代替client_id和client_secret参数。需要Equinix STS信任的IDP提供的授权范围和OIDC令牌。这是一项ALPHA功能,并非对所有用户都可用。使用工作负荷身份令牌将覆盖客户端ID/ Terraform,您必须使用提供商别名在单个Terraform配置中管理工作负荷身份令牌和客户端ID/机密。
使用左侧导航栏了解可用资源。
用法示例
terraform {
required_providers {
equinix = {
source = "equinix/equinix"
}
}
}
# Credentials for all Equinix resources
provider "equinix" {
client_id = "someEquinixAPIClientID"
client_secret = "someEquinixAPIClientSecret"
}
Workload身份令牌可用于服务授权场景,如HCP Terraform。使用此方法时,资源和数据源的其他凭据变量是可选的equinix_fabric_*。
# 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"
}
提供商配置示例,使用environment variables:
export EQUINIX_API_CLIENTID=someEquinixAPIClientID
export EQUINIX_API_CLIENTSECRET=someEquinixAPIClientSecret
令牌认证
可以使用OAuth2 API文档中所述的OAuth2令牌功能为API客户端生成令牌。
API令牌可以使用提供商参数或EQUINIX_API_TOKEN环境变量提供token。client_id参数存在时,和client_secret参数将被忽略token。
有关推荐测试实践的详细信息,请参阅Equinix API测试指南。
provider "equinix" {
token = "someToken"
}
论证参考
Equinix提供商需要一些基本参数。身份验证参数是单独的,但tokenORclient_id和client_secret必须通过参数或环境设置定义,才能与Equinix Fabric和Network Edge服务交互。
这些参数可以在Terraform变量文件中提供,也可以作为环境变量提供。不建议将敏感数据保存在纯文本文件中。
模式
可选
client_id(字符串) API消费者密钥在Developer Portal中的“我的应用程序”下方可用。此参数也可以使用shell环境变量指定EQUINIX_API_CLIENTID。client_secret(字符串) Developer Portal中“我的应用程序”下提供的API消费者机密。此参数也可以使用shell环境变量指定EQUINIX_API_CLIENTSECRET。endpoint(string)指明所需环境的Equinix API基本URL。此参数也可以使用shell环境变量指定EQUINIX_API_ENDPOINT。(默认为https://api.equinix.com)max_retries(数量)网络故障时的最大重试次数。max_retry_wait_seconds(数字)重试请求前等待的最大秒数。request_timeout(数字) Equinix Platform API客户端在取消API请求之前应等待的时间(以秒为单位)。取消的请求仍可能导致已配置资源。(默认为30)response_max_page_size(数量)单个响应中产生分页响应的REST查询的最大记录数。(默认为客户端特定)sts_endpoint(字符串)指向所需环境的STS API基本URL。此参数也可以使用shell环境变量指定EQUINIX_STS_ENDPOINT。(默认为https://sts.eqix.equinix.com)。STS是一项ALPHA功能,并非对所有用户可用。token(string) API令牌是使用OAuth2 API从API消费者客户端生成的。此参数也可以使用shell环境变量指定EQUINIX_API_TOKEN。token_exchange_scope(string)身份验证令牌的范围。必须是访问策略ERN或表单的字符串roleassignments:<org_id>。此参数也可以使用shell环境变量指定EQUINIX_TOKEN_EXCHANGE_SCOPE。令牌交换是一项ALPHA功能,并非对所有用户都可用。token_exchange_subject_token(string)用于令牌交换验证的主题令牌。OIDC ID令牌必须由Equinix STS信任的OIDC提供商签发。如果未设置,提供商将使用中指定的环境变量token_exchange_subject_token_env_var。令牌交换是一项ALPHA功能,并非对所有用户都可用。token_exchange_subject_token_env_var(string)环境变量的名称,其中包含用于令牌交换的主题令牌。此参数也可以使用shell环境变量指定EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR。(默认为EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN)。令牌交换是一项ALPHA功能,并非对所有用户都可用。