At any time after deployment, you can set up or change the application stack's configuration for making data from IBM®
StoredIQ® data sources discoverable in IBM Information Server or IBM Cloud Private for Data, to make governance catalog data classes available for use in IBM
StoredIQ, and to keep the information in sync.
Before you begin
Before you can configure and use the synchronization feature, a working deployment of one of these products must be available:
- IBM Information Server. The minimum required version is Version 11.7.0.
- IBM Cloud Private for Data. The minimum required version for full support is Version 1.2.
About this task
If the synchronization was not enabled during deployment or if you want to change any settings later, complete these steps to configure the application stack accordingly. Important: Synchronization requires HTTPS to be enabled on the AppStack. Therefore, it is mandatory that at least a self-signed certificate is installed.
Procedure
To enable the synchronization with Information Governance Catalog or the IBM Cloud Private for Data catalog at any time after deployment of the AppStack:
- Using an SSH tool, log in to the application stack as siqadmin.
- Launch the Appstack Configuration utility by using this command: appstackcfg
-
Check the value in the Domain name field.
The information that you provide here is used to build the base URLs for REST access to the application stack and for links to IBM
StoredIQ artifacts that make these artifacts accessible from the governance catalog. Therefore, you should provide the fully qualified domain name or the IP address of the application stack.
-
If you want your data experts to receive email notifications for any changes to the synchronized governance catalog objects, ensure that the application stack configuration includes the appropriate SMTP settings.
-
Select Enable synchronization with the governance catalog and provide the following settings.
If the data catalog to which you want to publish the IBM
StoredIQ object resides in an IBM Cloud Private for Data environment, select the Server runs in IBM Cloud Private for Data checkbox.
Provide or accept the values for these fields:
Parameter |
Value |
Host |
The host name or IP address of the Information Server or IBM Cloud Private for Data installation. The specified host is part of the base URLs for REST access to the Information Governance Catalog or IBM Cloud Private for Data instance and for links to catalog artifacts that make these artifacts accessible from IBM
StoredIQ. Therefore, you should provide the fully qualified domain name of the Information Server or IBM Cloud Private for Data host. If you specify a server port, this port also becomes part of such base URLs.
In addition, the host name is also used to address the Information Server Apache Kafka server, which provides all Information Server events as Kafka messages. Specific Kafka messages are consumed by IBM
StoredIQ and trigger the synchronization of objects from the governance catalog to IBM
StoredIQ.
|
Port |
The port of the governance catalog server. This setting is optional. For connections to an Information Server 11.7 environment: To ensure proper communication, you should set the port to the HTTPS port that is defined in Information Server. The default port is 9443.
For connections to an Information Server 11.7 FP1 (or later) environment without Information Server Enterprise Search installed: To ensure proper communication, you should set the port to the HTTPS port that is defined in Information Server. The default port is 9446..
For connections to an Information Server 11.7 FP1 (or later) environment with Information Server Enterprise Search installed: Do not specify a port.
For connections to IBM Cloud Private for Data, you can specify the IBM Cloud Private for Data port.
|
Kafka port |
The port of the Information Server Kafka server. The port setting can be overridden. For connections to an Information Server 11.7 environment: the Kafka port defined in Information Server. The default port is 59092.
For connections to an Information Server 11.7 FP1 (or later) environment without Information Server Enterprise Search installed: the Kafka port defined in Information Server. The default port is 59092.
For connections to an Information Server 11.7 FP1 (or later) environment with Information Server Enterprise Search installed: the Kafka port defined in Information Server. The default port is 9092.
For connections to IBM Cloud Private for Data: the Kafka port defined in IBM Cloud Private for Data. For more information, see the topic Enabling synchronization with IBM
StoredIQ in the IBM Cloud Private for Data product documentation.
|
Username |
The user name for authenticating to Information Server or IBM Cloud Private for Data when publishing IBM
StoredIQ objects to the governance catalog.This user must be defined in Information Server with the following security roles:
- Suite User
- Common Metadata Administrator
- Information Governance Catalog Information Asset Administrator
In IBM Cloud Private for Data, this user must be defined with the Data Stewart role.
|
Password |
The password of the user set with Username. |
Sync frequency (minutes) |
Data is periodically propagated to the governance catalog at the specified interval. The value must be a positive number of minutes. The default value is 15 minutes. |
StoredIQ instance name |
The name identifying the IBM
StoredIQ instance for which data is synchronized. This name can be freely chosen, but must be unique within the governance catalog instance. |
- Select Restart appstack services.
Restarting the services is required for any configuration changes to take effect. Selecting this option is an alternative to restarting the application-stack services uwsgi
and tomcat
from the command line.
-
Select Save and exit and wait for all IBM
StoredIQ services to restart.
On the first synchronization run, the governance catalog is initially populated with the IBM
StoredIQ artifacts that you selected for publishing to the catalog.