c4k-keycloak/README.md

40 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2021-06-05 15:23:46 +00:00
# convention 4 kubernetes: c4k-keycloak
2021-06-05 15:27:42 +00:00
[![Clojars Project](https://img.shields.io/clojars/v/dda/c4k-keycloak.svg)](https://clojars.org/org.domaindrivenarchitecture/c4k-keycloak) [![pipeline status](https://gitlab.com/domaindrivenarchitecture/c4k-keycloak/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/c4k-keycloak/-/commits/master)
2021-05-17 07:28:01 +00:00
[<img src="https://domaindrivenarchitecture.org/img/delta-chat.svg" width=20 alt="DeltaChat"> chat over e-mail](mailto:buero@meissa-gmbh.de?subject=community-chat) | [<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org)
## Purpose
2021-06-05 15:20:15 +00:00
c4k-keycloak ....
2021-05-17 07:28:01 +00:00
## Rational
2021-06-05 15:27:42 +00:00
There are many comparable solutions for creating c4k deployments like helm or kustomize. Why do we need another one?
2021-05-17 07:28:01 +00:00
* 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.
2021-06-05 15:20:15 +00:00
Our convention 4 kubernetes c4k-* tools combine the advantages of both approaches:
2021-05-17 07:28:01 +00:00
* 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
Click on the image to try out live in your browser:
2021-06-05 15:20:15 +00:00
[![Try it out](/doc/tryItOut.png "Try out yourself")](https://domaindrivenarchitecture.org/pages/dda-provision/c4k-keycloak/)
2021-05-17 07:28:01 +00:00
Your input will stay in your browser. No server interaction is required.
You will also be able to try out on cli:
```
2021-06-05 15:20:15 +00:00
target/graalvm/c4k-keycloak src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubeval -
target/graalvm/c4k-keycloak src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubectl apply -f -
2021-05-17 07:28:01 +00:00
```
## License
Copyright © 2021 meissa GmbH
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)