c4k-taiga/README.md

98 lines
3.3 KiB
Markdown
Raw Normal View History

2023-07-19 11:44:04 +00:00
# convention 4 kubernetes: c4k-taiga
2023-07-19 12:01:15 +00:00
[![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)
2023-07-19 11:44:04 +00:00
2024-08-06 11:14:51 +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.de/images/parts/contact/mastodon36_hue9b2464f10b18e134322af482b9c915e_5501_filter_14705073121015236177.png" width=20 alt="M"> meissa@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@meissa) | [Blog](https://domaindrivenarchitecture.org) | [Website](https://meissa.de)
2023-07-19 11:44:04 +00:00
2023-07-19 12:01:15 +00:00
## Purpose
2023-07-19 11:44:04 +00:00
2023-09-05 10:34:08 +00:00
Easily generate a config for a small scale Taiga deployment. Complete with initial super user and configurable values for flexibility.
2023-07-19 11:44:04 +00:00
## Status
2023-11-08 15:20:46 +00:00
Ready for production. We are about to migrate to taiga on our own servers.
2023-09-05 10:34:08 +00:00
2023-07-19 11:44:04 +00:00
## Try out
2023-09-05 10:34:08 +00:00
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.
2023-07-19 11:44:04 +00:00
## Usage
2023-10-19 09:16:07 +00:00
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
2023-10-19 09:39:00 +00:00
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.
2023-10-19 09:16:07 +00:00
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:
2023-07-19 11:44:04 +00:00
2023-09-05 10:34:08 +00:00
* A working DNS route to the FQDN of your taiga installation
* A kubernetes cluster provisioned by [provs]
2023-10-19 09:16:07 +00:00
* The .yaml file generated by c4k-taiga-standalone.jar
2023-07-19 11:44:04 +00:00
2023-10-19 09:16:07 +00:00
Apply this file on your cluster with `kubectl apply -f application.yaml`.
2023-07-19 11:44:04 +00:00
Done.
2023-10-19 09:16:07 +00:00
## Administration
You can access the administration of the taiga installation via: your.taiga.url/admin/
## Backup
2023-10-19 09:16:07 +00:00
You need some form of cloud storage like AWS buckets and the respective access credentials
to make the backups work correctly.
2023-10-19 08:47:28 +00:00
For a working backup you need to save Taiga DB & Taiga Media as described here:
https://docs.taiga.io/backup-and-restore.html
2023-10-19 09:16:07 +00:00
For further instruction please refer to BackupAndRestore.md in doc/ in this repository.
2023-07-19 11:44:04 +00:00
## Development & mirrors
2023-07-19 12:01:15 +00:00
Development happens at: https://repo.prod.meissa.de/meissa/c4k-taiga
2023-07-19 11:44:04 +00:00
Mirrors are:
2023-07-20 12:33:28 +00:00
* https://gitlab.com/domaindrivenarchitecture/c4k-taiga (issues and PR, CI)
* https://github.com/DomainDrivenArchitecture/c4k-taiga
2023-07-19 11:44:04 +00:00
For more details about our repository model see: https://repo.prod.meissa.de/meissa/federate-your-repos
## License
2024-08-06 11:14:51 +00:00
Copyright © 2024 meissa GmbH
2023-07-19 11:44:04 +00:00
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/