Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 4.96 KB

README.md

File metadata and controls

95 lines (62 loc) · 4.96 KB
Raw

Actions Status NPM version Python version NuGet version PkgGoDev License

Equinix Resource Provider

PLEASE NOTE: *This provider supercedes the Pulumi Equinix Metal provider.

The Equinix Resource Provider lets you manage Equinix resources (Metal, Fabric, and Network Edge).

Installing

This package is available for several languages/platforms:

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @equinix-labs/pulumi-equinix

or yarn:

yarn add @equinix-labs/pulumi-equinix

Python

To use from Python, install using pip:

pip install pulumi_equinix

Go

To use from Go, use go get to grab the latest version of the library:

go get github.com/equinix/pulumi-equinix/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

dotnet add package Pulumi.Equinix

Java

PLEASE NOTE: Java is currently in preview. For more details check out pulumi java documentation.

To use from Java, add the dependency below to your pom.xml file:

<dependency>
    <groupId>com.equinix.pulumi</groupId>
    <artifactId>equinix</artifactId>
    <version>[0.1.0,)</version>
</dependency>

Configuration

For information about obtaining API key and secret required for Equinix Fabric and Network Edge refer to Generating Client ID and Client Secret key from Equinix Developer Platform portal.

Interacting with Equinix Metal requires an API auth token that can be generated at Project-level or User-level. User API keys can be obtained by creating them in the Equinix Metal Portal or by using the Create a User API Key endpoint. Project API keys can also be obtained by creating them in the Equinix Metal Portal or by using the Create a Project API Key endpoint.

If you are only using Equinix Metal resources, you may omit the Client ID and Client Secret provider configuration parameters needed to access other Equinix resource types (Network Edge, Fabric, etc).

The following configuration points are available for the equinix provider:

  • equinix:authToken (environment: METAL_AUTH_TOKEN) - (Optional) the Equinix Metal API auth key for API operations.
  • equinix:clientId (environment: EQUINIX_API_CLIENTID) - (Optional) API Consumer Key available under My Apps section in Equinix developer portal.
  • equinix:clientSecret (environment: EQUINIX_API_CLIENTSECRET) - (Optional) API Consumer secret available under My Apps section in Equinix developer portal.

Advanced configuration points:

  • equinix:token (environment: EQUINIX_API_TOKEN) - (Optional) API token from the developer sandbox. Token's can be generated for the API Client using the OAuth2 Token features described in the OAuth2 API documentation. The client_id and client_secret arguments will be ignored in the presence of a token argument.
  • equinix:endpoint (environment: EQUINIX_API_ENDPOINT) - (Optional) the Equinix API base URL to point out desired environmen. Defaults to https://api.equinix.com.
  • equinix:maxRetries - (Optional) the maximum number of retries in case of network failure.
  • equinix:maxRetryWaitSeconds - (Optional) the maximum time to wait in case of network failure.
  • equinix:requestTimeout - (Optional) the duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Defaults to 30.
  • equinix:responseMaxPageSize - (Optional) the maximum number of records in a single response for REST queries that produce paginated responses.

Reference

For detailed reference documentation, please visit Equinix API Docs in th Pulumi Registry.