Additional Configuration

Some configuration is better managed in its own separate file and the injected into the deployment. This mostly includes configuration files for Aspects with complex or very detailed configurations. To make this process as easy as possible we Provide multiple ways to include such configuration.

We describe the general concept of injecting the configuration and describe individual options.

Keys for customizing

The simples form of injecting your configuration is to include the whole file as a string and set it directly in the configuration. This Approach is very simple but due to its nature not very readable. For this reason we recommend this use case only for testing purposes or by automating a conversion from a file to string in the deployment pipeline. The following keys are predefined to inject content from files into the Helm chart deployment:

key	FileType	Description
global.config.annotationProfile	XML file	Allows you to customize the available annotations to be used in Dossier Organizer as well as customizing their behaviour. Since the annotation profile is used by multiple containers, it is defined in the values "global" space
organizer.config.favicon	PNG, GIF, or ICO file	Swaps out the application Icon.
organizer.config.logos	image file	Swaps out the application logo.
organizer.config.styles	CSS File	Allows you to override predefined Color variables and add arbitrary style rules to alter the appearance of your application.
organizer.config.collectionTypeDefinitions (list) organizer.config.collectionTypeNames (list)	YAML file Text	CollectionTypes allow you to customize the structure in which the Elements of your collections are displayed in the UI, configure behaviour and more. Lists the corresponding collection type names to the definitions defined in 'collectionTypeDefinitions'. The name must be the same as the ID defined in the collection definition json. The number and order of elements has to match its counterpart in 'collectionTypeDefinitions'.
organizer.config.policyDefinitions (list) organizer.config.policyValidityDates (list)	YAML file Text	Policies to enact Rules based on collection and user context Lists the corresponding validity date of the access policies defined in 'policyDefinitions'. The date has to follow the date schema "yyyyMMdd-HHmmss-SSS". The active policy is always the policy with the newest validity that is not set in the future. The number and order of elements has to match its counterpart in 'policyDefinitions'.
organizer.truststore.cacerts	PKCS12 file	standardized and language-neutral way of storing encrypted private keys and certificates.

Deploy with customized command

To add a configuration file directly to the deployment, you can simply expand your deployment command.
This can easily be done using the --set-file parameter of the helm CLI.
If you have the want to inject raw text instead of file you can use the --set parameter in the same way.
This example command adds a custom styles CSS file and a custom logo:

$ helm upgrade --install
--values ${VALUES_FILE}
--set-file organizer.config.styles=${STYLE_OVERRIDE_FILE},organizer.config.logos=${LOGO_OVERRIDE_FILE}
fusion-dossier-organizer levigo/fusion-dossier-organizer

For list properties (collectionTypes and policies) the syntax is a little different. To be able to set multiple you can wrap individual paths or strings in braces:

$ helm upgrade --install
--values ${VALUES_FILE}
--set-file organizer.config.collectionTypeDefinitions={${COLLECTION_TYPE_FILE_1},${COLLECTION_TYPE_FILE_2}}
--set organizer.config.collectionTypeNames={MyCollectionType1,MyCollectionType2}
fusion-dossier-organizer levigo/fusion-dossier-organizer

Provide existing configmaps

If you want you can also provide these files as independent configmaps. These configmaps have to be created separately from the Dossier Organizer deployment but be accessible for the deployment process. Usually these have to be created in the same workspace.

To link these configmaps to the deployment you can set the names of the configmaps for the deployment to seach for:

key	Description
organizer.truststore.existingConfigMap	configmap fo the existing Root certificate configmap.

This functionality currently does not exist for all configuration files, but it will be added in the future.