Skip to content

Commit

Permalink
docs: rename Packet to Equinix Metal
Browse files Browse the repository at this point in the history
Signed-off-by: Marques Johansson <[email protected]>
  • Loading branch information
displague committed Oct 8, 2020
1 parent ffd0876 commit 5b4bd86
Show file tree
Hide file tree
Showing 23 changed files with 44 additions and 43 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: Bug Report
about: Help us diagnose and fix bugs in the Packet CLI
about: Help us diagnose and fix bugs in the Equinix Metal CLI
labels: bug
---
<!--
Thank you for helping to improve the CLI!
Please be sure to search for open issues before raising a new one.
We use issues for bug reports and feature requests.
Please find us at https://slack.packet.com for questions and discussion.
Please find us at https://slack.equinixmetal.com for questions and discussion.
-->

### What happened?
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Feature Request
about: Help us make the Packet CLI more useful
about: Help us make the Equinix Metal CLI more useful
labels: enhancement
---
<!--
Thank you for helping to improve the CLI!
Please be sure to search for open issues before raising a new one.
We use issues for bug reports and feature requests.
Please find us at https://slack.packet.com for questions and discussion.
Please find us at https://slack.equinixmetal.com for questions and discussion.
-->

### What problem are you facing?
Expand All @@ -18,7 +18,7 @@ Please tell us a little about your use case - it's okay if it's hypothetical!
This context frames the feature request so we can implement it sensibly.
-->

### How could the Packet CLI help solve this problem?
### How could the Equinix Metal CLI help solve this problem?

<!--
Let us know how you think the CLI could help with your use case.
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at support@packet.com. All
reported by contacting the project team at support@equinixmetal.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
4 changes: 2 additions & 2 deletions OWNERS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Owners

