🔌Frank!Framework Console Chart

The Frank!Framework Console is a web application that allows you to manage multiple instances of Frank!Framework from a single console.

Usage

Helm must be installed to use the charts. Please refer toHelm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

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.

To install the frankframework chart:

helm install my-frank-console frankframework/frank-console

To uninstall the chart:

helm delete my-frank-console

Parameters

Common parameters

Common parameters for the Frank!Framework Console chart.

Can be used to override the default name for the chart.

Frank!Framework Console image parameters

The image is pulled from nexus.frankframework.org by default. The images located there will be kept for as long as possible.

Here are the images available: https://nexus.frankframework.org/#browse/browse:frankframework-docker:v2%2Ffrankframework%2Ftags/

If you want to use a specific nightly, you can use the images on docker.io: https://hub.docker.com/r/frankframework/frankframework/tags

Environment variables

The environment variables are used to configure the Frank!Framework.

It is possible to add environment variables with the .Values.environmentVariables parameter and to add environment variables from a configmap or secret with the .Values.envFrom parameter.

In the case you are testing this Chart, you'd probably want to disable the authentication for the console and the testtool (Ladybug). To do so, you can set the following environment variables:

environmentVariables:
application.security.console.authentication.type: NONE
application.security.testtool.authentication.type: NONE

To fine tune memory refer to the Oracle documentation.

Refer to the Frank!Framework Manual for more information.

Generate ConfigMaps and Secrets

To deploy the Frank!Framework Console, it can be needed to add some files to the container.

The Frank!Framework Console chart allows you to generate configmaps and secrets from values. This is useful if you want to add local users or other authentication to the Frank!Framework Console.

Be sure to set a subPath and a mountPath if you want to avoid conflicts and use multiple secrets. With one secret, the subPath and mountPath are not needed. And it would be possible to implement items

Volumes

The Frank!Framework chart allows you to create and mount volumes to the Frank!Framework. This is useful if you want to add existing local users or authentication to the Frank!Framework.

Sidecars

The Frank!Framework chart allows you to add additional sidecar containers to the Frank!Framework pod. This is useful if you want to add additional tools to the Frank!Framework.

Ladybug Database

The Ladybug Database is a PostgreSQL dependency that is used to store Ladybug reports and is not needed when the Ladybug is disabled.

Note that this dependency is not used for the Frank!Framework itself, that datasource should be configured with the resources.yaml file.

The dependency is enabled by default, but can be disabled if you want to use an external database for Ladybug.

To configure the PostgreSQL Helm chart, please refer to the documentation: https://github.com/bitnami/charts/tree/main/bitnami/postgresql

Some of the parameters are pre-configured for an easy installation, but can be changed if needed.

Frank!Framework Console deployment parameters

The startup probe will enable blue-green deployment, which are great for uptime during upgrades and such. It (and the liveness probe) will check if the console is accessible, until a better health endpoint is available. The readiness probe will check if all adapters are running using the server health endpoint

Traffic Exposure Parameters

Other Parameters

Configuration and installation details

For now, the Frank!Framework Console is not configurable. It only works if used as a sub-chart in the Frank!Framework chart. It is planned to make it configurable in the future. And you could create and mount your worn hazelcast-network-config.xml file.