add --init-period and --init-max-failures flags by knQzx · Pull Request #980 · kubernetes/git-sync

knQzx · 2026-04-04T22:56:34Z

summary

adds --init-period flag - used for retries until the first successful sync, then switches to normal --period
adds --init-max-failures flag - aborts after N consecutive failures during the initial sync phase, then --max-failures takes over
adds a SYNC PHASES section to --man and README explaining init vs steady-state behavior
both flags are optional and backward compatible - behavior is unchanged if not set

test plan

unit tests for chooseWaitTime() and isInitFailuresExceeded() helper functions
e2e tests for both flags
verified all existing tests still pass with go test ./...
build tested with go build ./...

fixes #959

linux-foundation-easycla · 2026-04-04T22:56:42Z

The committers listed above are authorized under a signed CLA.

✅ login: knQzx / name: knQzx (38c837b, 5c9a247, 6a3f31b, 94c27c0, b34572c, e599c33)

k8s-ci-robot · 2026-04-04T22:56:44Z

Welcome @knQzx!

It looks like this is your first PR to kubernetes/git-sync 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/git-sync has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

thockin

Thanks. The code looks good, but I'd really like e2e tests to cover these (test_e2e.sh)

thockin · 2026-04-05T00:43:00Z

            dynamic credentials from an external secrets system).
            See also $GITSYNC_PASSWORD.

+    --init-period <duration>, $GITSYNC_INIT_PERIOD


please keep this section alphabetical -- these should go earlier

Also, please add to README

knQzx · 2026-04-05T07:51:12Z

thanks for the feedback, fixed - moved flags to alphabetical order, added readme docs, and added e2e tests for both init-period and init-timeout

thockin

Thanks!

/lgtm
/approve

knQzx · 2026-04-14T23:19:20Z

pushed a fix: the init-timeout test was using a valid repo with a slow fetch wrapper, so git-sync would succeed after 2s and run forever instead of timing out. swapped to a non-existent repo path so fetches actually fail and init-timeout fires as expected.

- rename flag and helper to count-based (int, not duration) - skip --max-failures during init when init-max-failures is set so main-max does not override init tolerance - add SYNC PHASES section to --man and README describing init vs steady-state - update e2e test to use a bad server path, as suggested in review

knQzx · 2026-04-22T14:21:39Z

reworked per the review:

renamed --init-timeout to --init-max-failures (int, counts failures)
e2e test now targets a bad server path as you suggested
added a SYNC PHASES section in --man and README describing init vs steady-state
also skipped --max-failures during init when --init-max-failures is set - otherwise main-max could override init tolerance, caught this while reviewing

lmk if the new shape works

…ures - move flInitMaxFailures next to flMaxFailures - default flInitPeriod to flPeriod to kill conditional in hot path - replace isInitFailuresExceeded + useMainLimit with getMaxFailures closure - track waitTime as a loop-outer variable, flip on init-done - detect --init-max-failures via pflag.Changed || GITSYNC_INIT_MAX_FAILURES env; -1 = unlimited, 0 = abort immediately, unset = fall through to --max-failures - drop now-stale unit tests for removed helpers, update --man and README

knQzx · 2026-04-24T01:05:12Z

applied all five. small deviation in getMaxFailures: kept return *flMaxFailures instead of the literal > 0 gate, otherwise --max-failures=0 would flip from "abort on first failure" (current docs) to "never abort". outer guard is unchanged. lmk if you'd rather have the literal shape and we touch the main docs too

thockin · 2026-04-24T15:55:12Z

Thanks!

/lgtm
/approve

k8s-ci-robot · 2026-04-24T15:55:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: knQzx, thockin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [thockin]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

add init-period flag for faster initial sync retries

6a3f31b

k8s-ci-robot requested review from sdowell and stp-ip April 4, 2026 22:56

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 4, 2026

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 4, 2026

thockin reviewed Apr 5, 2026

View reviewed changes

thockin self-assigned this Apr 5, 2026

address review: alphabetize flags, add readme docs, add e2e tests

38c837b

move init flags to alphabetical order in man text

e599c33

thockin reviewed Apr 13, 2026

View reviewed changes

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Apr 13, 2026

thockin removed approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Apr 13, 2026

thockin reviewed Apr 13, 2026

View reviewed changes

Comment thread main.go

fix init-timeout e2e test to actually trigger init timeout

5c9a247

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 14, 2026

knQzx changed the title ~~add --init-period and --init-timeout flags~~ add --init-period and --init-max-failures flags Apr 22, 2026

thockin added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Apr 24, 2026

thockin reviewed Apr 24, 2026

View reviewed changes

Comment thread main.go Outdated

Comment thread main.go Outdated

Comment thread main.go Outdated

Comment thread main.go Outdated

Comment thread main.go Outdated

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 24, 2026

k8s-ci-robot merged commit fb0e300 into kubernetes:master Apr 24, 2026
5 checks passed

Conversation

knQzx commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

summary

test plan

Uh oh!

linux-foundation-easycla Bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Apr 4, 2026

Uh oh!

thockin left a comment

Choose a reason for hiding this comment

Uh oh!

thockin Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

thockin Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

knQzx commented Apr 5, 2026

Uh oh!

thockin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

knQzx commented Apr 14, 2026

Uh oh!

knQzx commented Apr 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

knQzx commented Apr 24, 2026

Uh oh!

thockin commented Apr 24, 2026

Uh oh!

k8s-ci-robot commented Apr 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

knQzx commented Apr 4, 2026 •

edited

Loading

linux-foundation-easycla Bot commented Apr 4, 2026 •

edited

Loading