From ecc768b538bd6dc17a01b41d37a26bc1cea4f742 Mon Sep 17 00:00:00 2001 From: Chris Privitere <23177737+cprivitere@users.noreply.github.com> Date: Fri, 9 Sep 2022 14:09:49 -0500 Subject: [PATCH] Update Equinix Metal quick start tab. Signed-off-by: Chris Privitere <23177737+cprivitere@users.noreply.github.com> --- docs/book/src/user/quick-start.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md index 7cb6309ecbe0..f205a26a452f 100644 --- a/docs/book/src/user/quick-start.md +++ b/docs/book/src/user/quick-start.md @@ -699,23 +699,30 @@ export ENABLE_POD_SECURITY_STANDARD="false" {{#/tab }} {{#tab Equinix Metal}} -There are a couple of required environment variables that you have to expose in -order to get a well tuned and function workload, they are all listed here: +There are several required variables you need to set to create a cluster. There +are also a few optional tunables if you'd like to change the OS or CIDRs used. ```bash +# Required (made up examples shown) # The project where your cluster will be placed to. # You have to get one from the Equinix Metal Console if you don't have one already. -export PROJECT_ID="5yd4thd-5h35-5hwk-1111-125gjej40930" +export PROJECT_ID="2b59569f-10d1-49a6-a000-c2fb95a959a1" # The facility where you want your cluster to be provisioned -export FACILITY="ewr1" -# The operatin system used to provision the device +export FACILITY="da11" +# What plan to use for your control plane nodes +export CONTROLPLANE_NODE_TYPE="m3.small.x86" +# What plan to use for your worker nodes +export WORKER_NODE_TYPE="m3.small.x86" +# The ssh key you would like to have access to the nodes +export SSH_KEY="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDvMgVEubPLztrvVKgNPnRe9sZSjAqaYj9nmCkgr4PdK username@computer" +export CLUSTER_NAME="my-cluster" + +# Optional (defaults shown) export NODE_OS="ubuntu_18_04" -# The ssh key name you loaded in the Equinix Metal Console -export SSH_KEY="my-ssh" export POD_CIDR="192.168.0.0/16" export SERVICE_CIDR="172.26.0.0/16" -export CONTROLPLANE_NODE_TYPE="t1.small" -export WORKER_NODE_TYPE="t1.small" +# Only relevant if using the kube-vip flavor +export KUBE_VIP_VERSION="v0.5.0" ``` {{#/tab }}