97 lines
3.3 KiB
Markdown
97 lines
3.3 KiB
Markdown
# convention 4 kubernetes: c4k-taiga
|
|
|
|
[![Clojars Project](https://img.shields.io/clojars/v/org.domaindrivenarchitecture/c4k-taiga.svg)](https://clojars.org/org.domaindrivenarchitecture/c4k-taiga) [![pipeline status](https://gitlab.com/domaindrivenarchitecture/c4k-taiga/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/c4k-taiga/-/commits/main)
|
|
|
|
[<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) | [taiga & Blog](https://domaindrivenarchitecture.org)
|
|
|
|
## Purpose
|
|
|
|
Easily generate a config for a small scale Taiga deployment. Complete with initial super user and configurable values for flexibility.
|
|
|
|
## Status
|
|
|
|
Ready for production. We are about to migrate to taiga on our own servers.
|
|
|
|
## Try out
|
|
|
|
Click on the image to try out live in your browser:
|
|
|
|
[![Try it out](doc/tryItOut.png "Try out yourself")](https://domaindrivenarchitecture.org/pages/dda-provision/c4k-taiga/)
|
|
|
|
Your input will stay in your browser. No server interaction is required.
|
|
|
|
## Usage
|
|
|
|
To generate your configuration:
|
|
|
|
1. Create an auth.yaml and a config.yaml
|
|
|
|
You can find examples in src/test/resources/taiga-test in this repository.
|
|
Please check the ```def auth?``` and ```def config?``` definitions in src/main/cljc/dda/c4k_taiga/taiga.cljc
|
|
for required and optional values. When you plan to use the dda_backup solution, you also need the keys:
|
|
|
|
- aws-access-key-id: "AWS_KEY_ID"
|
|
- aws-secret-access-key: "AWS_KEY_SECRET"
|
|
- restic-password: ""
|
|
|
|
in your auth.yaml
|
|
|
|
and
|
|
|
|
- restic-repository: "repo-path"
|
|
|
|
in your config.yaml.
|
|
|
|
2. install jarwrapper
|
|
|
|
```bash
|
|
sudo apt install jarwrapper # on debian derivatives
|
|
```
|
|
|
|
3. execute the c4k-taiga-standalone.jar
|
|
|
|
```bash
|
|
java -jar c4k-taiga-standalone.jar config.yaml auth.yaml
|
|
```
|
|
|
|
To set up you need:
|
|
|
|
* A working DNS route to the FQDN of your taiga installation
|
|
* A kubernetes cluster provisioned by [provs]
|
|
* The .yaml file generated by c4k-taiga-standalone.jar
|
|
|
|
Apply this file on your cluster with `kubectl apply -f application.yaml`.
|
|
Done.
|
|
|
|
## Administration
|
|
|
|
You can access the administration of the taiga installation via: your.taiga.url/admin/
|
|
|
|
## Backup
|
|
|
|
You need some form of cloud storage like AWS buckets and the respective access credentials
|
|
to make the backups work correctly.
|
|
|
|
For a working backup you need to save Taiga DB & Taiga Media as described here:
|
|
https://docs.taiga.io/backup-and-restore.html
|
|
|
|
For further instruction please refer to BackupAndRestore.md in doc/ in this repository.
|
|
|
|
## Development & mirrors
|
|
|
|
Development happens at: https://repo.prod.meissa.de/meissa/c4k-taiga
|
|
|
|
Mirrors are:
|
|
|
|
* https://gitlab.com/domaindrivenarchitecture/c4k-taiga (issues and PR, CI)
|
|
* https://github.com/DomainDrivenArchitecture/c4k-taiga
|
|
|
|
For more details about our repository model see: https://repo.prod.meissa.de/meissa/federate-your-repos
|
|
|
|
## 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)
|
|
|
|
[provs]: https://gitlab.com/domaindrivenarchitecture/provs/
|