Skip to content

TASK-144646: Documentation for new curfew module (SparkPost/Momentum#…#845

Open
dkoerichbird wants to merge 6 commits into
mainfrom
Momentum#1228_curfew_module_documentation
Open

TASK-144646: Documentation for new curfew module (SparkPost/Momentum#…#845
dkoerichbird wants to merge 6 commits into
mainfrom
Momentum#1228_curfew_module_documentation

Conversation

@dkoerichbird
Copy link
Copy Markdown
Contributor

@dkoerichbird dkoerichbird commented May 21, 2026

…1228)


Note

Low Risk
Documentation-only changes with no runtime or configuration behavior in this repo.

Overview
Adds documentation for the Momentum 5.3 curfew module (I-1228): scheduled quiet hours that suspend outbound delivery for chosen bindings, binding groups, or domains via a crontab-style schedule file, as an alternative to toggling suspend_delivery from cron.

A new curfew.md page covers configuration (Schedule_File, Timezone, Fuzz_Seconds), schedule file syntax, precedence vs static suspension / Lua / adaptive, logging, and console commands (reload, show, status, fuzz, journal). Index pages are updated: console-commands table, config-options summary (curfew scope and related options), modules index, all-modules summary, and the 5.3.0 changelog entry.

Reviewed by Cursor Bugbot for commit 2facc24. Bugbot is set up for automated code reviews on this repo. Configure here.

…1228)

Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 2facc24
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6a1f448e3d9b5b0008cb07be
😎 Deploy Preview https://deploy-preview-845--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
Comment thread content/momentum/4/modules/curfew.md
Comment thread content/momentum/4/modules/curfew.md Outdated
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
@dkoerichbird dkoerichbird requested a review from deepakpn May 22, 2026 13:08
Comment thread content/momentum/4/modules/curfew.md Outdated

The `curfew` module schedules *quiet hours* (blackout windows) during which Momentum will not attempt deliveries for selected bindings, binding groups, or domains. The schedule is expressed in crontab-style syntax and is read from a plain-text file.

Curfew replaces *ad-hoc* operator workflows that toggle [`suspend_delivery`](/momentum/4/config/ref-suspend-delivery), e.g., from external cron jobs. Driving suspension state from outside the MTA is fragile: a missed cron firing can leave messages stuck on the spool, and a race between the cron job and a configuration commit can leave the binding suspended forever. Curfew evaluates its rules from inside the suspension decision path on every delivery attempt, so quiet hours engage and lift on schedule without operator intervention and without persistent state changes to the binding/domain scope.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the above para needed. We implemented curfew as a external cron jobs, using suspension. This is a new feature for customer.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworded, please take a second look. Yeah, that would be a new feature for on-prem customers.

…#1228)

Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
@dkoerichbird dkoerichbird requested a review from balupillai June 2, 2026 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants