meissa/c4k-mastodon-bot
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add rational

Browse source
This commit is contained in:
jem 2021-04-26 17:57:22 +02:00
parent 2b393a19d5
commit 07f6a1a4d2
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -7,6 +7,18 @@
k8s-mastodon-bot generates a k8s cron-job for your mastodon-bot. All inputs are validated, generaterd yaml will be wellformed, indenet and escaped. k8s-mastodon-bot generates a k8s cron-job for your mastodon-bot. All inputs are validated, generaterd yaml will be wellformed, indenet and escaped.
## Rational
There are many comparable solutions for creating k8s deployments like helm or kustomize. Why do we need another one?
* We like the simplicity of kustomize. Yaml in, yaml out, the ability to lint the result and the option to split large yaml files into objects. But a simple overwriting per environment may not be enough ...
* We like helm packages. A package encapsulates the setup for an application. On the one hand, but on the other hand we don't like the idea of having to program and debug in a template language. We can program much better in real programming languages.
Our k8s-* tools combine the advantages of both approaches:
* Packages for one application
* Programming in clojure
* yaml / edn as input and output, no more magic
* good validation, integration as api, cli or in the browser
## Try out ## Try out
Click on the image to try out live in your browser: Click on the image to try out live in your browser:
@ -21,14 +33,6 @@ target/graalvm/k8s-mastodon-bot src/test/resources/valid-config.edn src/test/res
target/graalvm/k8s-mastodon-bot src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubectl apply -f - target/graalvm/k8s-mastodon-bot src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubectl apply -f -
``` ```
## Integration
We provide a bunch of artefacts:
* compiled binary, you may use it in your cli or ci
* a standalone uberjar, you may use it in your cli or ci
* a clj library, you may use it as api in your clj project
* a cljs web frontend, you may use it as self-service UI
## License ## License
Copyright © 2021 meissa GmbH Copyright © 2021 meissa GmbH