DivvyCloud

Welcome to the DivvyCloud Docs!

DivvyCloud is a Cloud Security Posture Management (CSPM) platform that provides real-time analysis and automated remediation across leading cloud and container technologies.

For questions about documentation reach out to us [email protected]

Take Me to the Docs!    Release Notes

Scheduled Events

Overview

DivvyCloud bots can spawn jobs that run at specified times with specified arguments. These jobs are called scheduled events.

Registration

A job is registered as a scheduled event using the register method of the ScheduledEventManager class, which acts as a class decorator. For example, this is how the StartResourceJob scheduled event is registered in DivvyCloud:

from DivvyWorkers.Processors.ScheduledEvents import ScheduledEventManager
@ScheduledEventManager.register('divvy.start_resource')
class StartResourceJob(MultiResourceScheduledEventJob):
    ...

The scheduled event can then be referred to using the unique identifier defined in the register decorator, in this case divvy.start_resource.

Here is an example of how to spawn a scheduled event within a bot action:

from DivvyBotfactory.scheduling import ScheduledEventTracker

@registry.action(
    uid='divvy.action.start_resource_example',
    bulk_action=True,
    accepts_complement=True,
    ...
)
def start_resource_example(bot, settings, matches, non_matches):
    with ScheduledEventTracker() as context:
        for resource in matches:
            context.schedule_bot_event(
                bot=bot, resource=resource,
                description='Start a resource.',
                event_type='divvy.start_resource'
                schedule_data=schedule.Once(when=datetime.utcnow() + timedelta(hours=12))
            )

Dynamic Loading and Unloading

When developing a plugin that DivvyCloud dynamically loads and unloads, it is necessary to unload the plugin’s scheduled events. This can be conveniently done using the ScheduledEventRegistryWrapper class, which requires only a minor variation upon the pattern shown above.

An example:

from DivvyWorkers.Processors.ScheduledEvents import ScheduledEventRegistryWrapper

# Initialize the registry wrapper
events = ScheduledEventRegistryWrapper()

# Register a scheduled event job
events.register('divvy.start_resource')
class StartResourceJob(MultiResourceScheduledEventJob):
    ...

# Handle plugin loading/unloading
def load():
    events.load()
def unload():
    events.unload()

A scheduled event registered this way is created and referred to in the same way as before. The only difference is in the specific syntax of how that event is registered.

Updated 2 months ago

Scheduled Events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.