Chapter 4. Deploying Dashbuilder Standalone on Red Hat OpenShift Container Platform

PDF

You can use Dashbuilder Standalone to view dashboards in OpenShift that were created in and exported from Business Central. This is useful for reviewing business metrics in environments that do not have Business Central. Use the Dashbuilder Standalone operator to deploy Dashbuilder Standalone on Red Hat OpenShift Container Platform separately from other services.

Prerequisites

Dashbuilder Standalone is available in the OpenShift registry.
You have prepared your OpenShift environment as described in Chapter 3, Deployment and management of a Red Hat Process Automation Manager environment using OpenShift operators
You have created and exported a dashboard in Business Central.

Procedure

On the Operator Installation page, enter a name for your application in the Application name field.
In the Environment field, enter a name for your environment, for example rhpam-standalone-dashbuilder.
Click Next.
Optional: On the Security page, configure LDAP or Red Hat Single Sign-On.
On the Components page, select Dashbuilder from the Components list.
To add a KIE Server data set, complete the following tasks:
Note
You can add additional KIE Server data sets by repeating this step.
1. Click Add new KIE Server DataSets.
2. In the DataSet name field, enter kieserver-1.
3. In the Kie Server Location field, enter the location of your KIE Server, for example https://my-kie-server:80/services/rest/server.
4. To set your credentials, complete one of the following tasks:
  - If you do not have a token set, in the Username and Password fields, enter your username and password. Leave the Token field blank.
  - If you have a token, in the Token field, enter your token. Leave the Username and Password fields blank.
    The custom resource example:
    apiVersion: app.kiegroup.org/v2 kind: KieApp metadata: name: standalone-dashbuilder spec: environment: rhpam-standalone-dashbuilder objects: dashbuilder: config: kieServerDataSets: - name: kieserver-1 location: 'https://my-kie-server:80/services/rest/server' user: kieserverAdmin password: kieserverAdminPwd replaceQuery: true
To add a KIE Server template, complete the following tasks:
Note
You can add additional KIE Server templates by repeating this step.
1. Click Add new KIE Server Templates.
2. In the Template name field, enter a name for your template, for example kieserver-template.
3. In the KIE Server Location field, enter the location of your KIE Server, for example https://my-other-kie-server:80/services/rest/server.
4. To set your credentials, complete one of the following tasks:
  - If you do not have a token set, in the Username and Password fields, enter your username and password. Leave the Token field blank.
  - If you have a token, in the Token field, enter your token. Leave the Username and Password fields blank.
    apiVersion: app.kiegroup.org/v2 kind: KieApp metadata: name: standalone-dashbuilder spec: environment: rhpam-standalone-dashbuilder objects: dashbuilder: config: kieServerDataSets: - name: kieserver-1 location: 'https://my-kie-server:80/services/rest/server' user: kieserverAdmin password: kieserverAdminPwd replaceQuery: true kieServerTemplates: - name: kieserver-template location: 'https://my-another-kie-server:80/services/rest/server' user: user password: pwd replaceQuery: true

4.1. Dashbuilder Standalone environment variables

When you use the Dashbuilder Container Image within operator, you can configure Dashbuilder by using the environment variables or through Custom Resource.

Table 4.1. Custom Resource parameters
Parameter	Equivalent Environment Variable	Description	Example value
`allowExternalFileRegister`	`DASHBUILDER_ALLOW_EXTERNAL_FILE_REGISTER`	Allows downloading of external (remote) files. Default value is false.	False
`componentEnable`	`DASHBUILDER_COMP_ENABLE`	Enables external components.	True
`componentPartition`	`DASHBUILDER_COMPONENT_PARTITION`	Enables partitioning of components by the Runtime Model ID. Default value is true.	True
`configMapProps`	`DASHBUILDER_CONFIG_MAP_PROPS`	Allows the use of the properties file with Dashbuilder configurations. Unique properties are appended and if a property is set more than once, the one from the properties file is used.	True
`dataSetPartition`	`DASHBUILDER_DATASET_PARTITION`	Enables partitioning of Dataset IDs by the Runtime Model ID. Default value is true.	True
`enableBusinessCentral`	—	Enables integration with Business Central by configuring Business Central and Dashbuilder automatically. Only available on operator.	True
`enableKieServer`	—	Enables integration with KIE Server by configuring KIE Server and Dashbuilder automatically. Only available on operator.	True
`externalCompDir`	`DASHBUILDER_EXTERNAL_COMP_DIR`	Sets the base directory where dashboard ZIP files are stored. If `PersistentConfigs` is enabled and `ExternalCompDir` is not set to an existing path, the `/opt/kie/dashbuilder/components` directory is used.	—
`importFileLocation`	`DASHBUILDER_IMPORT_FILE_LOCATION`	Sets a static dashboard to run automatically. If this property is set, imports are not allowed.	—
`importsBaseDir`	`DASHBUILDER_IMPORTS_BASE_DIR`	Sets the base directory where dashboard ZIP files are stored. If `PersistentConfigs` is enabled and `ImportsBaseDir` is not set to an existing path, the `/opt/kie/dashbuilder/imports` directory is used. If `ImportFileLocation` is set `ImportsBaseDir` is ignored.	—
`kieServerDataSets`	`KIESERVER_DATASETS`	Defines the KIE Server data sets access configuration.	—
`kieServerTemplates`	`KIESERVER_SERVER_TEMPLATES`	Defines the KIE Server Templates access configuration.	—
`modelFileRemoval`	`DASHBUILDER_MODEL_FILE_REMOVAL`	Enables automatic removal of model file from the file system. Default value is false.	False
`modelUpdate`	`DASHBUILDER_MODEL_UPDATE`	Allows Runtime to check model last update in the file system to update the content. Default value is true.	True
`persistentConfigs`	``	Sets Dashbuilder as not ephemeral. If `ImportFileLocation` is set `PersistentConfigs` is ignored. Default value is true. Available only on operator.	True
`runtimeMultipleImport`	`DASHBUILDER_RUNTIME_MULTIPLE_IMPORT`	Allows Runtime to allow imports (multi-tenancy). Default value is false.	False
`uploadSize`	`DASHBUILDER_UPLOAD_SIZE`	Sets the size limit for dashboard uploads (in kb). Default value is 10485760 kb.	10485760
`env`	—	Represents an environment variable present in a Container.	—

You can use operator to set environment variables by using the env property. The following example sets the value of the DASHBUILDER_UPLOAD_SIZE property to 1000.

apiVersion: app.kiegroup.org/v2
kind: KieApp
metadata:
  name: standalone-dashbuilder
spec:
  environment: rhpam-standalone-dashbuilder
  objects:
    dashbuilder:
      env:
        - name: DASHBUILDER_UPLOAD_SIZE
          value: '1000'

Chapter 4. Deploying Dashbuilder Standalone on Red Hat OpenShift Container Platform

4.1. Dashbuilder Standalone environment variables

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links