Document timezone support for CronJob #32577

rosspeoples · 2022-03-28T14:44:54Z

Add documentation for:

netlify · 2022-03-28T14:44:59Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name	Link
🔨 Latest commit	`e80bed6`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/62449723ff76ee000907a26b

k8s-ci-robot · 2022-03-28T14:45:02Z

Welcome @deejross!

It looks like this is your first PR to kubernetes/website 🎉. 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/website 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. 😃

mehabhalodiya · 2022-03-28T18:49:06Z

/assign

mehabhalodiya · 2022-03-29T04:57:28Z

/sig apps

sftim · 2022-03-29T10:47:41Z

/retitle Document timezone support for CronJob

soltysh · 2022-03-29T10:50:13Z

/assign

sftim

Hi. Here's some early feedback that I hope is useful.

sftim · 2022-03-30T13:39:55Z

content/en/docs/concepts/workloads/controllers/cron-jobs.md

@@ -36,6 +36,8 @@ for parsing and calculating the next Job creation time. Any usage of it is not
 recommended in a production cluster.
 {{< /caution >}}

+**ALPHA**: CronJob now supports a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use.


You can omit this.

content/en/docs/reference/command-line-tools-reference/feature-gates.md

sftim · 2022-03-30T13:47:23Z

content/en/docs/concepts/workloads/controllers/cron-jobs.md

+## TimeZone Support
+**ALPHA** as of 1.24
+
+There is now a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use. It is an optional field that should be set either to nil or a non-empty string. The `timeZone` string value should be a valid time zone name. Please see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, the local time zone of kube-controller-manager is used.
+
+An external time zone database should be available for use. In the event that one is not available, one from the Go standard library will be embedded into the binaries.
+


I'd write it like this:

Suggested change

## TimeZone Support

**ALPHA** as of 1.24

There is now a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use. It is an optional field that should be set either to nil or a non-empty string. The `timeZone` string value should be a valid time zone name. Please see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, the local time zone of kube-controller-manager is used.

An external time zone database should be available for use. In the event that one is not available, one from the Go standard library will be embedded into the binaries.

## Time zones

For CronJobs with no time zone specified, the kube-controller-manager interprets schedules relative to its local time zone.

{{< feature-state for_k8s_version="v1.24" state="alpha" >}}

If you enable the `CronJobTimeZone` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/),

you can specify a time zone for a CronJob (if you don't enable that feature gate, or if you are using a version of

Kubernetes that does not have experimental time zone support, all CronJobs in your cluster have an unspecified

timezone).

