Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philipsens authored Oct 12, 2023
1 parent 190c243 commit 5315f23
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <unique-name> ibissource/<chart>
```

To uninstall the chart:

```shell
helm delete <unique-name>
```

## 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.

0 comments on commit 5315f23

Please sign in to comment.