DOCS-4112: Document machine job scheduling functionality with JobConfig #4426
+268
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on PR RSDK-10963, document the new machine job scheduling functionality that allows users to configure automated jobs that run on machines at specified intervals. This PR adds the JobConfig definition to the robot.proto file, enabling users to schedule recurring tasks on their machines.
New Job Scheduling Features:
Key Configuration Options:
name
: Unique identifier for each scheduled jobschedule
: Unix-cron string (e.g., "0 */6 * * *") or Golang duration (e.g., "5m", "1h") for job intervalsresource
: Target resource name for the job executionmethod
: Specific gRPC method to call on the resourcecommand
: Optional command arguments for DoCommand-based operationsUse Cases:
The documentation should cover configuration examples, scheduling syntax, troubleshooting, and best practices for implementing reliable scheduled jobs on Viam machines. This represents a significant new capability for automating machine operations and reducing manual intervention requirements.
Trigger Events
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)