c4k-shynet/README.md

41 lines
1.8 KiB
Markdown
Raw Normal View History

2022-01-27 15:47:52 +00:00
# convention 4 kubernetes: c4k-shynet
2022-02-04 10:22:22 +00:00
[![Clojars Project](https://img.shields.io/clojars/v/org.domaindrivenarchitecture/c4k-shynet.svg)](https://clojars.org/org.domaindrivenarchitecture/c4k-shynet) [![pipeline status](https://gitlab.com/domaindrivenarchitecture/c4k-shynet/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/c4k-shynet/-/commits/main)
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +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)
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
## Purpose
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
c4k-shynet provides a k8s deployment for shynet containing:
* shynet
* ingress having a letsencrypt managed certificate
* postgres database
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
The package aims to a low load sceanrio.
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
## Status
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
Stable - we use this setup on production.
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
## Try out
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
Click on the image to try out live in your browser:
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
[![Try it out](doc/tryItOut.png "Try out yourself")](https://domaindrivenarchitecture.org/pages/dda-provision/c4k-shynet/)
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
Your input will stay in your browser. No server interaction is required.
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
You will also be able to try out on cli:
```
target/graalvm/c4k-shynet src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubeval -
target/graalvm/c4k-shynet src/test/resources/valid-config.edn src/test/resources/valid-auth.edn | kubectl apply -f -
```
2022-01-14 15:29:19 +00:00
2022-01-27 15:47:52 +00:00
## Documentation
* [Example Setup on Hetzner](doc/SetupOnHetzner.md)
2022-02-04 10:25:26 +00:00
* [Development](doc/Development.md)
2022-01-14 15:29:19 +00:00
## License
2022-01-27 15:47:52 +00:00
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)