Equinix

The Cubbit CLI is a command-line tool designed to streamline the process of deploying Cubbit nodes on Equinix's data center infrastructure. It automates the provisioning of nodes, installation of the Cubbit operating system, and joining them to a Cubbit swarm. This guide provides a comprehensive overview of the tool's usage and functionalities.

Obtaining the CLI

The Cubbit CLI is not publicly available yet; you must contact Cubbit support to obtain it. Cubbit support will verify your eligibility for the tool and provide you with the necessary instructions for installation.

Command syntax

The Cubbit CLI utilizes a straightforward syntax to execute its functions. The primary command format is as follows:

cubbit-cli <swarm-name> <node_count> equinix <node_type> <location> [<offset>]

Here's a breakdown of each parameter:

• <swarm-name>: The name of the Cubbit swarm to which the new nodes will be added.
• <node_count>: The number of nodes to deploy.
• equinix: The provider to use for node provisioning.
• <node_type>: The type of nodes to deploy. Equinix offers various node configurations, such as bare-metal servers, virtual machines, and high-performance computing (HPC) setups.
• <location>: A comma-separated list of Equinix data center metro codes where the nodes should be provisioned. Equinix operates data centers worldwide, and the specific locations depend on your requirements. For example, to deploy 2 bare-metal nodes with high-performance specifications in Equinix's Frankfurt and Amsterdam data centers, you would use the following command:

cubbit-cli my-swarm 2 equinix m3.large.x86 FR,AM

• The optional <offset> parameter allows you to extend an existing configuration by adding nodes to an already existing swarm. It specifies the index of the first node in the existing configuration where the new nodes should be added

Output

The Cubbit CLI generates Terraform code that you need to execute to finalize the infrastructure setup.

Running Terraform code

To deploy the infrastructure using the generated Terraform code, you can follow these steps:

1. Install Terraform on your local machine. 2. Go into the output directory generated by the Cubbit CLI.
2. Initialize Terraform in the directory: terraform init
3. Apply the Terraform configuration: terraform apply

This will provision the Cubbit nodes. Once the deployment is complete, your Cubbit cluster will be ready to use.

Automated OS Installation

The Cubbit CLI automatically installs the Cubbit operating system on the provisioned nodes, ensuring they are ready to join the Cubbit swarm immediately. This eliminates the need for manual OS installations and reduces deployment time.

Seamless Swarm Integration

Once the nodes are provisioned and their operating systems are installed, the Cubbit CLI automatically joins them to the specified Cubbit swarm. This enables them to participate in data replication, forming a robust and resilient storage infrastructure.

Benefits of Using Cubbit CLI

The Cubbit CLI offers several advantages for managing Cubbit nodes on Equinix:

• Simplified Deployment: Automates node provisioning, OS installation, and swarm integration, reducing manual effort and errors.
• Faster Deployment: Eliminates the need for manual OS installations and Terraform configurations, significantly accelerating deployment times.
• Simplified Infrastructure Management: Provides a Terraform-based output for managing and scaling the infrastructure beyond the initial deployment.
• Streamlined Workflow: Combines node provisioning, OS installation, and infrastructure configuration into a single process, streamlining your Cubbit ecosystem management.