After installing or upgrading IBM Knowledge
Catalog, you can enable any of the optional
features available with IBM Knowledge
Catalog, IBM Knowledge Catalog Standard, and IBM Knowledge Catalog Premium.
During the initial install or during the upgrade of any of the IBM Knowledge
Catalog editions, you
can enable a number of optional features. However, if you decide not to enable these optional
features at that time, you can still do so after the initial install or after the upgrade.
For more information about each of these optional features, see
Preparing to install IBM Knowledge Catalog.
Important: Enabling any of these options will require
additional hardware. For more information, see
Hardware requirements.
- Who needs to complete this task?
- Instance administrator To enable optional features
for IBM Knowledge
Catalog, you must be an instance administrator.
To enable additional features, follow these instructions.
- Specify your IBM Knowledge
Catalog edition.
Set the
IKC_TYPE
environment
variable to the edition of
IBM Knowledge
Catalog for which you want to enable the features:
- IBM® Knowledge Catalog
-
export IKC_TYPE=wkc
- IBM Knowledge Catalog Premium
-
export IKC_TYPE=ikc_premium
- IBM Knowledge Catalog Standard
-
export IKC_TYPE=ikc_standard
- Enable optional features:
- Knowledge graph
- Enable knowledge graph to gain access to the lineage feature, business-term relationship search,
and the relationship explorer.
- 5.1.0
IBM Cloud Pak® for Data
5.1.0
- For access to lineage feature with IBM Manta Data
Lineage and business-term relationship search, run this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableKnowledgeGraph\":True}"
- For access to the lineage feature with MANTA Automated Data Lineage, business-term relationship search, or to
the relationship explorer, run this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableKnowledgeGraph\":True,\"useFDB\":True}"
Important: This
command enables the use of FoundationDB as the graph
database, which does not support IBM Manta Data
Lineage.
- 5.1.1 and later
IBM Cloud Pak for Data
5.1.1 and later
- For access to lineage feature with IBM Manta Data
Lineage, business-term relationship search, and the relationship explorer in deployments with the Neo4j
graph database, run this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableKnowledgeGraph\":True}"
- For access to the lineage feature with MANTA Automated Data Lineage or to the relationship explorer in
deployments where MANTA Automated Data Lineage is installed,
run this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableKnowledgeGraph\":True,\"useFDB\":True}"
Important: This
command enables the use of FoundationDB as the graph
database, which does not support IBM Manta Data
Lineage.
- After you enable the knowledge graph, you must synchronize governance artifacts. Use the
following API for updating the categories, business terms, data classes, reference data sets, etc.
in the knowledge graph. Replace
$HOST
by the host name and port number used in the
IBM Cloud Pak for Data UI. You must have the
manage_glossary
permission to complete this task. This permission is available in
Administrator
platform role.
- Follow the steps in Generating an
API authorization token to generate an API key.
- Start the synchronization:
curl -k -X POST "https://$HOST/v3/glossary_terms/admin/resync?artifact_type=<artifact_type>&sync_destinations=KNOWLEDGE_GRAPH" --header "Content-Type: application/json" --header "Accept: application/json" --header "Authorization: ZenApiKey ${TOKEN}" -d '{}'
- Data quality
- Enable data quality features for working with data quality definitions and data quality rules in
projects. For information about data quality definitions and rules, see Managing data quality.
Important: Enabling this option will install
DataStage with
IBM Knowledge
Catalog. To
ensure a smooth installation of this feature, see
Installing DataStage.
If you did not purchase a DataStage license, use of the DataStage Enterprise service installed with IBM Knowledge
Catalog is limited to creating, managing, and running data quality rules.
Examples
of accepted usage:
- Preprocessing of data to enable running data quality rules
- Transformation of data to remediate data quality issues
- This option can be enabled for IBM Knowledge Catalog and
IBM Knowledge Catalog Premium by running this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableDataQuality\":True}"
- Gen AI based enrichment capabilities
- Enable all gen AI based capabilities in metadata enrichment for expanding asset and column
names, generating asset and column descriptions, and term assignment.
Important: These
capabilities require one GPU, and the NVIDIA GPU Operator and the Red Hat®
OpenShift® AI Operator must be installed. Enabling this option will
install inference foundation models (watsonx_ai_ifm
).
- This option can be enabled for IBM Knowledge Catalog Premium and IBM Knowledge Catalog Standard by running this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableSemanticAutomation\":True}"
- 5.1.0
IBM Cloud Pak for Data
5.1.0 only: After enabling the gen AI based capabilities for your
edition of IBM Knowledge Catalog, you must set the
batch sizes for processing large
tables:
cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"wkc_term_assignment_name_expansion_columns_page_size\":50,\"wkc_term_assignment_description_generation_columns_page_size\":50}"
The
command sets the batch six for processing large tables to 50
.Important: The command to set the batch size must be run in the wkc-cr
.
- 5.1.3 and later
IBM Cloud Pak for Data
5.1.3 and later: Enable only gen AI capabilities in metadata
enrichment that do not require GPU: expansion of asset and column names, and gen AI based term
assignment.
Important: These capabilities do not require GPU, but the Red Hat
OpenShift AI Operator must be installed. Enabling this option will
install inference foundation models (watsonx_ai_ifm
).
This option can be
enabled for
IBM Knowledge Catalog Premium and
IBM Knowledge Catalog Standard by running this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch="{\"enableSemanticAutomation\":True,\"disable_models\":True}"
- Enable all optional features for an IBM Knowledge
Catalog edition
- You can enable all optional features for an IBM Knowledge
Catalog edition.
- Set the
INSTALL_OPTIONS
environment variable to the available options for your
IBM Knowledge
Catalog edition:
- IBM Knowledge Catalog
-
export INSTALL_OPTIONS="{\"enableKnowledgeGraph\":True,\"enableDataQuality\":True}"
- IBM Knowledge Catalog Premium
-
export INSTALL_OPTIONS="{\"enableKnowledgeGraph\":True,\"enableDataQuality\":True},\"enableSemanticAutomation\":True}"
- IBM Knowledge Catalog Standard
-
export INSTALL_OPTIONS="{\"enableKnowledgeGraph\":True,\"enableSemanticAutomation\":True}"
- To enable all available options at the same time, run this patch
command:
cpd-cli manage update-cr \
--component=${IKC_TYPE} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--patch=${INSTALL_OPTIONS}