-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0027a0c
commit 13f4f16
Showing
1 changed file
with
8 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,28 @@ | ||
| # The Frank!Framework Helm Charts | ||
|
|
||
| Popular applications, build on top of the [Frank!Framework](https://frankframework.org), ready to launch on Kubernetes using Helm. | ||
| The [Frank!Framework](https://frankframework.org) can be used to create standardized and scalable integrations. | ||
|
|
||
| ## Available charts: | ||
|
|
||
| * [frankframework](/charts/frankframework/README.md) | ||
| * [frank-console](/charts/frank-console/README.md) | ||
| * [frank2example](/charts/frank2example/README.md) | ||
| * [ff-test](/charts/ff-test/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. | ||
| [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 frankframework https://frankframework.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 | ||
| frankframework` to see the charts. | ||
| ## Common sub-charts | ||
|
|
||
| To install a chart: | ||
|
|
||
| ```shell | ||
| helm install <unique-name> frankframework/<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. | ||
| * [frankframework](/charts/frankframework/README.md) | ||
| * [frank-console](/charts/frank-console/README.md) | ||
|
|
||
| If you want to create a Frank! chart yourself, please refer to the [ff-common documentation](/charts/frankframework/README.md). There is also a [Frank! template](/ff-template/README.md) that can be copied as a starting point. | ||
| The charts above can be used as sub-charts for other charts, so other defaults can be provided and extra files can be added. | ||
| Take a look at the [Frank2Example chart](/charts/frank2example/README.md) for a simple example. |