Docs(job-specification/periodic): Add enabled toggle #14767
Conversation
|
Deployment failed with the following error: |
tgross
added
theme/docs
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 hashicorp#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.
tgross
force-pushed
the
pop/document-periodic-enabled
branch
from
5e01129 to
8d0a99c
Compare
There was a problem hiding this comment.
Hi @pop! Thanks for opening this... in retrospect I regret the notion of having undocumented behaviors like this. So 👍
There's was something weird about the commits you had in this PR, where an older version of the repo had been merged on top of the content here, and that broke the docs builder I've taken your commit and cherry-picked it onto a clean branch and then pushed onto this PR. Once the docs builder is green I can get this merged. Thanks!
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
This is probably undocumented for a reason, but the
enabledtoggle in theperiodicstanza 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 in the update to hcl2.
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.