When you have the feature enabled, you can set `spec.timezone` to the name of a valid [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. For example, setting

`spec.timezone: "Etc/UTC"` instructs Kubernetes to interpret the schedule relative to Coordinated Universal Time.

soltysh

One nit, rest lgtm

soltysh · 2022-03-30T13:54:53Z

content/en/docs/concepts/workloads/controllers/cron-jobs.md

+
+There is now a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use. It is an optional field that should be set either to nil or a non-empty string. The `timeZone` string value should be a valid time zone name. Please see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, the local time zone of kube-controller-manager is used.
+
+A time zone database from the Go standard library is included in the binaries and used as a fallback in case an external database is not available.


Suggested change

A time zone database from the Go standard library is included in the binaries and used as a fallback in case an external database is not available.

A time zone database from the Go standard library is included in the binaries and used as a fallback in case an external database is not available on the system.

sftim

Markdown and text mostly LGTM, one nit.

content/en/docs/reference/command-line-tools-reference/feature-gates.md

tengqm · 2022-04-01T05:41:52Z

/lgtm

k8s-ci-robot · 2022-04-01T05:42:13Z

LGTM label has been added.

Git tree hash: 209f5d90dca4bb69eb2a21df1057e8ce8ff83a87

sftim

/approve

k8s-ci-robot · 2022-04-01T09:26:26Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim, soltysh

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:

~~content/en/OWNERS~~ [sftim]

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

k8s-ci-robot added this to the 1.24 milestone Mar 28, 2022

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 28, 2022

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 28, 2022

k8s-ci-robot requested review from celestehorgan and soltysh March 28, 2022 14:45

soltysh mentioned this pull request Mar 28, 2022

TimeZone support in CronJob kubernetes/enhancements#3140

Closed

13 tasks

k8s-ci-robot assigned mehabhalodiya Mar 28, 2022

k8s-ci-robot added the sig/apps Categorizes an issue or PR as relevant to SIG Apps. label Mar 29, 2022

k8s-ci-robot changed the title ~~KEP 3140~~ Document timezone support for CronJob Mar 29, 2022

k8s-ci-robot assigned soltysh Mar 29, 2022

rosspeoples force-pushed the kep3140 branch from 35d731f to 5380f3a Compare March 30, 2022 13:28

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 30, 2022

rosspeoples force-pushed the kep3140 branch from 5380f3a to ce96f83 Compare March 30, 2022 13:41

sftim reviewed Mar 30, 2022

View reviewed changes

rosspeoples force-pushed the kep3140 branch from ce96f83 to ff3b672 Compare March 30, 2022 13:52

soltysh approved these changes Mar 30, 2022

View reviewed changes

rosspeoples force-pushed the kep3140 branch from ff3b672 to adc2d08 Compare March 30, 2022 14:01

rosspeoples marked this pull request as ready for review March 30, 2022 14:02

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 30, 2022

k8s-ci-robot requested a review from natalisucks March 30, 2022 14:02

k8s-ci-robot requested a review from soltysh March 30, 2022 14:02

sftim reviewed Mar 30, 2022

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Outdated Show resolved Hide resolved

kep2140

e80bed6

rosspeoples force-pushed the kep3140 branch from adc2d08 to e80bed6 Compare March 30, 2022 17:45

k8s-ci-robot assigned tengqm Apr 1, 2022

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

sftim reviewed Apr 1, 2022

View reviewed changes

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

k8s-ci-robot merged commit dce29be into kubernetes:dev-1.24 Apr 1, 2022

rosspeoples deleted the kep3140 branch April 1, 2022 15:28

yonatankahana mentioned this pull request Apr 10, 2022

feat: add cronjob injection support (alpha) k8tz/k8tz#17

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document timezone support for CronJob #32577

Document timezone support for CronJob #32577

rosspeoples commented Mar 28, 2022 •

edited by sftim

Loading

netlify bot commented Mar 28, 2022 •

edited

Loading

k8s-ci-robot commented Mar 28, 2022

mehabhalodiya commented Mar 28, 2022

mehabhalodiya commented Mar 29, 2022

sftim commented Mar 29, 2022

soltysh commented Mar 29, 2022

sftim left a comment

sftim Mar 30, 2022

sftim Mar 30, 2022

soltysh left a comment

soltysh Mar 30, 2022

sftim left a comment

tengqm commented Apr 1, 2022

k8s-ci-robot commented Apr 1, 2022

sftim left a comment

k8s-ci-robot commented Apr 1, 2022

-## TimeZone Support
-**ALPHA** as of 1.24
-There is now a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use. It is an optional field that should be set either to nil or a non-empty string. The `timeZone` string value should be a valid time zone name. Please see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, the local time zone of kube-controller-manager is used.
-An external time zone database should be available for use. In the event that one is not available, one from the Go standard library will be embedded into the binaries.
+## Time zones
+For CronJobs with no time zone specified, the kube-controller-manager interprets schedules relative to its local time zone.
+{{< feature-state for_k8s_version="v1.24" state="alpha" >}}
+If you enable the  `CronJobTimeZone` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/),
+you can specify a time zone for a CronJob (if you don't enable that feature gate, or if you are using a version of
+Kubernetes that does not have experimental time zone support, all CronJobs in your cluster have an unspecified
+timezone).
+When you have the feature enabled, you can set `spec.timezone` to the name of a valid [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. For example, setting
+`spec.timezone: "Etc/UTC"` instructs Kubernetes to interpret the schedule relative to Coordinated Universal Time.


		There is now a new `timeZone` field and requires the `CronJobTimeZone` featuregate to be enabled to use. It is an optional field that should be set either to nil or a non-empty string. The `timeZone` string value should be a valid time zone name. Please see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, the local time zone of kube-controller-manager is used.

		A time zone database from the Go standard library is included in the binaries and used as a fallback in case an external database is not available.

Document timezone support for CronJob #32577

Document timezone support for CronJob #32577

Conversation

rosspeoples commented Mar 28, 2022 • edited by sftim Loading

netlify bot commented Mar 28, 2022 • edited Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

k8s-ci-robot commented Mar 28, 2022

mehabhalodiya commented Mar 28, 2022

mehabhalodiya commented Mar 29, 2022

sftim commented Mar 29, 2022

soltysh commented Mar 29, 2022

sftim left a comment

Choose a reason for hiding this comment

sftim Mar 30, 2022

Choose a reason for hiding this comment

sftim Mar 30, 2022

Choose a reason for hiding this comment

soltysh left a comment

Choose a reason for hiding this comment

soltysh Mar 30, 2022

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

tengqm commented Apr 1, 2022

k8s-ci-robot commented Apr 1, 2022

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 1, 2022

rosspeoples commented Mar 28, 2022 •

edited by sftim

Loading

netlify bot commented Mar 28, 2022 •

edited

Loading