c4k-common/README.md

# convention 4 kubernetes: c4k-common
[![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) 

[<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 provides the foundation for all our c4k modules.

It is now possible to generate a working prometheus monitoring file in yaml format.
Your config.edn and your auth.edn should at least contain the following fields:

config.edn - minimal example

```clojure
{:k3s-cluster-name "your-cluster-name"
 :k3s-cluster-stage :prod
 :grafana-cloud-url "your-url"}
```  

auth.edn - minimal example  

```clojure
{:grafana-cloud-user "user"
 :grafana-cloud-password "password"}
```  

call (with jarwrapper installed):  

```bash
c4k-common-standalone.jar config.edn auth.edn > monitoring.yaml
```


## Rationale

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

## Usage

c4k-common provides the basic functionality for our c4k-modules.

## Refactoring & Module Overview

<!--- 
1. version 
2. configs as EDN and YAML
3. renamed test-helper
4. common load-as-edn
5. standardized uberjar
6. groups for webview
7. use common ingress
-->

| Module           | Version | [renamed test-helper][th1] | [common load-as-edn][edn1] | [standardized uberjar][ujar1] | [groups for webview][bgrp1] | [use common ingress][ing1] | [use common monitoring][mon1] | [validate examples][val1] |
|------------------|---------|:--------------------------:|:--------------------------:|:-----------------------------:|:---------------------------:|:--------------------------:|:-----------------------------:|:-------------------------:|
| c4k-keycloak     | 0.2     |             -              |             x              |               x               |              x              |             x              |               x               |             x             |
| c4k-jira         | 1.1     |             -              |                            |                               |                             |                            |                               |                           |
| c4k-nextcloud    | 4.0     |             -              |             x              |               x               |              x              |             x              |               x               |             x             |
| c4k-jitsi        | 1.3     |             -              |             x              |               x               |              x              |             x              |               x               |             x             |
| c4k-gittea       | 1.0     |             x              |             x              |               x               |              x              |             x              |               x               |             x             |
| c4k-shynet       | 1.0     |             -              |                            |               x               |                             |                            |                               |                           |
| c4k-website      | 1.1     |             x              |             x              |               x               |              x              |             x              |               x               |             x             |

[th1]: https://gitlab.com/domaindrivenarchitecture/c4k-gitea/-/merge_requests/1
[edn1]: https://gitlab.com/domaindrivenarchitecture/c4k-website/-/merge_requests/1
[ing1]:  https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/214aa41c28662fbf7a49998e17404e7ac9216430
[ujar1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/b852a74dc561c3ab619e4f4d0748ab51e75edc13
[bgrp1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/7ea442adaef727d5b48b242fd0baaaf51902d06e
[mon1]:  https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/19e580188ea56ea26ff3a0bfb08ca428b881ad9a
[val1]:  https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/5f08a108072569473463fb8f19150a12e564e54f

## License

Copyright © 2022 meissa GmbH
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)
initial commit 2021-06-18 13:34:01 +00:00			`# convention 4 kubernetes: c4k-common`
adjust batches 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)
initial commit 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`

[Skip-CI] Update Readme 2022-12-23 15:02:30 +00:00			`c4k-common provides the foundation for all our c4k modules.`

			`It is now possible to generate a working prometheus monitoring file in yaml format.`
			`Your config.edn and your auth.edn should at least contain the following fields:`

			`config.edn - minimal example`

			```clojure
			`{:k3s-cluster-name "your-cluster-name"`
			`:k3s-cluster-stage :prod`
			`:grafana-cloud-url "your-url"}`
			```

			`auth.edn - minimal example`

			```clojure
			`{:grafana-cloud-user "user"`
			`:grafana-cloud-password "password"}`
			```

			`call (with jarwrapper installed):`

			```bash
			`c4k-common-standalone.jar config.edn auth.edn > monitoring.yaml`
			```

initial commit 2021-06-18 13:34:01 +00:00
Update Refactorings 2022-11-09 10:46:22 +00:00			`## Rationale`
initial commit 2021-06-18 13:34:01 +00:00
			`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`

mob 2021-07-09 14:39:36 +00:00			`## Usage`

Update Refactorings 2022-11-09 10:46:22 +00:00			`c4k-common provides the basic functionality for our c4k-modules.`
mob 2021-07-09 14:39:36 +00:00
add refactoring overview 2021-09-08 11:03:43 +00:00			`## Refactoring & Module Overview`

Update status of refactorings 2022-11-18 11:18:26 +00:00			`<!---`
			`1. version`
remove no longer used refactorings 2023-01-20 15:46:24 +00:00			`2. configs as EDN and YAML`
			`3. renamed test-helper`
			`4. common load-as-edn`
			`5. standardized uberjar`
			`6. groups for webview`
			`7. use common ingress`
Update status of refactorings 2022-11-18 11:18:26 +00:00			`-->`

remove no longer used refactorings 2023-01-20 15:46:24 +00:00			`\| Module \| Version \| [renamed test-helper][th1] \| [common load-as-edn][edn1] \| [standardized uberjar][ujar1] \| [groups for webview][bgrp1] \| [use common ingress][ing1] \| [use common monitoring][mon1] \| [validate examples][val1] \|`
			`\|------------------\|---------\|:--------------------------:\|:--------------------------:\|:-----------------------------:\|:---------------------------:\|:--------------------------:\|:-----------------------------:\|:-------------------------:\|`
			`\| c4k-keycloak \| 0.2 \| - \| x \| x \| x \| x \| x \| x \|`
			`\| c4k-jira \| 1.1 \| - \| \| \| \| \| \| \|`
Update refactoring table Add c4k-nextcloud changes 2023-03-02 10:37:30 +00:00			`\| c4k-nextcloud \| 4.0 \| - \| x \| x \| x \| x \| x \| x \|`
remove no longer used refactorings 2023-01-20 15:46:24 +00:00			`\| c4k-jitsi \| 1.3 \| - \| x \| x \| x \| x \| x \| x \|`
Update refactoring table Add c4k-gitea changes 2023-03-28 10:10:45 +00:00			`\| c4k-gittea \| 1.0 \| x \| x \| x \| x \| x \| x \| x \|`
remove no longer used refactorings 2023-01-20 15:46:24 +00:00			`\| c4k-shynet \| 1.0 \| - \| \| x \| \| \| \| \|`
			`\| c4k-website \| 1.1 \| x \| x \| x \| x \| x \| x \| x \|`

update refactoring state 2022-07-29 12:19:05 +00:00			`[th1]: https://gitlab.com/domaindrivenarchitecture/c4k-gitea/-/merge_requests/1`
Update Refactorings 2022-11-09 10:46:22 +00:00			`[edn1]: https://gitlab.com/domaindrivenarchitecture/c4k-website/-/merge_requests/1`
[skip-ci] updated refactoring state 2022-12-28 19:15:20 +00:00			`[ing1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/214aa41c28662fbf7a49998e17404e7ac9216430`
			`[ujar1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/b852a74dc561c3ab619e4f4d0748ab51e75edc13`
			`[bgrp1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/7ea442adaef727d5b48b242fd0baaaf51902d06e`
			`[mon1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/19e580188ea56ea26ff3a0bfb08ca428b881ad9a`
			`[val1]: https://repo.prod.meissa.de/meissa/c4k-jitsi/commit/5f08a108072569473463fb8f19150a12e564e54f`
pin postgres to version 13 2021-10-08 09:41:46 +00:00
initial commit 2021-06-18 13:34:01 +00:00			`## License`

Updated README.md 2022-05-11 12:52:17 +00:00			`Copyright © 2022 meissa GmbH`
initial commit 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)`