Chaperone Permissions and Responses

Owned by Eddie Webbinaro
Last updated: Sept 16, 2016
1 min read

With admin config set, agents may poll the permission endpoint. It is important client agents respect all the rules outlined here.

Sample Response
PCODE=UH_OH
PMESSAGE="Records indicate this agents is already upgrading, but has since asked for permission! Please mark the provided task complete before requesting additonal work."
PVERSION=LATEST
ENABLED=false
BUSY=false
TASK=6


NO_CHILD

This means the client agent should not make any changes, and continue to take jobs on the current version.


Set the system state to STABLE in the admin configuration to return this response.


WAIT_FOR_SIBLINGS

This is returned when updates are allowed, but too many other clients are already marked in progress.

Adjust the "Max. Count" value in the admin configuration to define the threshold for this response.



YES_CHILD

This is returned when updates are allowed, the client agent should now monitor the BUSY status returned by this and the agent status api to make sure any running jobs completed.

Agents MUST mark the TASK returned from this code and subsequently call the /finish/<taskId> endpoint once they are ready to resume. Failure to do this will prevent future updates. (see UH_OH code below)


UH_OH


This is an error. Client agents should print PCODE and PMESSAGE for details.

Most times this will be failure to mark a previous task for this agent complete. Call the /finish/taskId endpoint to mark it complete.