nautobot-app-circuit-maintenance icon indicating copy to clipboard operation
nautobot-app-circuit-maintenance copied to clipboard

Create a JobHook to mitigate circuit maintenance according to schedule

Open chadell opened this issue 1 year ago • 0 comments

Environment

  • nautobot-circuit-maintenance version: 0.6.2

Proposed Functionality

Offer a framework to trigger maintenance mitigation tasks before, and after, a circuit maintenance.

Use Case

Nautobot offers all the pieces to implement a mitigation process around a circuit maintenance event, so this app could allow to implement it.

A potential workflow could look like be:

  1. When a circuit maintenance is created a scheduled Job would be triggered to run X minutes before the event, and Y minutes after (X and Y configurable). If deleted or updated, the scheduled jobs would be removed or updated respectively. This could leverage directly on the JobHook functionality.
  2. This placeholder job would contain a logic hook where every operator would decide what does it mean the mitigation policy. For instance, someone would simply integrate with the monitoring and alerting system to mute the related alerts for the affected circuits. Someone else could like to shutdown BGP neighbors that are related to a circuit (this could be easily achieved with the Nautobot BGP app and a custom relationship).
  3. The circuits/providers could have a custom attribute to allow automatic mitigation or not.

chadell avatar Mar 02 '23 09:03 chadell