Skip to content

Commit

Permalink
feat: match references and chart to frankframework
Browse files Browse the repository at this point in the history
  • Loading branch information
philipsens committed Nov 21, 2023
1 parent 60bb964 commit 37442c1
Show file tree
Hide file tree
Showing 30 changed files with 72 additions and 68 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Popular applications, build on top of the [Frank!Framework](https://frankframewo

## Available charts:

* [frank-framework](/charts/frank-framework/README.md)
* [frank2example](/charts/frank-framework/README.md)
* [ff-test](/charts/frank-framework/README.md)
* [frankframework](/charts/frankframework/README.md)
* [frank2example](/charts/frankframework/README.md)
* [ff-test](/charts/frankframework/README.md)

## Usage

Expand All @@ -16,17 +16,17 @@ 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
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
ibissource` to see the charts.
frankframework` to see the charts.

To install a chart:

```shell
helm install <unique-name> ibissource/<chart>
helm install <unique-name> frankframework/<chart>
```

To uninstall the chart:
Expand All @@ -39,4 +39,4 @@ helm delete <unique-name>

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](/charts/frank-framework/README.md). There is also a [Frank! template](/ff-template/README.md) that can be copied as a starting point.
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.
4 changes: 2 additions & 2 deletions charts/ff-common/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
description: ff-common chart building components and helpers for the Frank!Framework
name: ff-common
version: 0.1.16
version: 0.1.17
appVersion: "7.8"
home: https://frankframework.org
icon: https://raw.githubusercontent.com/ibissource/charts/master/charts/ff-common/icon.svg
icon: https://raw.githubusercontent.com/frankframework/charts/master/charts/ff-common/icon.svg
2 changes: 1 addition & 1 deletion charts/ff-common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Whereas the sub-chart can only be used "as is", the library can be modified in y
| Name | Description | Value |
| ------------------- | ---------------------------------------------------------- | -------------------------- |
| `image.registry` | Frank!Framework image registry | `nexus.frankframework.org` |
| `image.repository` | Frank!Framework image repository | `frank-framework` |
| `image.repository` | Frank!Framework image repository | `frankframework` |
| `image.tag` | Frank!Framework image tag (immutable tags are recommended) | `""` |
| `image.pullPolicy` | Frank!Framework image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Frank!Framework image pull secrets | `[]` |
Expand Down
2 changes: 1 addition & 1 deletion charts/ff-common/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"repository": {
"type": "string",
"description": "Frank!Framework image repository",
"default": "frank-framework"
"default": "frankframework"
},
"tag": {
"type": "string",
Expand Down
4 changes: 2 additions & 2 deletions charts/ff-common/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ fullnameOverride: ""
##

## Frank!Framework image
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrank-framework%2Ftags/
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/
## @param image.registry Frank!Framework image registry
## @param image.repository Frank!Framework image repository
## @param image.tag Frank!Framework image tag (immutable tags are recommended)
##
image:
registry: nexus.frankframework.org
repository: frank-framework
repository: frankframework
tag: ""
## @param image.pullPolicy Frank!Framework image pull policy
## Specify a imagePullPolicy
Expand Down
6 changes: 3 additions & 3 deletions charts/ff-test/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: ff-common
repository: file://../ff-common
version: 0.1.16
digest: sha256:2f2cfe01345e8bc408d1f4099233b5393d9cdb3ecfce2c010da6245d75a5c32b
generated: "2023-11-09T14:14:33.445460255+01:00"
version: 0.1.17
digest: sha256:353f8759953bd5fd67bd59a10d53622a7837c9cf1ac369c4d06bc221e41aadcb
generated: "2023-11-21T10:37:23.13351162+01:00"
6 changes: 3 additions & 3 deletions charts/ff-test/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ apiVersion: v2
appVersion: "latest-tomcat"
description: A Helm chart for testing the Frank!Framework on Kubernetes
name: ff-test
icon: https://raw.githubusercontent.com/ibissource/charts/master/charts/ff-test/icon.svg
icon: https://raw.githubusercontent.com/frankframework/charts/master/charts/ff-test/icon.svg
type: application
version: 0.2.27
version: 0.2.28

dependencies:
- name: ff-common
version: ~0.1.16
version: ~0.1.17
repository: file://../ff-common
6 changes: 3 additions & 3 deletions charts/ff-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ 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
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
ibissource` to see the charts.
frankframework` to see the charts.

To install the ff-test chart:

```shell
helm install my-ff-test ibissource/ff-test
helm install my-ff-test frankframework/ff-test
```

To uninstall the chart:
Expand Down
2 changes: 1 addition & 1 deletion charts/ff-test/templates/configmap.context.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{/*
This is a copy of https://github.com/ibissource/iaf/blob/master/test/src/main/webapp/META-INF/context.xml
This is a copy of https://github.com/frankframework/iaf/blob/master/test/src/main/webapp/META-INF/context.xml
*/}}
{{- template "ff-common.configmap.context" (list . "ff-test.configmap.context" ) -}}
{{- define "ff-test.configmap.context" -}}
Expand Down
4 changes: 2 additions & 2 deletions charts/ff-test/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ fullnameOverride: ""
##

