-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add warning about using unsupported CRON_TZ #30509
Conversation
👷 Deploy Preview for kubernetes-io-vnext-staging processing. 🔨 Explore the source changes: 9a441b0 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6193d6433b458c00074fd618 |
/sig apps This definitely needs technical review from the relevant SIG. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should remove or reword the example:
`CRON_TZ=UTC 0 0 13 * 5`
(see the heading Cron schedule syntax)
If we document for v1.23 that it's not supported, we should also update the docs for v1.22 in some way. Alternatively, we apply this change to the main branch (currently v1.22) |
9a441b0
to
0770500
Compare
0770500
to
59f7faa
Compare
Correct, it's for both 1.22 and 1.23 |
59f7faa
to
a2f0843
Compare
Yup, did that after recommendation from @reylejano |
✔️ Deploy Preview for kubernetes-io-main-staging ready! 🔨 Explore the source changes: 0770500 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6193d9c7c8e279000769e544 😎 Browse the preview: https://deploy-preview-30509--kubernetes-io-main-staging.netlify.app |
The [v1 CronJob API](/docs/reference/kubernetes-api/workload-resources/cron-job-v1/) | ||
does not officially support setting timezone as explained above. | ||
|
||
Setting variables such as `CRON_TZ` or `TZ is not officially supported by the Kubernetes project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown nit
Setting variables such as `CRON_TZ` or `TZ is not officially supported by the Kubernetes project. | |
Setting variables such as `CRON_TZ` or `TZ` is not officially supported by the Kubernetes project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
In effect, this reverts PR #29455 |
✔️ Deploy Preview for kubernetes-io-main-staging ready! 🔨 Explore the source changes: b5e83e8 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6193de7236a01d00087c768b 😎 Browse the preview: https://deploy-preview-30509--kubernetes-io-main-staging.netlify.app |
a2f0843
to
b5e83e8
Compare
Correct. |
@@ -28,6 +26,16 @@ containers, the timezone set for the kube-controller-manager container determine | |||
that the cron job controller uses. | |||
{{< /caution >}} | |||
|
|||
{{< caution >}} | |||
The [v1 CronJob API](/docs/reference/kubernetes-api/workload-resources/cron-job-v1/) | |||
does not officially support setting timezone as explained above. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"as explained above" ?
edit: maybe I'm misreading this, but it seems like we removed the explanation of setting this?
edit2: and actually explain below 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is OK to merge with the existing wording but a follow-up to clarify would be welcome.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
above is a caution about cronjob using timezone from kube-controller-manager's host, that's what I've meant with it
If we want a short URL like https://k8s.io/cron-tz-environment then that's also available (log a feature request and we can get onto it). |
@sftim I think we'll be fine with the current link https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/ I'll reach out to you on slack about publishing a blog post describing this entire situation. |
If there is no further feedback, I'd appreciate getting this one merged, I have 1.22 (kubernetes/kubernetes#106487) in the queue already |
On behalf of SIG Docs, I'd like SIG |
/lgtm |
LGTM label has been added. Git tree hash: 7dfe95f612cf88fa30e87108f510fcffba0b30fa
|
Thanks @atiratree - I'm assuming your LGTM was to be counted as a tech review for SIG Apps? /approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sftim The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@sftim yes, thanks for the approve |
This is fixing a mistake that was introduced during bumping an internal library.
More information and pointers to sig-apps discussion from yesterday are in
https://groups.google.com/g/kubernetes-sig-apps/c/-hohVua2JO4/m/31SJODnWAgAJ
/assign @atiratree