k8s-job-wrapper

README

k8s-job-wrapper

Provides a CRD to make Job and CronJob easier to use through templating.

[!WARNING] This repository does not actively accept external contributions.

Prerequisites

• Kubernetes v1.32.2+ cluster

Usage

Documentation for the CRD.

Install

helm install [RELEASE_NAME] oci://ghcr.io/pixiv/k8s-job-wrapper/charts/k8s-job-wrapper

To show the configurable values for the chart:

helm show values oci://ghcr.io/pixiv/k8s-job-wrapper/charts/k8s-job-wrapper

Contribution

Prerequisites

• direnv
• go version v1.25.0+
• docker version 28.3.2+

Development

The repository layout conforms to the Kubebuilder. Run make help to list all available development tasks.

Deploy

To deploy controller to your local development environment, run make deploy-local.

Tools

See the hack for development tools and scripts. Development tool versions are managed in .env and go tool.

To reinstall the development tools, run make clean. Afterwards, they will be automatically reinstalled the next time you invoke them. For more details, please see tools.sh.

Documentation for the CRD

See the docs for documentation for the CRD. To generate the documentation, run make docs.

Helm chart

See the chart for Helm chart for the CRD. To create the Helm chart for your local development environment, run make chart-local.

How to upgrade Go

Edit following files:

• .env
• Dockerfile
• go.mod

Release

1. Run Create Update Version PR
2. Confirm the PR and merge it
3. Confirm that CI on the main branch is green. Then

git switch main
git pull
make release

When make release, the following actions will be executed:

• Build and push the controller image to ghcr.
• Generate and push the Helm chart to ghcr.
• Create a release.
• Deploy the documentation for CRD to GitHub Pages.

License

Apache 2.0 License.