1. Scanning frequencies can be scheduled (e.g. once, daily, weekly, monthly) or run ad-hoc

[madelondohmen]

About this feature

Milestone item

1 scanning frequencies.

Detailed description

Add detailed description of the new feature you'd like to propose. If this feature is related to a problem, what problem does it solve?

Scope

• Item1
• Item2

Out of scope

• Item1
• Item2

Related tickets

• Flexible scheduling #204
• Export setup - report schedule #2779
• As a user I want to view my scheduled reports #2974

[jpbruinsslot]

Can the scope and requirements for this ticket be fleshed out?

[underdarknl]

Per boefje variant the user can select an interval in which the boefje (for the given organisation) needs to be scheduled per OOI that it consumes.
The same goes for Scheduled reports.

[jpbruinsslot]

@underdarknl does this mean:

A: a user defines an interval schedule on a boefje detail page for that particular boefje to run?
B: a user defines an interval schedule for a boefje and ooi combination?

[underdarknl]

It means Case A.
The boefje itself will carry a default interval in its boefje.json, which can be overwritten by the user on a 'per organisation' basis.

Scanning individual assets with the same boefje on different interval's is not part of the MVP.

[jpbruinsslot]

Implementation suggestion:

katalogus pov:

• boefje.json with optional interval

rocky pov:

• update interval of plugin
  • PATCH associated schedule for plugin in scheduler
  • update boefje.json ?

scheduler pov:

• cold start
  • when the schedulers start it will gather all enabled plugins
  • for every plugin with a defined interval create a schedule
• enabled/disabled plugins
  • whenever a plugin gets enabled with a defined interval create a schedule
  • whenever a plugin gets disabled with a defined interval remove (disabled) its associated schedule

[underdarknl]

related: #1317

[underdarknl]

The boefje.json is stored per install, and as such should not be changed when dealing with a new interval.
The specific boefje settings are stored per organisation (eg, is it enabled, what other settings are needed), and should be updated.

[jpbruinsslot]

• Updated the implementation suggestion above
• Created poc pull request here for the scheduler Boefje scanning frequency support in scheduler #3406

blocked by unimplemented boefje.json

[jpbruinsslot]

From discussion meet held on 3 September 2024:

• an interval setting (cron expression) is being added to a boefje manifest
  • When a boefje is enabled that has a interval setting a Schedule is created for that boefje
  • That specific boefje (without associated ooi's!) will be put on the queue
  • The task runner will run that boefje.
• a field (cron expression) that defines the interval of a boefje is added to the katalogus, this field can be updated
  • when updated in katalogus, also needs to be updated in the scheduler through a PUT request to the scheduler