## Frank!Framework image
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrank-framework%2Ftags/
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/
## @param image.registry Frank!Framework image registry
## @param image.repository Frank!Framework image repository
## @param image.tag Frank!Framework image tag (immutable tags are recommended)
Expand Down Expand Up @@ -127,7 +127,7 @@ frank:
## @param frank.environmentVariables [object] Set extra environment variables for the Frank!
## @param frank.environmentVariables.jdbc.dbms.default [string] The default jdbc that will be used. This should match with one of the jdbc's in the context.xml e.g. `postgres-xe`
## @param frank.environmentVariables.jms.provider.default [string] The default jms that will be used. This should match with one of the jms's in the context.xml e.g. `artemis`. `frank.server.transactionManager` needs to be set.
## More properties can be set. ref: https://github.com/ibissource/iaf/blob/master/test/src/main/resources/DeploymentSpecifics.properties
## More properties can be set. ref: https://github.com/frankframework/iaf/blob/master/test/src/main/resources/DeploymentSpecifics.properties
##
environmentVariables:
jdbc.dbms.default: 'h2'
Expand Down
6 changes: 0 additions & 6 deletions charts/frank-framework/Chart.lock

This file was deleted.

6 changes: 3 additions & 3 deletions charts/frank2example/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: ff-common
repository: file://../ff-common
version: 0.1.16
digest: sha256:2f2cfe01345e8bc408d1f4099233b5393d9cdb3ecfce2c010da6245d75a5c32b
generated: "2023-11-09T11:21:52.491374244+01:00"
version: 0.1.17
digest: sha256:353f8759953bd5fd67bd59a10d53622a7837c9cf1ac369c4d06bc221e41aadcb
generated: "2023-11-21T10:37:37.405273315+01:00"
6 changes: 3 additions & 3 deletions charts/frank2example/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ apiVersion: v2
appVersion: "latest"
description: A Helm chart for running Frank2Example on Kubernetes
name: frank2example
icon: https://raw.githubusercontent.com/ibissource/charts/master/charts/frank2example/icon.svg
icon: https://raw.githubusercontent.com/frankframework/charts/master/charts/frank2example/icon.svg
type: application
version: 0.2.9
version: 0.2.10

dependencies:
- name: ff-common
version: ~0.1.16
version: ~0.1.17
repository: file://../ff-common
6 changes: 3 additions & 3 deletions charts/frank2example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ 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
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
ibissource` to see the charts.
frankframework` to see the charts.

To install the frank2example chart:

```shell
helm install my-frank2example ibissource/frank2example
helm install my-frank2example frankframework/frank2example
```

To uninstall the chart:
Expand Down
2 changes: 1 addition & 1 deletion charts/frank2example/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ fullnameOverride: ""
##

## Frank!Framework image
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrank-framework%2Ftags/
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/
## @param image.registry Frank!Framework image registry
## @param image.repository Frank!Framework image repository
## @param image.tag Frank!Framework image tag (immutable tags are recommended)
Expand Down
File renamed without changes.
6 changes: 6 additions & 0 deletions charts/frankframework/Chart.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
dependencies:
- name: ff-common
repository: file://../ff-common
version: 0.1.17
digest: sha256:353f8759953bd5fd67bd59a10d53622a7837c9cf1ac369c4d06bc221e41aadcb
generated: "2023-11-21T10:37:52.443945524+01:00"
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
apiVersion: v2
appVersion: "7.8"
description: A Helm chart for running the Frank!Framework on Kubernetes
name: frank-framework
icon: https://raw.githubusercontent.com/ibissource/charts/master/charts/frank-framework/icon.svg
name: frankframework
icon: https://raw.githubusercontent.com/frankframework/charts/master/charts/frankframework/icon.svg
type: application
version: 0.2.9
version: 0.2.10

