TimeZone support in CronJob

[soltysh]

TimeZone support in CronJob

• TimeZone support in CronJob
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-apps/3140-TimeZone-support-in-CronJob/README.md
• Discussion Link: https://docs.google.com/document/d/1LZLBGW2wRDwAfdBNHJjFfk9CFoyZPcIYGWU7R1PQ3ng/edit#heading=h.h9p5t69007xy
• Primary contact (assignee): @soltysh
• Responsible SIGs: sig-apps
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.24
  • Beta release target (x.y): 1.25
  • Stable release target (x.y): 1.27
• Alpha
  • KEP (k/enhancements) update PR(s):
    • KEP 3140: TimeZone support in CronJob #3143
  • Code (k/k) update PR(s):
    • KEP 3140: TimeZone support for CronJob kubernetes#108032 (comment)
  • Docs (k/website) update PR(s):
    • Document timezone support for CronJob website#32577
• Beta
  • KEP (k/enhancements) update PR(s):
    • KEP-3140: TimeZone support in CronJob #3375
  • Code (k/k) update PR(s):
    • Promote CronJobTimeZone to beta kubernetes#111435
  • Docs (k/website) update(s):
    • Promote CronJobTimeZone to beta website#35400
• Stable
  • KEP (k/enhancements) update PR(s):
    • KEP 3140: Promote CronJob's TimeZone support to GA #3449
  • Code (k/k) update PR(s):
    • Promote CronJob TZ to GA kubernetes#115904
    • Forbid creating CronJob with TZ or CRON_TZ, but allow updates kubernetes#116252
  • Docs (k/website) update(s):
    • Promote CronJobTimeZone to stable website#39835
  • Blog (k/website) update(s):
    • WIP: CronJob TimeZone blog website#39837

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[soltysh]

/sig apps

[Priyankasaggu11929]

Hello @soltysh 👋, 1.24 Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00pm PT on Thursday Feb 3rd, 2022.

For note, This enhancement is targeting for stage alpha for 1.24 (correct me, if otherwise)

Here’s where this enhancement currently stands:

• Updated KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for this release
• KEP has a test plan section filled out.
• KEP has up to date graduation criteria.
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Looks like for this one, we would just require having this KEP PR #3143 merged & that will mark all the above requirements.

At the moment, the status of this enhancement is marked as at-risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[soltysh]

@Priyankasaggu11929 #3143 just merged, so I hope that satisfies all the requirements for inclusion.

[rhockenbury]

Thanks! I've moved this to tracked. All set for enhancement freeze. 👍

[mehabhalodiya]

Hi @soltysh 👋🏻 1.24 Docs shadow here.

This enhancement is marked as 'Needs Docs' for the 1.24 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.24 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu March 31, 11:59 PM PDT.

Also, if needed take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thanks!

[salaxander]

Hi @soltysh 👋

Checking in once more as we approach 1.24 code freeze at 01:00 UTC Wednesday 30th March 2022.

Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.

It looks like we're waiting on this one to merge? -> kubernetes/kubernetes#108032

As always, we are here to help should questions come up.

Thanks!!

[soltysh]

It looks like we're waiting on this one to merge? -> kubernetes/kubernetes#108032

correct, that's the only one we need.

[soltysh]

docs placeholder opened in kubernetes/website#32577

[sftim]

When we document this, #3143 (comment) strongly suggests to me that we should document how to manage a custom timezone database (via a hostPath volume mount or similar), and we should do that unless we have a strong commitment from SIG Release about providing official container images for the controller manager that have the timezone data kept very current.

[knight42]

@soltysh Hi! Have you been working on this? If not, I am interested in this feature and I would like to implement it!

[soltysh]

@knight42 this merged as alpha in 1.24 see kubernetes/kubernetes#108032 and kubernetes/website#32577 We're planning to promote this further in the next releases.

[Priyankasaggu11929]

