Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
folder-plus

GitHub Action

Equinix Metal Project

v0.6.0

Equinix Metal Project

folder-plus

Equinix Metal Project

Create an Equinix Metal and a new Project API Key for that project

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Equinix Metal Project

              
  uses: equinix-labs/[email protected]
Learn more about this action in equinix-labs/metal-project-action

Choose a version

metal-project-action

Experimental Github Action for creating Equinix Metal Projects.

💡 See also:

Given a Equinix Metal User API Token, a new Project will be created, preconfigured with an SSH Key and API Key which can be used in subsequent actions.

Clean up the project with the Equinix Metal Sweeper Action.

See the Equinix Metal Actions Example for usage examples.

Input

With Environment variable Description
userToken METAL_AUTH_TOKEN (required) A Equinix Metal User API Token
projectName - Name for the project, API key, and SSH Key. A generated name will be used if not supplied.
organizationID - Organization ID that the Project will be created under. If not supplied, the default organization for the API User will be used.

Output

Output Name Environment Variable Description
projectID METAL_PROJECT_ID a new Equinix Metal Project ID
projectName METAL_PROJECT_NAME the generated (or supplied) name of the Equinix Metal Project
projectToken METAL_PROJECT_TOKEN a new Equinix Metal Project API Token bound to this project
projectSSHPrivateKeyFile METAL_SSH_PRIVATE_KEY_FILE a new SSH Private Key that can be used to authenticate to devices in this project
projectSSHPublicKeyFile METAL_SSH_PUBLIC_KEY_FILE a new SSH Public Key that can be used to authenticate to devices in this project
organizationID METAL_ORGANIZATION_ID ID of the Organization responsible for the project.