https://github.com/zalando-incubator/kopf
A Python framework to write Kubernetes operators in just few lines of code.
https://github.com/zalando-incubator/kopf
asyncio domain-driven-design framework kubernetes kubernetes-operator operator python python3
Last synced: 18 days ago
JSON representation
A Python framework to write Kubernetes operators in just few lines of code.
- Host: GitHub
- URL: https://github.com/zalando-incubator/kopf
- Owner: zalando-incubator
- License: mit
- Archived: true
- Created: 2019-03-26T13:43:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-14T15:58:08.000Z (over 4 years ago)
- Last Synced: 2024-10-31T20:40:27.408Z (6 months ago)
- Topics: asyncio, domain-driven-design, framework, kubernetes, kubernetes-operator, operator, python, python3
- Language: Python
- Homepage: https://kopf.readthedocs.io
- Size: 1.61 MB
- Stars: 970
- Watchers: 32
- Forks: 88
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-kubernetes-operator-resources - Kopf - A Python framework to write Kubernetes operators in just few lines of code. (Operator Frameworks)
- awesome-repositories - zalando-incubator/kopf - A Python framework to write Kubernetes operators in just few lines of code. (Python)
- awesome-cloud-native - kopf - A Python framework to write Kubernetes operators in just few lines of code. (Kubernetes Operators)
README
**This repository is suspended and not maintained.**
It is kept in place for historic reference, so that all links remain valid,
and the issues' & PRs' discussions are preserved for debugging & investigations.
Kopf's development currently happens here:
* https://github.com/nolar/kopf
Please send new issues and pull requests there.
---
# Kubernetes Operator Pythonic Framework (Kopf)
[](https://travis-ci.org/zalando-incubator/kopf)
[](https://codecov.io/gh/zalando-incubator/kopf)
[](https://coveralls.io/github/zalando-incubator/kopf?branch=master)
[](https://lgtm.com/projects/g/zalando-incubator/kopf/alerts/)
[](https://lgtm.com/projects/g/zalando-incubator/kopf/context:python)
**Kopf** —Kubernetes Operator Pythonic Framework— is a framework and a library
to make Kubernetes operators development easier, just in few lines of Python code.
The main goal is to bring the Domain-Driven Design to the infrastructure level,
with Kubernetes being an orchestrator/database of the domain objects (custom resources),
and the operators containing the domain logic (with no or minimal infrastructure logic).
## Documentation
* https://kopf.readthedocs.io/
## Features
* A full-featured operator in just 2 files: `Dockerfile` + a Python module.
* Implicit object's status updates, as returned from the Python functions.
* Multiple creation/update/deletion handlers to track the object handling process.
* Update handlers for the selected fields with automatic value diffs.
* Dynamically generated sub-handlers using the same handling tracking feature.
* Retries of the handlers in case of failures or exceptions.
* Easy object hierarchy building with the labels/naming propagation.
* Built-in _events_ for the objects to reflect their state (as seen in `kubectl describe`).
* Automatic logging/reporting of the handling process (as logs + _events_).
* Handling of multiple CRDs in one process.
* The development instance temporarily suppresses the deployed ones.
## Examples
See [examples](https://github.com/zalando-incubator/kopf/tree/master/examples)
for the examples of the typical use-cases.
The minimalistic operator can look like this:
```python
import kopf
@kopf.on.create('zalando.org', 'v1', 'kopfexamples')
def create_fn(spec, meta, status, **kwargs):
print(f"And here we are! Creating: {spec}")
```
The keyword arguments available to the handlers:
* `body` for the whole body of the handled objects.
* `spec` as an alias for `body['spec']`.
* `meta` as an alias for `body['metadata']`.
* `status` as an alias for `body['status']`.
* `patch` is a dict with the object changes to applied after the handler.
* `retry` (`int`) is the sequential number of retry of this handler.
* `started` (`datetime.datetime`) is the start time of the handler, in case of retries & errors.
* `runtime` (`datetime.timedelay`) is the duration of the handler run, in case of retries & errors.
* `diff` is a list of changes of the object (only for the update events).
* `old` is the old state of the object or a field (only for the update events).
* `new` is the new state of the object or a field (only for the update events).
* `logger` is a per-object logger, with the messages prefixed with the object's namespace/name.
* `event` is the raw event as received from the Kubernetes API.
* `cause` is the processed cause of the handler as detected by the framework (create/update/delete).
`**kwargs` (or `**_` to stop lint warnings) is required for the forward
compatibility: the framework can add new keyword arguments in the future,
and the existing handlers should accept them.
## Usage
We assume that when the operator is executed in the cluster, it must be packaged
into a docker image with CI/CD tool of your preference.
```dockerfile
FROM python:3.7
ADD . /src
RUN pip install kopf
CMD kopf run /src/handlers.py
```
Where `handlers.py` is your Python script with the handlers
(see `examples/*/example.py` for the examples).
See `kopf run --help` for others ways of attaching the handlers.
## Contributing
Please read [CONTRIBUTING.md](https://github.com/zalando-incubator/kopf/blob/master/CONTRIBUTING.md)
for details on our process for submitting pull requests to us, and please ensure
you follow the [CODE_OF_CONDUCT.md](https://github.com/zalando-incubator/kopf/blob/master/CODE_OF_CONDUCT.md).
To install the environment for the local development,
read [DEVELOPMENT.md](https://github.com/zalando-incubator/kopf/blob/master/DEVELOPMENT.md).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [releases on this repository](https://github.com/zalando-incubator/kopf/releases).
## License
This project is licensed under the MIT License —
see the [LICENSE](https://github.com/zalando-incubator/kopf/blob/master/LICENSE) file for details.
## Acknowledgments
* Thanks to [@side8](https://github.com/side8) and their [k8s-operator](https://github.com/side8/k8s-operator)
for the inspiration.