Scheduler¶

The OpenSVC agent embeds a scheduler. The node and each service has a private schedule.

Scheduler Behaviour¶

For each task, the scheduler determines if the current time meets the task’s schedule definition constraints. If all constraints are met, the task action is run in a subprocess and the last run timestamp is updated.

The schedule definition constraints are expressed as allowed timeranges and minimum period. Example: In 00:00-02:00@121, the timerange is from midnight to 2am, the period is 121 minutes. Multiple <timerange>@<period> can be defined with the syntax ["00:00-02:00@121", "12:00-14:00@121"]

If an allowed timerange is longer than the system’s schedule period, multiple consecutive scheduler run will meet the schedule timerange constraint. If the period is also met (the task has not run in the last <period> minutes), the scheduler rolls a dice and decides if the task is run now, or delayed to a next scheduler run. The probability of deciding to run augments linearly with the current time position in the timerange. For example, with a 00:00-02:00 timerange, at midnight the probability is around 10%. At 01:50 the probabilty is 100%.

This behaviour spreads the tasks execution on all nodes over the whole timerange length. As most tasks, induce communications with the collector, the collector load is leveled.

Any task (except sync tasks) execution in its subprocess is delayed by a random few seconds to level collector load spikes caused by time-synchronized nodes actions being validated at the same time. For example, on a 1000 agent population with pushasset schedule set to 00:00-02:00@121, ~90 agents will execute the action at 00:00. The random delay ensures the collector won’t receive all 90 data payloads at the same second.

Display the Schedules¶

Node Schedule¶

$ om node print schedule
Action                  Last Run             Config Parameter           Schedule Definition                               
|- auto_reboot          2017-09-30 16:59:19  reboot.schedule            16:00-17:00@1 sat:last,tue-mon:last * %2+1,feb-apr
|- auto_rotate_root_pw  -                    rotate_root_pw.schedule    -
|- checks               2017-10-01 17:43:29  checks.schedule            ["16:00-21:00@30 *:last", "! * wed", "*@1"]
|- collect_stats        2017-10-01 17:42:29  stats_collection.schedule  @10
|- compliance_auto      2017-10-01 00:01:22  compliance.schedule        00:00-01:00@61
|- dequeue_actions      2017-01-30 10:02:01  dequeue_actions.schedule   -
|- pushasset            2017-10-01 00:06:22  asset.schedule             00:00-06:00@361 mon-sun
|- pushbrocade          -                    brocade.schedule           -
|- pushcentera          -                    centera.schedule           -
|- pushdcs              -                    dcs.schedule               -
|- pushdisks            2017-10-01 00:03:22  disks.schedule             00:00-06:00@361 mon-sun
|- pushemcvnx           -                    emcvnx.schedule            -
|- pusheva              -                    eva.schedule               -
|- pushfreenas          -                    freenas.schedule           -
|- pushgcedisks         -                    gcedisks.schedule          -
|- pushhds              -                    hds.schedule               -
|- pushhp3par           -                    hp3par.schedule            -
|- pushibmds            -                    ibmds.schedule             -
|- pushibmsvc           -                    ibmsvc.schedule            -
|- pushnecism           -                    necism.schedule            -
|- pushnetapp           -                    netapp.schedule            -
|- pushnsr              -                    nsr.schedule               -
|- pushpatch            2017-10-01 00:16:01  patches.schedule           00:00-06:00@361 mon-sun
|- pushpkg              2017-10-01 00:12:01  packages.schedule          00:00-06:00@361 mon-sun
|- pushstats            2017-10-01 17:41:29  stats.schedule             ["00:00-23:59@10"]
|- pushsym              -                    sym.schedule               -
|- pushvioserver        -                    vioserver.schedule         -
|- pushxtremio          -                    xtremio.schedule           -
`- sysreport            2017-10-01 00:25:02  sysreport.schedule         00:00-06:00@361 mon-sun

The scheduled tasks can be configured in <OSVCETC>/node.conf with a configlet like:

[<section>]
<parameter> = <definition>

The config parameter column in the om node print schedule output is formatted as:

<section>.<parameter>

And the current definition, explicit or implicit is visible in the schedule definition column. A dash character means never scheduled.

The om node command action executed when the schedule constraints are met is displayed in the action column.

The supported schedules are:

Node inventoring tasks : pushasset pushpatch pushpkg pushdisks
Node performance metrics inventoring : pushstats
Node performance metrics collection : collect_stats
Node file content tracking task : sysreport
Node configuration audit and/or remediation task : compliance_auto
Health checking task : checks
Scheduled node reboot task : auto_reboot
Scheduled root password rotation task : auto_rotate_root_pw
Execution of node actions queued by the collector : dequeue_actions
SAN switches inventoring tasks : pushbrocade
Storage arrays inventoring tasks : pushcentera pushdcs pushemcvnx pusheva pushfreenas pushhds pushhp3par pushibmds pushibmsvc pushnecism pushnetapp pushsym pushvioserver
Backup servers saves index inventoring tasks : pushnsr

Service Schedule¶

$ om testmd print schedule
Action                  Last Run             Config Parameter          Schedule Definition
|- compliance_auto      2017-10-01 00:09:01  DEFAULT.comp_schedule     00:00-06:00@361
|- push_config          2017-10-01 00:01:02  DEFAULT.push_schedule     00:00-06:00@361
|- push_resinfo         2017-10-01 16:42:29  DEFAULT.resinfo_schedule  @60
|- push_service_status  2017-10-01 17:39:30  DEFAULT.status_schedule   @8
|- resource_monitor     2017-10-01 17:38:02  DEFAULT.monitor_schedule  @2
|- sync_all             2017-10-01 04:00:04  sync#1.schedule           04:00-06:00@121
`- sync_all             2017-10-01 04:00:04  sync#i0.schedule          04:00-06:00@121

