Version: Next

Installing on Openshift

Suitable for

This installation is tested for Openshift 4.13 and the following products:

jf-ocr-bundle: version: 1.1.7

Prerequisites

OpenShift CLI
Helm 3.1.0+
(optional: PV provisioner support in the underlying infrastructure - if job metadata are stored in the MariaDB)
(optional: sealed secrets )
(optional: cert-manager Operator and Cert Utils Operator for TLS support)

Registry Access

Because the images used in this chart are from a private container registry you need to have

access to the container registry registry.jadice.com

Since the used Helm charts come from a private container registry, they also require

access to the helm registry artifacts.jadice.com

For details see image pull secrets.

Installing with Helm

On this page we showcase how to install a jadice flow product via its corresponding Helm Chart.

$ helm repo add levigo https://artifacts.jadice.com/repository/helm-charts/ --username <username> --password <password>

Adjustment of the Required Parameters

For the bundle to start successfully, a few adjustments to the value file are required. For this we create a default value.yaml file.

Required Parameters

By default, the jadice flow products use the eureka storage backend and an embedded H2 database. This means only the access to the jadice container registry must be configured. On how-to replace eureka with S3 or WebDAV see secrets and if you don't want to use the embedded H2 database follow the instructions in database.

A minimal values.yaml containing only the necessary parameters:

minimal-values.yaml

secrets:
   imageRegistry:
      server: registry.jadice.com
      username: <username>
      password: <password>

The installation on OpenShift shares most of its configuration with the installation on Kubernetes. The only OpenShift specific feature is the support of Routes. Of course, you could also use a Kubernetes Ingress and let OpenShift create a Route for it. But if you need to configure some configuration values that only exist in a Route but not in an Ingress you can create the Routes directly with this Helm chart.

jf-controller:
    route:
      enabled: true
      subdomain: jf-controller
      annotations:
        my.annotations.io/example: just-an-example
      wildcardPolicy: None
      tls:
        termination: edge
        insecureEdgeTerminationPolicy: Redirect

Further customization options, as well as the default values file can be found in the repository in the Values.yaml, as well as in the README of the respective product.

Download the README:

$ helm pull "levigo/jf-ocr" --untar
$ cat jf-ocr-bundle/README.md

Install from jadice helm repository

$ oc login --token=MyToken --server=MyServer
$ oc new-project <project_name> --description="<description>" --display-name="<display_name>"
$ oc project <project_name>

With the following command, the Chart will be installed. In this case our release name will be jf-ocr:

$ helm install jf-ocr levigo/jf-ocr -f values.yaml

Troubleshooting

If your worker has failed the Liveness test multiple times, raise the initialDelaySeconds value.

jf-worker-topdf:
  livenessProbe:
    initialDelaySeconds: 120

Suitable for​

Prerequisites​

Registry Access​

Installing with Helm​

Adjustment of the Required Parameters​

Required Parameters​

Install from jadice helm repository​

Troubleshooting​