From 5315f23b0a82a9788822986a643c042af427bd05 Mon Sep 17 00:00:00 2001 From: Sergi Philipsen Date: Thu, 12 Oct 2023 16:01:25 +0200 Subject: [PATCH] Create README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e46abf5 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# WeAreFrank! Helm Charts + +Popular applications, and Franks! build on top of the [Frank!Framework](https://frankframework.org), ready to launch on Kubernetes using Helm. + +## Available charts: + +* [Apache Drill](/charts/drill/README.md) +* [ZaakBrug](/charts/zaakbrug/README.md) + +## Usage + +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. + +Once Helm has been set up correctly, add the repo as follows: + +```shell +helm repo add ibissource https://ibissource.github.io/charts +``` + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +ibissource` to see the charts. + +To install a chart: + +```shell +helm install ibissource/ +``` + +To uninstall the chart: + +```shell +helm delete +``` + +## Common library + +The Franks! are based on the "ff-common" library chart. This is done to ensure each chart can be kept up to date easily. + +If you want to create a Frank! chart yourself, please refer to the [ff-common documentation](https://github.com/ibissource/charts/blob/master/charts/frank-framework/README.md). There is also a [Frank! template](https://github.com/ibissource/charts/blob/master/ff-template/README.md) that can be copied as a starting point.