/milestone clear
/tracked no

[soltysh]

/milestone v1.25
/stage beta

[sftim]

The implementation of the CronJob API in Kubernetes 1.26 lets you set the .spec.schedule field to include a timezone; for example: CRON_TZ=UTC * * * * * or TZ=UTC * * * * *.

Do we want to make a stronger statement about this, now that we nearly have GA support for setting a timezone via the API? The other mechanism was never official. This feels like the right time to make it.

For example, we might want to block creates of CronJobs that set a schedule with TZ / CRON_TZ. Possibly behind an on-y-default, disable-if-you-must feature gate?

[soltysh]

Do we want to make a stronger statement about this, now that we nearly have GA support for setting a timezone via the API? The other mechanism was never official. This feels like the right time to make it.

I'd wish, but my worry is that we might break users, I'll open a separate PR and let's see if api approvers are willing to accept that.

For example, we might want to block creates of CronJobs that set a schedule with TZ / CRON_TZ. Possibly behind an on-y-default, disable-if-you-must feature gate?

We would need to touch both creates, to ensure new cronjobs are w/o those, and also updates such that you can't add it, if it wasn't already there.

[sftim]

I guess, related thing: recommend a tool / script / whatever that converts to the new, GA way to use a timezone.

[soltysh]

I guess, related thing: recommend a tool / script / whatever that converts to the new, GA way to use a timezone.

I'll be writing a blog post about the TZ GA, so I'll make sure to put something together, I think a simple one-liner that could handle that easily. Also, based on the discussion from the TZ/CRON_TZ PR (not opened yet) I'll add that information to that blog post as well.

[tavin]

@soltysh I wonder if, in your blog post, you'd be able to touch upon a recommended migration path for users who are on e.g. v1.22 and cronjobber.hidde.co/v1alpha1/TZCronJob. I am not sure in which point release we should attempt switching or even if we should temporarily use this TZ/CRON_TZ schedule format. Also we are constrained by the default feature gates, if that makes any difference.

[soltysh]

Good point, I'll have a look and see what's possible.

[LukeMwila]

Hi @soltysh, I’m reaching out from the 1.27 Release Docs team. This enhancement is marked as ‘Needs Docs’ for the 1.27 release.

Please follow the steps detailed in the documentation to open a PR against dev-1.27 branch in the k/website repo. This PR can be just a placeholder at this time, and must be created by March 16. For more information, please take a look at Documenting for a release to familiarize yourself with the documentation requirements for the release.

Please feel free to reach out with any questions. Thanks!

[shatoboar]

Hi @soltysh 👋,
Checking in as we approach 1.27 code freeze at 17:00 PDT on Tuesday 14th March 2023.
Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.
  • Promote CronJob TZ to GA kubernetes#115904

Please let me know what other PRs in k/k I should be tracking for this KEP.
As always, we are here to help should questions come up. Thanks!

[dlipofsky]

Is there a way to see the timezone with kubectl ?
I don't see it today, even with kubectl get cronjobs -o wide.
My client is v1.27.2 although my server is only v1.26.10.
(I do see it with -o yaml or -o json but not in the tabular formats)

[AndrewSav]

@dlipofsky as far as I understand the -o switch is pretty flexible and you can format it the way you want with it. Try go-template mode for example, I'm pretty sure it will get you where you want, I'm a little bit less certain about custom-columns but seems plausible too.

[dlipofsky]

@AndrewSav, I was rather hoping it could be added as a standard feature, as it is just as important as the schedule string in knowing when something will actually run.

[AndrewSav]

@dlipofsky let's hope they add it, but it is understandable that they cannot add every single field someone finds useful

[sftim]

For showing timezone in kubectl for CronJobs: https://github.com/kubernetes/kubectl/issues/new/choose

[soltysh]

This is all done
/close

[k8s-ci-robot]

@soltysh: Closing this issue.

In response to this:

This is all done
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.