From 22782f8c5f8c89103f68f1d709ccbaa57913f735 Mon Sep 17 00:00:00 2001 From: Alan Rominger Date: Fri, 3 Sep 2021 10:35:29 -0400 Subject: [PATCH] Add wording about expectations for enabled status and default group (#10993) * Add wording about expections for enabled status and default group * fix pluralization Co-authored-by: Alex Corey * Correct grammar mistake Co-authored-by: Alex Corey --- docs/receptor_mesh.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/receptor_mesh.md b/docs/receptor_mesh.md index 80f8fc8e38..6a3a816d77 100644 --- a/docs/receptor_mesh.md +++ b/docs/receptor_mesh.md @@ -73,7 +73,11 @@ Control nodes check the receptor network (reported via `receptorctl status`) whe Nodes on the receptor network are compared against the `Instance` model in the database. If a node appears in the mesh network which is not in the database, then a "health check" is started. -The `capacity` field will obtain a non-zero value through this process, which is necessary to run jobs. +Fields like `cpu`, `memory`, and `version` will obtain a non-default value through this process. + +In order to run jobs on execution nodes, either the installer needs to pre-register the node, +or user needs to make a PATCH request to `/api/v2/instances/N/` to change the `enabled` field to true. +Execution nodes should automatically be placed in the default instance group. #### Health Check Mechanics