This project is governed by [Packet](https://packet.com) and benefits from a community of users that collaborate and contribute to its use in Kubernetes on Packet.
This project is governed by [Equinix Metal](https://metal.equinix.com/) and benefits from a community of users that collaborate and contribute to its use in Kubernetes on Equinix Metal.

Members of the Packet Github organization will strive to triage issues in a timely manner, see [SUPPORT.md](SUPPORT.md) for details.
Members of the Equinix Metal Github organization will strive to triage issues in a timely manner, see [SUPPORT.md](SUPPORT.md) for details.

See the [packethost/standards glossary](https://github.com/packethost/standards/blob/master/glossary.md#ownersmd) for more details about this file.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

[![GitHub release](https://img.shields.io/github/release/packethost/packet-cli/all.svg?style=flat-square)](https://github.com/packethost/packet-cli/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/packethost/packet-cli)](https://goreportcard.com/report/github.com/packethost/packet-cli)
[![Slack](https://slack.packet.com/badge.svg)](https://slack.equinixmetal.com)
[![Slack](https://slack.equinixmetal.com/badge.svg)](https://slack.equinixmetal.com)
[![Twitter Follow](https://img.shields.io/twitter/follow/packethost.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=equinixmetal)
![](https://img.shields.io/badge/Stability-Maintained-green.svg)

This repository is [Maintained](https://github.com/packethost/standards/blob/master/maintained-statement.md) meaning that this software is supported by Equinix Metal and its community - available to use in production environments.

## Table of Contents

* [Packet Command Line Interface](#packet-command-line-interface)
* [Equinix Metal Command Line Interface](#packet-command-line-interface)
* [Requirements](#requirements)
* [Supported Platforms](#supported-platforms)
* [Installation](#installation)
Expand All @@ -23,24 +23,26 @@ This repository is [Maintained](https://github.com/packethost/standards/blob/mas
* [Example Syntax](#example-syntax)
* [Support](#support)

## Packet Command Line Interface
## Equinix Metal Command Line Interface

[Packet](https://www.packet.net/) provides an API-driven bare metal platform that combines the automation experience of the cloud with the benefits of physical, bare metal servers.
[Packet is now Equinix Metal!](https://blog.equinix.com/blog/2020/10/06/equinix-metal-metal-and-more/), keep an eye on this project for future project and command line name changes.

The Packet CLI wraps the [Packet Go SDK](https://github.com/packethost/packngo) allowing interaction with Packet platform from a command-line interface.
[Equinix Metal](https://metal.equinix.com/) provides an API-driven bare metal platform that combines the automation experience of the cloud with the benefits of physical, bare metal servers.

The Equinix Metal CLI wraps the [Equinix Metal Go SDK](https://github.com/packethost/packngo) allowing interaction with Equinix Metal platform from a command-line interface.

## Requirements

* Packet authentication token.
* Packet CLI [binaries](https://github.com/packethost/packet-cli/releases).
* Equinix Metal authentication token.
* Equinix Metal CLI [binaries](https://github.com/packethost/packet-cli/releases).

## Supported Platforms

The [Packet CLI binaries](https://github.com/packethost/packet-cli/releases) are available for Linux, Windows, and Mac OS X for various architectures including ARM on Linux.
The [Equinix Metal CLI binaries](https://github.com/packethost/packet-cli/releases) are available for Linux, Windows, and Mac OS X for various architectures including ARM on Linux.

## Installation

Download the appropriate Packet CLI binaries for your platform to the desired location and rename it to `packet`. If the directory is not already in your `PATH` environment variable, then it will need to be added.
Download the appropriate Equinix Metal CLI binaries for your platform to the desired location and rename it to `packet`. If the directory is not already in your `PATH` environment variable, then it will need to be added.

### Configuring your Path

Expand All @@ -49,7 +51,7 @@ Download the appropriate Packet CLI binaries for your platform to the desired lo

## Linux

If you plan to run the Packet CLI in a shell on Linux and placed the binary in /home/YOUR-USER-NAME/packet-cli/, then type the following into your terminal:
If you plan to run the Equinix Metal CLI in a shell on Linux and placed the binary in /home/YOUR-USER-NAME/packet-cli/, then type the following into your terminal:

```
export PATH=$PATH:/home/$USER/packet-cli
Expand All @@ -67,7 +69,7 @@ echo $PATH

### Mac OS X

If you plan to run the Packet CLI in a shell on a Mac, download the `darwin` binary and placed the it in /Users/YOUR-USER-NAME/packet-cli/, then type the following into your terminal.
If you plan to run the Equinix Metal CLI in a shell on a Mac, download the `darwin` binary and placed the it in /Users/YOUR-USER-NAME/packet-cli/, then type the following into your terminal.

```
export PATH=$PATH:/Users/$USER/packet-cli
Expand All @@ -92,7 +94,7 @@ The binary can be trusted by enabling "App Store and identified developers" in "

### Windows

If you plan to run the Packet CLI in PowerShell on Windows and placed the binary in c:\packet-cli, then type the following into PowerShell:
If you plan to run the Equinix Metal CLI in PowerShell on Windows and placed the binary in c:\packet-cli, then type the following into PowerShell:

```
$env:Path += ";c:\packet-cli"
Expand All @@ -114,7 +116,7 @@ Check `packet completion -h` for instructions to use in other shells.

## Authentication

The Packet authentication token can be stored in the `$PACKET_TOKEN` environment variable or in JSON or YAML configuration files. The configuration file path can be overridden with the `--config` flag.
The Equinix Metal authentication token can be stored in the `$PACKET_TOKEN` environment variable or in JSON or YAML configuration files. The configuration file path can be overridden with the `--config` flag.

Environment variable:

Expand All @@ -138,12 +140,12 @@ JSON configuration file - `$HOME/.packet-cli.json`:
}
```

After installing Packet CLI, verify the installation by executing `packet` or `packet.exe`. You should see the default output:
After installing Equinix Metal CLI, verify the installation by executing `packet` or `packet.exe`. You should see the default output:


```bash
$ packet
Command line interface for Packet Host
Command line interface for Equinix Metal
Usage:
packet [command]
Expand Down Expand Up @@ -172,7 +174,7 @@ Use "packet [command] --help" for more information about a command.

## Includes and Excludes

Packet API resource responses may have related resources. These related
Equinix Metal API resource responses may have related resources. These related
resources can be embedded in the result or referred. Referred resources will
only include a `Href` value, which includes the unique ID of the resource.
Embedded resources will be represented with their full API value, which may
Expand Down
4 changes: 2 additions & 2 deletions docs/packet.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## packet

Command line interface for Packet Host
Command line interface for Equinix Metal

### Synopsis

Command line interface for Packet Host
Command line interface for Equinix Metal

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/packet_2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Two Factor Authentication operations: enable, disable, receive

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet 2fa disable](packet_2fa_disable.md) - Disables two factor authentication
* [packet 2fa enable](packet_2fa_enable.md) - Enables two factor authentication
* [packet 2fa receive](packet_2fa_receive.md) - Receive two factor authentication token
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_capacity.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Capacities operations: get, check

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet capacity check](packet_capacity_check.md) - Validates if a deploy can be fulfilled.
* [packet capacity get](packet_capacity_get.md) - Returns a list of facilities and plans with their current capacity.

2 changes: 1 addition & 1 deletion docs/packet_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Device operations: create, delete, update, start/stop, reboot and get.

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet device create](packet_device_create.md) - Creates a device
* [packet device delete](packet_device_delete.md) - Deletes a device
* [packet device get](packet_device_get.md) - Retrieves device list or device details
Expand Down
1 change: 0 additions & 1 deletion docs/packet_device_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ packet device create [flags]
-v, --public-ipv4-subnet-size int Size of the public IPv4 subnet
-I, --spot-instance Set the device as a spot instance
-m, --spot-price-max float --spot-price-max=1.2 or -m=1.2
-s, --storage string UUID of the storage
-t, --tags strings Tags for the device: --tags="tag1,tag2"
-T, --termination-time string Device termination time: --termination-time="15:04:05"
-u, --userdata string Userdata for device initialization (can not be used with --userdata-file)
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Events operations: get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet event get](packet_event_get.md) - Retrieves one or more events for organizations, projects, or devices.

2 changes: 1 addition & 1 deletion docs/packet_facilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Facility operations: get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet facilities get](packet_facilities_get.md) - Retrieves a list of available facilities.

2 changes: 1 addition & 1 deletion docs/packet_hardware-reservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Hardware reservation operations: get, move

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet hardware-reservation get](packet_hardware-reservation_get.md) - Retrieves all hardware reservations of a project or a single hardware reservation
* [packet hardware-reservation move](packet_hardware-reservation_move.md) - Move hardware reservation to another project

2 changes: 1 addition & 1 deletion docs/packet_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ IP address, reservations and assignment operations: assign, unassign, remove, av

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet ip assign](packet_ip_assign.md) - Assigns an IP address to a given device
* [packet ip available](packet_ip_available.md) - Retrieves a list of IP resevations for a single project.
* [packet ip get](packet_ip_get.md) - Retrieves information about IP addresses, IP reservations and IP assignments
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_operating-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Operating system operations: get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet operating-systems get](packet_operating-systems_get.md) - Retrieves a list of available operating systems.

2 changes: 1 addition & 1 deletion docs/packet_organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Organization operations: create, update, delete and get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet organization create](packet_organization_create.md) - Creates an organization
* [packet organization delete](packet_organization_delete.md) - Deletes an organization
* [packet organization get](packet_organization_get.md) - Retrieves an organization or list of organizations
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Plan operations: get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet plan get](packet_plan_get.md) - Retrieves a list of all available plans.

2 changes: 1 addition & 1 deletion docs/packet_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Project operations: create, delete, update and get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet project create](packet_project_create.md) - Creates a project
* [packet project delete](packet_project_delete.md) - Deletes a project
* [packet project get](packet_project_get.md) - Retrieves all available projects or a single project
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_ssh-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ SSH key operations: create, delete, update and get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet ssh-key create](packet_ssh-key_create.md) - Creates an SSH key
* [packet ssh-key delete](packet_ssh-key_delete.md) - Deletes an SSH key
* [packet ssh-key get](packet_ssh-key_get.md) - Retrieves a list of available SSH keys or a single SSH key
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ User operations: get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet user get](packet_user_get.md) - Retrieves information about the current user or a specified user

2 changes: 1 addition & 1 deletion docs/packet_virtual-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Virtual network operations: create, delete and get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet virtual-network create](packet_virtual-network_create.md) - Creates a virtual network
* [packet virtual-network delete](packet_virtual-network_delete.md) - Deletes a Virtual Network
* [packet virtual-network get](packet_virtual-network_get.md) - Retrieves a list of virtual networks for a single project.
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Volume operations: create, delete, attach, detach and get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet volume attach](packet_volume_attach.md) - Attaches a volume to a device.
* [packet volume create](packet_volume_create.md) - Creates a volume
* [packet volume delete](packet_volume_delete.md) - Deletes a volume
Expand Down
2 changes: 1 addition & 1 deletion docs/packet_vpn.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ VPN service operations: enable, disable, get

### SEE ALSO

* [packet](packet.md) - Command line interface for Packet Host
* [packet](packet.md) - Command line interface for Equinix Metal
* [packet vpn disable](packet_vpn_disable.md) - Disables VPN service
* [packet vpn enable](packet_vpn_enable.md) - Enables VPN service
* [packet vpn get](packet_vpn_get.md) - Retrieves VPN service
Expand Down

0 comments on commit 5b4bd86

Please sign in to comment.