c4k-common/README.md

42 lines
3.4 KiB
Markdown
Raw Normal View History

2021-06-18 13:34:01 +00:00
# convention 4 kubernetes: c4k-common
2021-06-18 14:58:06 +00:00
[![Clojars Project](https://img.shields.io/clojars/v/org.domaindrivenarchitecture/c4k-common-clj.svg)](https://clojars.org/org.domaindrivenarchitecture/c4k-common-clj) [![Clojars Project](https://img.shields.io/clojars/v/org.domaindrivenarchitecture/c4k-common-cljs.svg)](https://clojars.org/org.domaindrivenarchitecture/c4k-common-cljs) [![pipeline status](https://gitlab.com/domaindrivenarchitecture/c4k-common/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/c4k-common/-/commits/master)
2021-06-18 13:34: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
c4k-common ....
## Rational
There are many comparable solutions for creating c4k 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 convention 4 kubernetes c4k-* 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
2021-07-09 14:39:36 +00:00
## Usage
2021-09-08 11:03:43 +00:00
## Refactoring & Module Overview
2022-05-11 12:52:17 +00:00
| Module | Version | common postgres | frontend script | provider adapter | [backup as deployment][bak1] | [speced c4k-common][com1] | [configs can be of type EDN and YAML][yaml1] |
|------------------|---------|:---------------:|:---------------:|:----------------:|:----------------------------:|:-------------------------:|:--------------------------------------------:|
| c4k-mastodon-bot | 0.1 | - | | | | | |
| c4k-keycloak | 0.2 | | | | | | |
2022-05-20 16:03:18 +00:00
| c4k-jira | 1.1 | x | x | | x | | |
2022-06-10 13:17:01 +00:00
| c4k-nextcloud | 2.0 | x | x | | x | x | x |
2021-09-08 11:03:43 +00:00
2021-10-08 09:41:46 +00:00
[bak1]: https://gitlab.com/domaindrivenarchitecture/c4k-jira/-/merge_requests/1
2021-11-12 10:15:59 +00:00
[com1]: https://gitlab.com/domaindrivenarchitecture/c4k-nextcloud/-/merge_requests/3
2022-05-11 12:52:17 +00:00
[yaml1]: https://gitlab.com/domaindrivenarchitecture/c4k-nextcloud/-/merge_requests/4
2021-10-08 09:41:46 +00:00
2021-06-18 13:34:01 +00:00
## License
2022-05-11 12:52:17 +00:00
Copyright © 2022 meissa GmbH
2021-06-18 13:34:01 +00:00
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)