https://github.com/informaticsmatters/squonk2-data-manager-job-operator

An arbitrary Job-execution operator for the Data Manager API
https://github.com/informaticsmatters/squonk2-data-manager-job-operator

k8s-operator squonk2

Last synced: about 2 months ago
JSON representation

An arbitrary Job-execution operator for the Data Manager API

• Host: GitHub
• URL: https://github.com/informaticsmatters/squonk2-data-manager-job-operator
• Owner: InformaticsMatters
• License: mit
• Created: 2021-05-21T17:49:04.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-10-15T17:04:21.000Z (8 months ago)
• Last Synced: 2025-10-16T11:58:42.458Z (8 months ago)
• Topics: k8s-operator, squonk2
• Language: Python
• Homepage:
• Size: 191 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# The Data Manager Job Operator

[![Data Manager: Operator](https://img.shields.io/badge/squonk2%20data%20manager-job%20operator-000000?labelColor=dc332e)]()

[![Dev Stage: 1](https://img.shields.io/badge/dev%20stage-★☆☆%20%281%29-000000?labelColor=dc332e)](https://github.com/InformaticsMatters/code-repository-development-stages)

![Architecture](https://img.shields.io/badge/architecture-amd64%20%7C%20arm64-lightgrey)

[![build](https://github.com/informaticsmatters/squonk2-data-manager-job-operator/actions/workflows/build.yaml/badge.svg)](https://github.com/informaticsmatters/squonk2-data-manager-job-operator/actions/workflows/build.yaml)

[![build tag](https://github.com/informaticsmatters/squonk2-data-manager-job-operator/actions/workflows/build-tag.yaml/badge.svg)](https://github.com/informaticsmatters/squonk2-data-manager-job-operator/actions/workflows/build-tag.yaml)

![GitHub](https://img.shields.io/github/license/informaticsmatters/squonk2-data-manager-job-operator)

![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/informaticsmatters/squonk2-data-manager-job-operator?include_prereleases)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

This repo contains a Kubernetes [Operator] based on the [kopf] and [kubernetes]

Python packages that is used by the **Informatics Matters Squonk2 Data Manager API**

to create transient Jobs (Kubernetes Pods) for the Data Manager service.

Prerequisites: -

-   Python

-   Docker

-   A kubernetes config file

-   A compatible Kubernetes (e.g. 1.32 thru 1.34 if the operator is built for 1.33)

## Contributing

The project uses: -

- [pre-commit] to enforce linting of files prior to committing them to the

  upstream repository

- [Commitizen] to enforce a [Conventional Commit] commit message format

- [Black] as a code formatter

You **MUST** comply with these choices in order to  contribute to the project.

To get started review the pre-commit utility and the conventional commit style

and then set-up your local clone by following the **Installation** and

**Quick Start** sections: -

    pip install -r build-requirements.txt

    pre-commit install -t commit-msg -t pre-commit

Now the project's rules will run on every commit, and you can check the

current health of your clone with: -

    pre-commit run --all-files

## Building the operator (local development)

Pre-requisites: -

- Docker Compose (v2)

The operator container, residing in the `operator` directory,

is automatically built and pushed to Docker Hub using GitHub Actions.

You can build the image yourself using docker compose.

The following will build and push an operator image with a specific tag: -

    export IMAGE_TAG=34.0.0-alpha.1

    docker compose build

    docker compose push

## Versioning

We adopt a different approach for operator naming. At the time of writing

we were on version 33 and major changes do not result in changes to this

number. **Why?**

The major revision is actually used to identify the Kubernetes 1.x release the

operator is built against. So the `33.x.x` operator is built using

the Python 33.x Kubernetes package.

>   See the `kubernetes` package version in `operator/requrements.txt`.

When we make feature changes we update the **minor** value

and for bug-fixes we adjust the **patch** value. So, for a build against

Kubernetes 1.33 our **major** version will always be `33`.

## Deploying into the Data Manager API

We use our peer repository [squonk2-data-manager-job-operator-ansible]

to deploy this operator.

---

[ansible]: https://pypi.org/project/ansible/

[ansible galaxy]: https://galaxy.ansible.com

[black]: https://pypi.org/project/black/

[commitizen]: https://pypi.org/project/commitizen

[conventional commit]: https://www.conventionalcommits.org/en/v1.0.0/

[kopf]: https://pypi.org/project/kopf/

[kubernetes]: https://pypi.org/project/kubernetes/

[operator]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/

[pre-commit]: https://pre-commit.com

[squonk2-data-manager-job-operator-ansible]: https://github.com/informaticsmatters/squonk2-data-manager-job-operator-ansible