README.md

metal-device-action

This Experimental GitHub Action sets up an Equinix Metal server that can be used to run code in your workflows.

💡 See also:

• equinix-metal-project action
• equinix-metal-sweeper action
• equinix-metal-github-action-runner action
• WIP equinix-metal-github-actions-examples examples

Inputs

Name	Description	Required	Default
metal_auth_token	API Key for Equinix Metal	Yes	-
metal_project_id	Project ID for Equinix Metal	Yes	-
metro	Metro for Equinix Metal	Yes	-
plan	Plan for Equinix Metal	Yes	-
os	OS for Equinix Metal	Yes	-
user_data	User data for Equinix Metal	No	''
provisioning_timeout	How long to wait for provisioning (min)	No	30

Outputs

Name	Description
serverid	UUID of the server
ipaddress	IP address of the server

Usage

name: Deploy to Equinix Metal

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Set up Equinix Metal server
        uses: equinix-labs/equinix-metal-action@v1
        with:
          metal_auth_token: ${{ secrets.METAL_AUTH_TOKEN }}
          metal_project_id: ${{ secrets.METAL_PROJECT_ID }}
          metro: 'SV'
          plan: 'c3.medium.x86'
          os: 'ubuntu_22_04'
          user_data: |
            #!/bin/bash
            echo 'Hello, Equinix Metal!'

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.