Equnix Metal
Loading...

Projects

COMMAND LINE

Copy to clipboard

Projects

Within an organization, you can create projects to logically group infrastructure and to enable certain networking features. Each project generates its own invoice at the end of each month.

Creating a Project

Owners and Admins of an organization can create new projects. To create a new project in the Equinix Metal console, click + New Project from the Projects drop-down menu.

New projects can be created through the API, by sending a POST request to the /projects endpoint.

Since each project results in a distinct invoice, be sure that your automation doesn't create a new project when it isn't needed.

Project Settings

As a user on a project, information and settings related to the project are on the Project Settings page. General information about a project is on the General panel, including the project name and ID. Each project has a unique ID, which is used to reference the project in the API and allows it to be renamed at any time.

A Sample Project Settings General pane

Project Settings is where you can:

  • Rename the project.
  • Manage the project's Spot Market requests.
  • Mange the project's API keys and SSH keys.
  • Access the project's Timeline.
  • Monitor the project's Usage.

If you a Collaborator on a project, then you are also able to leave the project. If you are the Owner of the organization the project belongs to, then you have the option to delete the project.

SSH Keys

Project-level SSH keys can be added to a project to allow SSH access to servers in the project that is not tied to a particular user. Project SSH keys will be deployed to new servers the same way that user SSH keys are. Any project collaborator can add and remove project-level SSH keys.

Documentation on SSH Keys is on the SSH Keys page.

API Keys

Project-level API keys can be added to a project to allow access to the Equinix Metal API that is not tied to a particular user. Project API keys do not have access to the entirety of the API; some endpoints can only be used by personal API tokens.

Project-level Infrastructure

All servers and infrastructure on Equinix Metal are provisioned as part of a project. On the project's main page you can see the categories managed at the project level in the Servers, IPs & Networks, and Storage tabs.

Servers

The Servers tab is where you can provision and manage servers using the Equinix Metal console, with the option to deploy On Demand servers, place Spot Market requests, and manage your Reserved Hardware.

It also shows the list of all the servers that are currently running in the project and how you access and manage them each individually.

IPs and Networks

Manage shared networking infrastructure on the IPs & Networks tab. This includes things like enabling Backend Tranfer, VLANs, and Elastic IP Addresses.

Documentation on a variety of networking topics is in the Networking section of the docs.

Storage

The Storage tab is where you can provision and manage Elastic Block Storage volumes attached to this project.

Project-level Entitlements

Entitlements are managed at the organization level, but you can see the entitlements for a specific project through the console and the API. When you go to provision servers using the console, your options are automatically filtered to the locations and hardware available to the project. If you want to list the project's entitlements you can do so through the API.

Users and Projects

You can manage which users have access to projects from your Organization Settings. Users that are a members of your organization and, specifically, users that have the Collaborator role can be assigned access to projects on a project-by-project basis. Collaborators on a project are permitted to access, provision and manage its servers.

Inviting a User to a Project

You invite a user to become a part of your project when you add them to your organization. If you need to update the projects a user is a Collaborator on, you can click Manage next to their name in the Team tab of your Organization Settings. If you update a user to have the Admin role, they will have access to all projects in the organization.

You can also invite a user to a project through the API, by sending a POST request to the /projects/{project_id}/invitations endpoint. A list of invitations for a project can be retrieved by a GET request to the /projects/{project_id}/invitations endpoint.

Documentation on organizations and organization-level operations is on the Organizations page.

Transferring a Project

If you are an Owner of the organization a project belongs to, you can transfer the project to another organization. On the Projects page of Organization Settings, click the Transfer button. You will need the ID of the organization you want to transfer the project to. Fill it into the ID of the receiving organization: field.

To initiate a transfer through the API, send a POST request to the /projects/{id}/transfers endpoint. The ID of the receiving organization is a required body parameter.

Deleting a Project

Deleting an project is permanent.

Owners or Admins of the organization that owns the project are the only users that can delete a project.

You can't delete a project that has active resources. You have to deprovision all servers and other infrastructure from a project in order to delete it.

To delete a project, navigate to the Project Settings page and open the Delete panel. You will need to confirm that you want to delete the project.

In the API, you can delete an organization by sending a DELETE request to the /projects/{id} endpoint.

Once a project is deleted, it will not accrue additional charges. any outstanding charges are billed to the organization at the end of the billing cycle.

Frequently
asked questions

Slack

Still stuck?

Join us on Slack

Get support from our team and community members.

Frequently asked questions

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

Copied code to clipboard