Skip to content

Commit f94635a

Browse files
authored
Merge pull request #7207 from cprivitere/update-quickstart-eqmetal
📖 Update Equinix Metal quick start tab.
2 parents ec28554 + 2e2a0f6 commit f94635a

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/book/src/user/quick-start.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -699,23 +699,30 @@ export ENABLE_POD_SECURITY_STANDARD="false"
699699
{{#/tab }}
700700
{{#tab Equinix Metal}}
701701
702-
There are a couple of required environment variables that you have to expose in
703-
order to get a well tuned and function workload, they are all listed here:
702+
There are several required variables you need to set to create a cluster. There
703+
are also a few optional tunables if you'd like to change the OS or CIDRs used.
704704
705705
```bash
706+
# Required (made up examples shown)
706707
# The project where your cluster will be placed to.
707708
# You have to get one from the Equinix Metal Console if you don't have one already.
708-
export PROJECT_ID="5yd4thd-5h35-5hwk-1111-125gjej40930"
709+
export PROJECT_ID="2b59569f-10d1-49a6-a000-c2fb95a959a1"
709710
# The facility where you want your cluster to be provisioned
710-
export FACILITY="ewr1"
711-
# The operatin system used to provision the device
711+
export FACILITY="da11"
712+
# What plan to use for your control plane nodes
713+
export CONTROLPLANE_NODE_TYPE="m3.small.x86"
714+
# What plan to use for your worker nodes
715+
export WORKER_NODE_TYPE="m3.small.x86"
716+
# The ssh key you would like to have access to the nodes
717+
export SSH_KEY="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDvMgVEubPLztrvVKgNPnRe9sZSjAqaYj9nmCkgr4PdK username@computer"
718+
export CLUSTER_NAME="my-cluster"
719+
720+
# Optional (defaults shown)
712721
export NODE_OS="ubuntu_18_04"
713-
# The ssh key name you loaded in the Equinix Metal Console
714-
export SSH_KEY="my-ssh"
715722
export POD_CIDR="192.168.0.0/16"
716723
export SERVICE_CIDR="172.26.0.0/16"
717-
export CONTROLPLANE_NODE_TYPE="t1.small"
718-
export WORKER_NODE_TYPE="t1.small"
724+
# Only relevant if using the kube-vip flavor
725+
export KUBE_VIP_VERSION="v0.5.0"
719726
```
720727
721728
{{#/tab }}

0 commit comments

Comments
 (0)