dependencies:
- name: ff-common
version: ~0.1.16
version: ~0.1.17
repository: file://../ff-common
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ 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
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
ibissource` to see the charts.
frankframework` to see the charts.

To install the frank-framework chart:
To install the frankframework chart:

```shell
helm install my-frank-framework ibissource/frank-framework
helm install my-frankframework frankframework/frankframework
```

To uninstall the chart:

```shell
helm delete my-frank-framework
helm delete my-frankframework
```

## Parameters
Expand All @@ -45,7 +45,7 @@ helm delete my-frank-framework
| Name | Description | Value |
| ------------------- | ---------------------------------------------------------- | -------------------------- |
| `image.registry` | Frank!Framework image registry | `nexus.frankframework.org` |
| `image.repository` | Frank!Framework image repository | `frank-framework` |
| `image.repository` | Frank!Framework image repository | `frankframework` |
| `image.tag` | Frank!Framework image tag (immutable tags are recommended) | `""` |
| `image.pullPolicy` | Frank!Framework image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Frank!Framework image pull secrets | `[]` |
Expand Down Expand Up @@ -156,6 +156,10 @@ For more information about DTAP stages read: https://frank-manual.readthedocs.io

## Notable changes

### 0.2.10

The name of the chart has been renamed (frankframework) to match the project, organisation and Docker image.

### 0.2.8

The `.Values.frank.memory` notation has been changed. It is now possible to define a minimum and a maximum, and to set percentages.
Expand Down
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"repository": {
"type": "string",
"description": "Frank!Framework image repository",
"default": "frank-framework"
"default": "frankframework"
},
"tag": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ fullnameOverride: ""
##

## Frank!Framework image
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrank-framework%2Ftags/
## ref: https://https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/
## @param image.registry Frank!Framework image registry
## @param image.repository Frank!Framework image repository
## @param image.tag Frank!Framework image tag (immutable tags are recommended)
##
image:
registry: nexus.frankframework.org
repository: frank-framework
repository: frankframework
tag: ""
## @param image.pullPolicy Frank!Framework image pull policy
## Specify a imagePullPolicy
Expand Down
6 changes: 3 additions & 3 deletions ff-template/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: ff-common
repository: file://../charts/ff-common
version: 0.1.15
digest: sha256:2556e636a35d108ffb0587f62ad241e43db2739910e93198009bc066f4c8f830
generated: "2023-10-03T02:29:53.917635819+02:00"
version: 0.1.17
digest: sha256:4225859041b2b69925615ac9392a6ac202c174d64f4c001d6a52d0d49e8d81f9
generated: "2023-11-21T10:34:09.343662149+01:00"
4 changes: 2 additions & 2 deletions ff-template/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ apiVersion: v2
appVersion: "7.8"
description: A Helm chart for running a Frank! on Kubernetes
name: ff-template
icon: https://raw.githubusercontent.com/ibissource/charts/master/ff-template/icon.svg
icon: https://raw.githubusercontent.com/frankframework/charts/master/ff-template/icon.svg
type: application
version: 0.1.5
version: 0.1.6

dependencies:
- name: ff-common
Expand Down
8 changes: 4 additions & 4 deletions ff-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ 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
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
ibissource` to see the charts.
frankframework` to see the charts.

To install the ff-template chart:

```shell
helm install my-ff-template ibissource/ff-template
helm install my-ff-template frankframework/ff-template
```

To uninstall the chart:
Expand All @@ -45,7 +45,7 @@ helm delete my-ff-template
| Name | Description | Value |
| ------------------- | ---------------------------------------------------------- | -------------------------- |
| `image.registry` | Frank!Framework image registry | `nexus.frankframework.org` |
| `image.repository` | Frank!Framework image repository | `frank-framework` |
| `image.repository` | Frank!Framework image repository | `frankframework` |
| `image.tag` | Frank!Framework image tag (immutable tags are recommended) | `""` |
| `image.pullPolicy` | Frank!Framework image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Frank!Framework image pull secrets | `[]` |
Expand Down
2 changes: 1 addition & 1 deletion ff-template/values.schema.json