HOWTO: Use a Manual Gate in a Module Run¶
Purpose: Declare, trigger, and complete a manual gate in a HybridOps module run, with full audit capture of the sign-off decision.
Difficulty: Intermediate
Track: Verification-Driven Operations
Overview¶
Not every decision in a production operation should be automated. Manual gates give operators a structured, auditable way to pause execution, review state, and sign off before a module continues: without breaking the run record or losing execution context. This HOWTO covers the full gate lifecycle from declaration to sign-off.
1. Declaring a Gate in the Module Contract¶
- Gate declaration schema.
- Pre-gate run-record requirements.
- Timeout and escalation policy.
2. The Pause State¶
- What HybridOps does when it reaches a gate.
- CLI output during pause.
- Inspecting pre-gate run records before deciding.
3. Resuming After Approval¶
- Approving via CLI:
hyops gate approve. - Capturing approver identity and justification.
- How the approval is written into the run record.
4. Rejecting and Aborting¶
- Declining at a gate:
hyops gate reject. - Rollback behaviour on rejection.
- Recording the rejection reason in the run record.
5. External Approval Workflow Integration¶
- GitHub PR review as a gate trigger.
- Jira change ticket linkage.
- Webhook-based approval for custom workflows.
References¶
License: MIT-0 for code, CC-BY-4.0 for documentation unless otherwise stated.