Replace the default form for the tenant selection web page provided by the AUTHENTICATION service by a custom form.

Introduction

Users accessing yuuvis® Momentum via a browser have to select their tenant before their credentials are requested. This tenant selection web page is provided by the AUTHENTICATION Service. In order to customize the design, it is possible to replace the underlying default form files by a set of custom form files. There are different ways to proceed:

• Kubernetes ConfigMaps
• Manual replacement after starting the pod
• A custom Docker image with the custom form files in a separated layer
• Integration of the custom form files via Kubernetes Volumes

In all cases, a directory public has to be available in the root of the AUTHENTICATION service's container when the service is started. In this public directory, there must be at least the files tenant.html and error.html. The usage of resource files is possible if they are located in the sub directory /public/res/ or if they are stored by a client application.

In this article, only the first procedure via Kubernetes ConfigMaps is described. The replacement of the default form files is explained by means of a simple example.

Configuration Steps

The example custom form files used in this example are available for download as public.zip file.
>> Download example 'public.zip'

By following these steps, you configure a simple custom web page for the tenant selection dialog:

• Add the following line in the authentication-prod.yml configuration file:

  spring.thymeleaf.prefix: 'file:/public/'

• Unpack the public.zip file.

• Create a ConfigMap for the files in the public directory via the command:

  kubectl -n yuuvis create configmap templates --from-file=./public/

• Adjust the Kubernetes deployment of the AUTHENTICATION service via the command:

  kubectl -n yuuvis edit deploy authentication

• Extend the volumes section as follows:

  volumes:
  - name: templates
    configMap:
      name: templates

• Extend the volumeMounts section as follows:

  volumeMounts:
  - name: templates
    mountPath: /public/tenant.html
    subPath: tenant.html
  - name: templates
    mountPath: /public/error.html
    subPath: error.html
  - name: templates
    mountPath: /public/res/tenant.css
    subPath: tenant.css
  - name: templates
    mountPath: /public/res/next-btn.svg
    subPath: next-btn.svg

• Restart the AUTHENTICATION service.