From 5fdcbf085f5d58d87830849117a549574f26e2ab Mon Sep 17 00:00:00 2001 From: Elijah Voigt Date: Mon, 3 Oct 2022 12:08:24 -0700 Subject: [PATCH] Docs(job-specification/periodic): Add enabled toggle (#14767) This is probably undocumented for a reason, but the `enabled` toggle in the `periodic` stanza is very useful so I figured I try adding it to the docs. The feature has been secretly avaliable since #9142 and was called out in that PR as being a dubious addition, only added to avoid regressions. The use case for disabling a periodic job in this way is to prevent it from running without modifying the schedule. Ideally Nomad would make it more clear that this was the case, and allow you to force a run of the job, but even with those rough edges I think users would benefit from knowing about this toggle. --- website/content/docs/job-specification/periodic.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/content/docs/job-specification/periodic.mdx b/website/content/docs/job-specification/periodic.mdx index 1d0c837e7..6e2df33ff 100644 --- a/website/content/docs/job-specification/periodic.mdx +++ b/website/content/docs/job-specification/periodic.mdx @@ -48,6 +48,10 @@ consistent evaluation when Nomad spans multiple time zones. be parsable by Golang's [LoadLocation](https://golang.org/pkg/time/#LoadLocation). +- `enabled` `(bool: true)` - Specifies if this job should run. This not only + prevents this job from running on the `cron` schedule but prevents force + launches. + ## `periodic` Examples The following examples only show the `periodic` stanzas. Remember that the