The scheduled tasks can be configured in <OSVCETC>/<svcname>.conf with a configlet like:

[<section>]
<parameter> = <definition>

The config parameter column in the om <path> print schedule output is formatted as:

<section>.<parameter>

And the current definition, explicit or implicit is visible in the schedule definition column. A dash character means never scheduled.

The om <path> command executed when the schedule constraints are met is displayed in the action column.

The supported schedules are:

Service configuration audit and/or remediation task : compliance_auto
Service configuration inventoring task : push_env
Service status inventoring task : push_service_status
Service sync resources actions : sync_all

Schedule Definition¶

The complete and up-to-date schedule syntax reference is available in <OSVCDOC>/node.conf template file.

[!] <timeranges> [<days> [<weeks> [<months>]]]

!
  desc: exclusion pattern. ommiting the ! implies an inclusion
              pattern

<timeranges> := <timerange>[,<timerange>]
  <timerange> := <begin>:<end>@<interval>
    <begin> <end> := <hour>:<minute>
    <interval>
      type: integer
      unit: minutes

<days> := <day>[-<day>][,<day>[-<day>]]
  <day> := <day_of_week>[:<day_of_month>]
    <day_of_week>
       * iso week day format
         type: integer between 0 and 6
       * literal format
         type: string in ("mon", "tue", "wed", "thu", "fri", "sat",
               "sun", "monday", "tuesday", "wednesday", "thursday",
               "friday", "saturday", "sunday")
    <day_of_month> := <literal> | +<nth> | -<nth> | <nth>
       <nth>
         type: integer
       <literal>
         type: string in ("first", "1st", "second", "2nd", "third",
               "3rd", "fourth", "4th", "fifth", "5th", "last")

<weeks> := <week>[-<week>][,<week>[-<week>]]
  <week>
    type: integer between 1 and 53

<months> := <monthrange>[,<monthrange>]
  <monthrange> := <month>[-<month>] | <month_filter>
    <month>
      * numeric month format
        type: integer between 1 and 12
      * literal format
        type: string in ("jan", "feb", "mar", "apr", "may", "jun",
              "jul", "aug", "sep", "oct", "nov", "dec", "january",
              "february", "march", "april", "may", "june", "july",
              "august", "september", "october", "november",
              "december")
    <month_filter> := %<modulo>[+<shift>]
      <modulo>
        type: integer
      <shift>
        type: integer

Examples¶

Never schedule

Either `` , or ``@0
Always schedule

*
Schedule every 60 minutes

@60
Schedule at first occasion after 9am

09:00
Schedule every hour between midnight and 6am, every day

00:00-06:00@60
Schedule once between midnight and 2am, every day

00:00-02:00
Schedule once between midnight and 2am every last day of month

00:00-02:00@121 *:last or 00:00-02:00@121 *:-1
Schedule once between midnight and 2am every last friday of month

00:00-02:00@121 fri:last or 00:00-02:00@121 fri:-1
Schedule once between midnight and 2am every week day

00:00-02:00@121 mon-fri
Schedule once between midnight and 2am every week day from january to february

00:00-02:00@121 mon-fri * jan-feb
Schedule once between midnight and 2am every odd day (1, 3, 5)

00:00-02:00@121 *:%2+1
Schedule once between midnight and 2am every monday of even weeks

00:00-02:00@121 mon %2