Rivet.Pool reference

Pool

Source: packages/rivet/src/Pool.ts

A node pool on a Rivet control plane. Nodes that connect with the pool’s name host its actors; the control plane rejects nodes whose pool does not exist. Pool Layers (RivetDocker.SwarmPool, …) create one for the nodes they run, so declare one directly only for nodes Alchemy does not deploy.

Pool: Creating a pool

const pool = yield* Rivet.Pool("Nodes", {
  endpoint: "https://rivet.example.com",
  token: Redacted.make(adminToken),
  namespace: namespace.name,
});

Pool: Draining on upgrade

const pool = yield* Rivet.Pool("Nodes", {
  endpoint: "https://rivet.example.com",
  token: Redacted.make(adminToken),
  namespace: namespace.name,
  drainOnVersionUpgrade: true,
  actorEvictionPeriod: 60,
});