Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiddeco/cronjobber
Cronjobber is a cronjob controller for Kubernetes with support for time zones
https://github.com/hiddeco/cronjobber
k8s kubernetes kubernetes-controller kubernetes-operator timezone
Last synced: about 1 month ago
JSON representation
Cronjobber is a cronjob controller for Kubernetes with support for time zones
- Host: GitHub
- URL: https://github.com/hiddeco/cronjobber
- Owner: hiddeco
- License: apache-2.0
- Archived: true
- Created: 2019-03-02T01:53:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T23:39:11.000Z (4 months ago)
- Last Synced: 2024-08-22T01:16:35.087Z (4 months ago)
- Topics: k8s, kubernetes, kubernetes-controller, kubernetes-operator, timezone
- Language: Go
- Homepage:
- Size: 219 KB
- Stars: 244
- Watchers: 12
- Forks: 38
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - hiddeco/cronjobber - Cronjobber is a cronjob controller for Kubernetes with support for time zones (Go)
README
# Cronjobber
[](https://circleci.com/gh/hiddeco/cronjobber/tree/master)
[](https://goreportcard.com/report/github.com/hiddeco/cronjobber)
[](https://quay.io/repository/hiddeco/cronjobber)
[](https://github.com/hiddeco/cronjobber/blob/master/LICENSE)
[](https://github.com/hiddeco/cronjobber/releases)
Cronjobber is the cronjob controller from Kubernetes patched with time zone support.
## Installation
```sh
# Install CustomResourceDefinition
$ kubectl apply -f https://raw.githubusercontent.com/hiddeco/cronjobber/master/deploy/crd.yaml
# Setup service account and RBAC
$ kubectl apply -f https://raw.githubusercontent.com/hiddeco/cronjobber/master/deploy/rbac.yaml
# Deploy Cronjobber (using the timezone db from the node)
$ kubectl apply -f https://raw.githubusercontent.com/hiddeco/cronjobber/master/deploy/deploy.yaml
```
### Keeping your timezone database up-to-date
> :warning: **Note:** the approach below does not work at present due to an
> issue with Go which causes it to silently fail on `slim` timezone database
> formats (the default since `tzdata>=2020-b`) ([go#42138](https://github.com/golang/go/issues/42138)).
>
> It is therefore advised to use the `deploy.yaml` with the embedded timezone
> database until this issue has been resolved.
Cronjobber embeds a default timezone database in its binary, this database is
however not updated regularly. To help your overcome this issue there is an
[`cronjobber-updatetz`](https://quay.io/repository/hiddeco/cronjobber-updatetz)
image available that can be used as a sidecar.
```sh
# Deploy Cronjobber (using the updatetz sidecar)
$ kubectl apply -f https://raw.githubusercontent.com/hiddeco/cronjobber/master/deploy/deploy-updatetz.yaml
```
You may want to tweak the following environment variables to control
how often it looks for updates and where it puts the timezone database.
- `TZPV` (default: `/tmp/zoneinfo`) is where the timezone database
is extracted
- `REFRESH_INTERVAL` (default: `7d`) is how often it looks for updates
## Usage
Instead of creating a [`CronJob`](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/)
like you normally would, you create a `TZCronJob`, which works exactly
the same but supports an additional field: `.spec.timezone`. Set this
to the time zone you wish to schedule your jobs in and Cronjobber will
take care of the rest.
```yaml
apiVersion: cronjobber.hidde.co/v1alpha1
kind: TZCronJob
metadata:
name: hello
spec:
schedule: "*/1 * * * *"
timezone: "Europe/Amsterdam"
jobTemplate:
spec:
template:
spec:
containers:
- name: hello
image: busybox
args:
- /bin/sh
- -c
- date; echo "Hello, World!"
restartPolicy: OnFailure
```
## Reasoning
There has been a [long outstanding (and now closed) issue](https://github.com/kubernetes/kubernetes/issues/47202)
to add time zone support to the `CronJob` kind in Kubernetes, including
a [fully working PR](https://github.com/kubernetes/kubernetes/pull/47266)
which actually made it possible. SIG Apps and in SIG Architecture
decided however against adding it because of the downside of having
to manage and distribute time zone databases.
> People are now encouraged to innovate and solve these kinds of problems in the ecosystem rather than core.
>
> Instead of putting this in Kubernetes the ask is to:
> 1. Develop this in the ecosystem (e.g., a controller) that others can use. Distribute it, solve the problems there, and see what update looks like
> 2. If the solution is widely adopted and can be used by everyone (including small scale, multi-cluster, etc) then it could be considered for core Kubernetes
>
> -- [mattfarina (Matt Farina) on Jan 26, 2018](https://github.com/kubernetes/kubernetes/issues/47202#issuecomment-360820586)
Cronjobber is the most simple answer to this: it is the original PR
on top of a more recent version of the cronjob controller, with some
glue added to make it an independent controller.
## Credits
This application is derived from open source components. You can find
the original source code of these components below.
* [Kubernetes CronJob controller](https://github.com/kubernetes/kubernetes/tree/v1.13.3/pkg/controller/cronjob)
* [kubernetes/kubernetes#47266](https://github.com/kubernetes/kubernetes/pull/47266) by Adam Sunderland