No description

Find a file

bom f45fcaab72 Version 6.0.1		2023-01-27 13:38:51 +01:00
doc	We now produce a working monitoring config	2022-12-23 14:52:43 +00:00
src	Rename keywords to monitoring specific values	2023-01-27 13:37:33 +01:00
.gitignore	add .clj-kondo and .lsp	2022-10-19 09:18:44 +02:00
.gitlab-ci.yml	Update CI to show failing tests	2022-09-02 10:13:52 +02:00
LICENSE	changed license	2021-06-18 15:36:16 +02:00
package.json	release	2022-12-28 18:05:09 +01:00
project-cljs.clj	Prep for release	2023-01-27 13:38:36 +01:00
project.clj	Version 6.0.1	2023-01-27 13:38:51 +01:00
README.md	remove no longer used refactorings	2023-01-20 16:46:24 +01:00
shadow-cljs.edn	update deps	2022-12-23 16:35:06 +00:00

README.md

convention 4 kubernetes: c4k-common

DeltaChat chat over e-mail | team@social.meissa-gmbh.de | Website & Blog

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

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

auth.edn - minimal example

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

call (with jarwrapper installed):

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

Module	Version	renamed test-helper	common load-as-edn	standardized uberjar	groups for webview	use common ingress	use common monitoring	validate examples
c4k-keycloak	0.2	-	x	x	x	x	x	x
c4k-jira	1.1	-
c4k-nextcloud	4.0	-
c4k-jitsi	1.3	-	x	x	x	x	x	x
c4k-gittea	1.0	x		x	x
c4k-shynet	1.0	-		x
c4k-website	1.1	x	x	x	x	x	x	x