From 523a98f906b39c3b73d1cfae9bd749722da335da Mon Sep 17 00:00:00 2001 From: wizzdom Date: Sat, 27 Jan 2024 04:40:13 +0000 Subject: [PATCH] add node pool docs --- cluster-config/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cluster-config/README.md b/cluster-config/README.md index cad29ad..518d9fe 100644 --- a/cluster-config/README.md +++ b/cluster-config/README.md @@ -3,3 +3,9 @@ This directory contains configuration relating to the configuration of the cluster including: - node pools - agent config + +## Node Pools + +[Node pools](https://developer.hashicorp.com/nomad/docs/concepts/node-pools) are a way to group nodes together into logical groups which jobs can target that can be used to enforce where allocations are placed. + +e.g. [`ingress-pool.hcl`](./ingress-pool.hcl) is a node pool that is used for ingress nodes such as the [bastion-vm](https://docs.redbrick.dcu.ie/aperture/bastion-vm/). Any jobs that are defined to use `node_pool = "ingress"` such as `traefik.hcl` and `gate-proxy.hcl` will only be assigned to one of the nodes in the `ingress` node pool (i.e. the [bastion VM](https://docs.redbrick.dcu.ie/aperture/bastion-vm/))