• Kubernetes Submit Queue's avatar
    Merge pull request #39608 from peay/cronjob-too-many-times-to-list · 9d2fce7c
    Kubernetes Submit Queue authored
    Automatic merge from submit-queue
    
    Do not list CronJob unmet starting times beyond deadline
    
    **What this PR does / why we need it**:
    
    See #36311. `getRecentUnmetScheduleTimes` gives up after 100 unmet times to avoid wasting too much CPU or memory generating all the times, as it generates them sequentially.
    
    When concurrency is forbidden, this is conceptually un-necessary: we only need the last unmet start time. This suggests that when concurrency is forbidden, we could generate times by going backward in time from now. This is not very practical as CronJob currently relies on a package that only provides `Next` and no `Prev`. Hand-cooking a `Prev` does not seem like a good idea. I could submit a PR to the cron library to add a `Prev` method, and use that when concurrency is forbidden through something like `getLastUnmetScheduleTime`. This would be `O(1)` and there would be no limit involved.
    
    (edit: actually, even for the other concurrency settings, we only start the last unmet start times -- there is a `TODO` in the controller to actually start all of them, but that is not implemented at the moment. This means the solution would apply, at least temporarily, to all concurrency settings).
    
    cc @soltysh what do you think?
    
    In the meantime, I would suggest to do something simple. Currently, the user has no way to configure anything to ensure that his CronJob will not get stuck if one job takes more that 100 unmet times.
    
     `getRecentUnmetScheduleTimes` starts with an initial time corresponding to the last start (or to the creation of the CronJob, if nothing has started yet). However, when `StartingDeadlineSeconds` is set, the controller will not start anything that is older than the deadline, so if the last start is way beyond the deadline, we are generating potentially lots of unmet start times that will not be considered by the scheduler for scheduling anyway.
    
    Consider a job running every minute, where the last instance has taken 120 minutes. This means there are more than 100 unmet times when we start counting from the last start time.
    
    **The PR makes `getRecentUnmetScheduleTimes` only consider times that do not fall beyond the deadline.** Here, the CronJob can be configured with a `StartingDeadlineSeconds` of, say, 10 minutes. After the 120min job has run, `getRecentUnmetScheduleTimes` will only consider the times in the last 10 minutes from now, and will not get stuck.
    
    As a side note on the max. number of unmet times to use as limits in terms of CPU used by the controller: I have run a quick benchmark on my i7 mac. Schedules corresponding to "once a week" tend to be more expensive to generate unmet times for. Just FYI.
    
    ```
    +--------------+---------------+--------------+
    |   SCHEDULE   | MISSED STARTS |    TIMING    |
    +--------------+---------------+--------------+
    | */1 * * * ?  |           100 | 383.645µs    |
    | */30 * * * ? |           100 | 354.765µs    |
    | 30 1 * * ?   |           100 | 1.065124ms   |
    | 30 1 * * 0   |           100 | 1.80034ms    |
    | */1 * * * ?  |           500 | 1.341365ms   |
    | */30 * * * ? |           500 | 1.814441ms   |
    | 30 1 * * ?   |           500 | 8.475012ms   |
    | 30 1 * * 0   |           500 | 10.020613ms  |
    | */1 * * * ?  |          1000 | 2.551697ms   |
    | */30 * * * ? |          1000 | 4.075813ms   |
    | 30 1 * * ?   |          1000 | 17.674945ms  |
    | 30 1 * * 0   |          1000 | 19.149324ms  |
    | */1 * * * ?  |         10000 | 25.725531ms  |
    | */30 * * * ? |         10000 | 87.520022ms  |
    | 30 1 * * ?   |         10000 | 174.29216ms  |
    | 30 1 * * 0   |         10000 | 196.565748ms |
    +--------------+---------------+--------------+
    ```
    
    using
    
    ```.go
    package main
    
    import (
        "fmt"
        "time"
        "os"
        "strconv"
    
        "github.com/robfig/cron"
        "github.com/olekukonko/tablewriter"
    )
    
    func timeSchedule(schedule string, iterations int) (time.Duration) {
        sched, err := cron.ParseStandard(schedule)
    
        if err != nil {
            panic(fmt.Sprintf("Unparseable schedule: %s", err))
        }
    
        start := time.Now()
        t := time.Now()
    
        for i := 1; i <= iterations; i++ {
            t = sched.Next(t)
        }
    
        return time.Since(start)
    }
    
    func main() {
        table := tablewriter.NewWriter(os.Stdout)
        table.SetHeader([]string{"Schedule", "Missed starts", "Timing"})
    
        schedules := []string{"*/1 * * * ?", "*/30 * * * ?", "30 1 * * ?", "30 1 * * 0"}
        iteration_nums := []int{100, 500, 1000, 10000}
    
        for _, iterations := range iteration_nums {
            for _, schedule := range schedules {
                table.Append([]string{schedule,
                                      strconv.Itoa(iterations),
                                      timeSchedule(schedule, iterations).String()})
            }
        }
        table.Render()
    }
    ```
    
    **Which issue this PR fixes**: fixes #36311
    
    **Special notes for your reviewer**:
    
    **Release note**:
    
    ```release-note
    ```
    9d2fce7c
Name
Last commit
Last update
.github Loading commit data...
Godeps Loading commit data...
api Loading commit data...
build Loading commit data...
cluster Loading commit data...
cmd Loading commit data...
docs Loading commit data...
examples Loading commit data...
federation Loading commit data...
hack Loading commit data...
hooks Loading commit data...
logo Loading commit data...
pkg Loading commit data...
plugin Loading commit data...
staging Loading commit data...
test Loading commit data...
third_party Loading commit data...
translations Loading commit data...
vendor Loading commit data...
.gazelcfg.json Loading commit data...
.generated_docs Loading commit data...
.generated_files Loading commit data...
.gitattributes Loading commit data...
.gitignore Loading commit data...
BUILD.bazel Loading commit data...
CHANGELOG.md Loading commit data...
CONTRIBUTING.md Loading commit data...
LICENSE Loading commit data...
Makefile Loading commit data...
Makefile.generated_files Loading commit data...
OWNERS Loading commit data...
OWNERS_ALIASES Loading commit data...
README.md Loading commit data...
Vagrantfile Loading commit data...
WORKSPACE Loading commit data...
code-of-conduct.md Loading commit data...
labels.yaml Loading commit data...