metal-project-action

README

metal-project-action

Experimental GitHub Action for creating Equinix Metal Projects.

💡 See also:

• equinix-metal-sweeper action
• equinix-metal-examples examples

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	Description
userToken	(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	Description
projectID	a new Equinix Metal Project ID
projectName	the generated (or supplied) name of the Equinix Metal Project
projectToken	a new Equinix Metal Project API Token bound to this project
projectSSHPrivateKeyBase64	a new SSH Private Key (base64 encoded) that can be used to authenticate to devices in this project
projectSSHPublicKey	a new SSH Public Key that can be used to authenticate to devices in this project
organizationID	ID of the Organization responsible for the project.

Support

This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production.