Hybrid-Nodes

Hybrid nodes deployment on Equinix Platform

This Terraform script provides hybrid nodes deployments on Equinix Metal platform where one node is deployed as the front-end node in layer-3/layer-2 Hybrid bonded mode and the reset of the nodes are deployed as the backend nodes in layer-2 bonded mode.

For information regarding Layer-3/2 hybrid bonded mode, please see the following document - https://metal.equinix.com/developers/docs/layer2-networking/hybrid-bonded-mode/. For the Layer-2 bonded mode, please see the following Equinix Metal document - https://metal.equinix.com/developers/docs/layer2-networking/layer2-mode/#pure-layer-2-modes

The frontend node can access the internet directly while the backend nodes can only access the internet via frontend. There are two VLANs in this configuration. The first VLAN is shared by the frontend and the backend nodes while the second VLAN is only shared by the backend nodes. The first VLAN is hardcoded using 192.168.100.0/24 for IP assignments with frontend being assigned with 192.168.100.1. The second VLAN is hardcoded using 169.254.254.0/24 for IP assigments among the backend nodes.

After the nodes are sucessfully deployed, the following behaviors are expected:

1. The frontend node can ping internet, for example, $ping 1.1.1.1
2. The frontend node can ping the backend node via 192.168.100.x, for example, $ping 192.168.100.2
3. A backend node can ping internet, for example, $ping 1.1.1.1
4. A backend node can ping the frontend via 192.168.100.1
5. A backend node can ping another backend node via 169.254.254.x, for example, $ping 169.254.254.2

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.

Download this project

To download and start using this project, run the following command:

git clone https://github.com/equinix-labs/terraform-metal-hybrid-gateway.git
cd terraform-metal-hybrid-gateway

Using Terraform Modules

With your Equinix Metal account, project, and a User API token, you can use Terraform v1+ to install a proof-of-concept demonstration environment for EKS-A on Baremetal.

Initialize Terraform

Enter the examples/simple directory. This directory has a configuration that consumes the project as a Terraform module.

$ cd examples/simple

Terraform uses modules to deploy infrastructure. In order to initialize the modules you simply run: terraform init. This will download providers and modules into a hidden directory .terraform

Modify your variables

See variables.tf for a description of each variable. You will need to set the auth_token and project_id variables at a minimum:

cp terraform.tfvars.example terraform.tfvars
vim terraform.tfvars

Note - Currently only Ubuntu is supported; Only Gen# 3 server plans support hybrid bonded mode.

Deploy terraform template

terraform apply --auto-approve

Once this is complete you should get output similar to this:

Apply complete! Resources: 31 added, 0 changed, 0 destroyed.

Outputs:

backend_nodes = [
  "backend-1",
  "backend-2",
  "backend-3",
  "backend-4",
  "backend-5",
]
frontend_IP = "145.40.80.131"
frontend_name = "front-end"
metrovlan_ids = [
  1002,
  1003,
]