After installing or upgrading Watson™ Knowledge
Catalog, you can enable any of the optional
features available with Watson Knowledge
Catalog.
During the initial install or during the upgrade of Watson Knowledge
Catalog, you have the option of enabling 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.
Follow the instructions based on which release of IBM® Cloud Pak for Data you are on.
For users on IBM Cloud Pak for Data
4.5.0
- Knowledge graph
- Enable knowledge graph to gain access to the lineage and semantic search features.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableKnowledgeGraph\":True,\"fdboperator_full_backupdeployment_image\":{\"name\":\"fdb-ibm-backup-agent@sha256\",\"tag\":\"da6ed54e4c184152a4b82edf70d90df49c29b79f10151f35d9bc59c9fcfe5ab6\",\"tag_metadata\":\"da6ed54e4c184152a4b82edf70d90df49c29b79f10151f35d9bc59c9fcfe5ab6\"},\"fdboperator_full_restorejob_image\":{\"name\":\"fdb-ibm-restore-agent@sha256\",\"tag\":\"85702342f423ab0d0afa78e9b102f4507238efca00e58101052a2e1ec97729fe\",\"tag_metadata\":\"85702342f423ab0d0afa78e9b102f4507238efca00e58101052a2e1ec97729fe\"},\"foundationdb_full_cluster_image\":{\"name\":\"fdb-apple-foundationdb@sha256\",\"tag\":\"78a692b1c9181dd4ee86c42380d0a3632c195668c3ab6b777bfbc0690f49fbd1\",\"tag_metadata\":\"78a692b1c9181dd4ee86c42380d0a3632c195668c3ab6b777bfbc0690f49fbd1\"},\"foundationdb_full_cluster_sidecar_image\":{\"name\":\"fdb-apple-foundationdb-sidecar@sha256\",\"tag\":\"9a724f9ce0e4a434fcac8a8b1f8cfa90f84bfc4bfe1b1aacb7c98dab044acc84\",\"tag_metadata\":\"9a724f9ce0e4a434fcac8a8b1f8cfa90f84bfc4bfe1b1aacb7c98dab044acc84\"}}"
- Data quality
- Enable data quality features in analytics projects.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableDataQuality\":True}"
- Factsheets
- Use a model inventory to track the lifecycles of machine learning models from training to
production. View AI factsheets that track lineage events for assets and facilitate efficient
ModelOps governance.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True}"
- Advanced metadata import
- Enable advanced metadata import provided through MANTA Automated Data
Lineage.
- Before enabling advanced metadata import, you will need to run the
following:
cat <<EOF | oc apply -f -
apiVersion: operator.openshift.io/v1alpha1
kind: ImageContentSourcePolicy
metadata:
name: manta-mirror-config
spec:
repositoryDigestMirrors:
- mirrors:
- ${PRIVATE_REGISTRY_LOCATION}/cpopen
source: repo.getmanta.com/manta-ubi8-ibm
EOF
This sets an additional image content security policy (ICSP). This command will
create a new mirror configuration for repo.getmanta.com/manta-ubi8-ibm so that the
images can be pulled from an IBM entitled registry: icr.io/cpopen. No images will
be pulled from repo.getmanta.com/manta-ubi8-ibm, and there is no need to whitelist
any other registry than the IBM entitled registry.Important: In addition, ensure that
the valid CA (certificate authority) signed certificate has the parameter Subject
Alternative Name, and that it matches the route name used to access Watson Knowledge
Catalog.
Note: For OpenShift® 4.6 or older
versions, you will need to wait until the image content security policy is propagated to all the
nodes in the cluster and the nodes are restarted.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableMANTA\":True,\"cpd_host_url\":\"${CPD_HOST_URL}\",\"cp_console_url\":\"${CP_CONSOLE_URL}\"}"
- After enabling MANTA Automated Data
Lineage, check to see
if the
manta-dataflow and manta-keycloak pods are up and
running.
- If they are, you can scale up or scale down the
metadata-discovery and
wkc-metadata-imports-ui pods to suit your needs.
For users on IBM Cloud Pak for Data
4.5.1
- Knowledge graph
- Enable knowledge graph to gain access to the lineage and semantic search features.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableKnowledgeGraph\":True}"
- 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.
- Get bearer token as described in https://cloud.ibm.com/apidocs/cloud-pak-data/cloud-pak-data-4.5.0#getauthorizationtoken.
curl -k -X POST \
https://$HOST/icp4d-api/v1/authorize \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '{"username":"admin","password":"<password>"}'
- 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: Bearer ${TOKEN}" -d \
'{"category_ids": ["<category_artifact_id1>, <category_artifact_id12>..."]}'
- The allowed values for
artifact_type parameter are category,
glossary_term, classification, data_class, reference_data, policy, rule.
- Start with
category, then continue with glossary_term,
classification, data_class, reference_data,
policy, and rule.
- Data quality
- Enable data quality features in analytics projects.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableDataQuality\":True}"
- Factsheets
- Use a model inventory to track the lifecycles of machine learning models from training to
production. View AI factsheets that track lineage events for assets and facilitate efficient
ModelOps governance.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True}"
- Advanced metadata import
- Enable advanced metadata import provided through MANTA Automated Data
Lineage.
- Before enabling advanced
metadata import, you will need to run the following:
cat <<EOF | oc apply -f -
apiVersion: operator.openshift.io/v1alpha1
kind: ImageContentSourcePolicy
metadata:
name: manta-mirror-config
spec:
repositoryDigestMirrors:
- mirrors:
- ${PRIVATE_REGISTRY_LOCATION}/cpopen
source: repo.getmanta.com/manta-ubi8-ibm
EOF
This sets an additional image content security policy (ICSP). This command will
create a new mirror configuration for repo.getmanta.com/manta-ubi8-ibm so that the
images can be pulled from an IBM entitled registry: icr.io/cpopen. No images will
be pulled from repo.getmanta.com/manta-ubi8-ibm, and there is no need to whitelist
any other registry than the IBM entitled registry.Important: In addition, ensure that
the valid CA (certificate authority) signed certificate has the parameter Subject
Alternative Name, and that it matches the route name used to access Watson Knowledge
Catalog.
Note: For OpenShift 4.6 or older
versions, you will need to wait until the image content security policy is propagated to all the
nodes in the cluster and the nodes are restarted.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableMANTA\":True}"
- After enabling MANTA Automated Data
Lineage, check to see
if the
manta-dataflow and manta-keycloak pods are up and
running.
- If they are, you can scale up or scale down the
metadata-discovery and
wkc-metadata-imports-ui pods to suit your needs.
- Enable all optional features
- If you want to enable all the optional features at the same time, you can run the following
commands.
- All of these options can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True,\"enableKnowledgeGraph\":True,\"enableDataQuality\":True,\"enableMANTA\":True}"
For users on IBM Cloud Pak for Data
4.5.2
- Knowledge graph
- Enable knowledge graph to gain access to the lineage and semantic search features.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableKnowledgeGraph\":True}"
- 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.
- Get bearer token as described in https://cloud.ibm.com/apidocs/cloud-pak-data/cloud-pak-data-4.5.0#getauthorizationtoken.
curl -k -X POST \
https://$HOST/icp4d-api/v1/authorize \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '{"username":"admin","password":"<password>"}'
- 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: Bearer ${TOKEN}" -d \
'{"category_ids": ["<category_artifact_id1>, <category_artifact_id12>..."]}'
- The allowed values for
artifact_type parameter are category,
glossary_term, classification, data_class, reference_data, policy, rule.
- Start with
category, then continue with glossary_term,
classification, data_class, reference_data,
policy, and rule.
- Data quality
- Enable data quality features in analytics projects.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableDataQuality\":True}"
- Factsheets
- Use a model inventory to track the lifecycles of machine learning models from training to
production. View AI factsheets that track lineage events for assets and facilitate efficient
ModelOps governance.
- This option can be enabled after the initial installation by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True}"
- Advanced metadata import
- Enable advanced metadata import provided through MANTA Automated Data
Lineage.
Important: Before enabling MANTA Automated Data
Lineage, ensure that the valid CA (certificate
authority) signed certificate has the parameter Subject Alternative Name, and
that it matches the route name used to access Watson Knowledge
Catalog.
This option can be enabled
by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableMANTA\":True}"
- After enabling MANTA Automated Data
Lineage, check to see
if the
manta-dataflow and manta-keycloak pods are up and
running.
- If they are, you can scale up or scale down the
metadata-discovery and
wkc-metadata-imports-ui pods to suit your needs.
- Enabling MANTA Automated Data
Lineage may fail on
production environments as the MANTA image location is currently referring to a staging registry.
The following steps will fix that so it points to a production registry.
- Run the command to choose the required
project:
oc project ibm-common-services
- Run the command to scale down the manta-adl-operator-controller-manager pod
down to
zero:
oc scale deploy manta-adl-operator-controller-manager --replicas=0
- Run the command to path the registry location so it points to a production
registry:
oc patch deploy manta-adl-operator-controller-manager --type=merge --patch='{"spec": {"template": { "spec": {"containers": [{ "name":"manager","image": "icr.io/cpopen/manta-adl-operator@sha256:c1bad56e10aded544cfbc7416870c69473ea6d060d0f00e531e462903fca6c67"}] } } } }'
- Run the command to scale up the
pod:
oc scale deploy manta-adl-operator-controller-manager --replicas=1
- Enable all optional features
- If you want to enable all the optional features at the same time, you can run the following
commands.
- All of these options can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True,\"enableKnowledgeGraph\":True,\"enableDataQuality\":True,\"enableMANTA\":True}"
For users on IBM Cloud Pak for Data
4.5.3
- Knowledge graph
- Enable knowledge graph to gain access to the lineage and semantic search features.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableKnowledgeGraph\":True}"
- 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.
- Get bearer token as described in https://cloud.ibm.com/apidocs/cloud-pak-data/cloud-pak-data-4.5.0#getauthorizationtoken.
curl -k -X POST \
https://$HOST/icp4d-api/v1/authorize \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '{"username":"admin","password":"<password>"}'
- 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: Bearer ${TOKEN}" -d \
'{"category_ids": ["<category_artifact_id1>, <category_artifact_id12>..."]}'
- The allowed values for
artifact_type parameter are category,
glossary_term, classification, data_class, reference_data, policy, rule.
- Start with
category, then continue with glossary_term,
classification, data_class, reference_data,
policy, and rule.
- Data quality
- Enable data quality features in analytics projects.
- This option can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableDataQuality\":True}"
- Factsheets
- Use a model inventory to track the lifecycles of machine learning models from training to
production. View AI factsheets that track lineage events for assets and facilitate efficient
ModelOps governance.
- This option can be enabled after the initial installation by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True}"
- Advanced metadata import
- Enable advanced metadata import provided through MANTA Automated Data
Lineage.
Important: Before enabling MANTA Automated Data
Lineage, ensure that the valid CA (certificate
authority) signed certificate has the parameter Subject Alternative Name, and
that it matches the route name used to access Watson Knowledge
Catalog.
This option can be enabled
by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableMANTA\":True}"
- After enabling MANTA Automated Data
Lineage, check to see
if the
manta-dataflow and manta-keycloak pods are up and
running.
- If they are, you can scale up or scale down the
metadata-discovery and
wkc-metadata-imports-ui pods to suit your needs.
- Enabling MANTA Automated Data
Lineage may fail on
production environments as the MANTA image location is currently referring to a staging registry.
The following steps will fix that so it points to a production registry.
- Run the command to choose the required
project:
oc project ibm-common-services
- Run the command to scale down the manta-adl-operator-controller-manager pod
down to
zero:
oc scale deploy manta-adl-operator-controller-manager --replicas=0
- Run the command to path the registry location so it points to a production
registry:
oc patch deploy manta-adl-operator-controller-manager --type=merge --patch='{"spec": {"template": { "spec": {"containers": [{ "name":"manager","image": "icr.io/cpopen/manta-adl-operator@sha256:c1bad56e10aded544cfbc7416870c69473ea6d060d0f00e531e462903fca6c67"}] } } } }'
- Run the command to scale up the
pod:
oc scale deploy manta-adl-operator-controller-manager --replicas=1
- Enable all optional features
- If you want to enable all the optional features at the same time, you can run the following
commands.
- All of these options can be enabled by running this patch command in the
wkc-cr:cpd-cli manage update-cr \
--component=wkc \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--patch="{\"enableFactSheet\":True,\"enableKnowledgeGraph\":True,\"enableDataQuality\":True,\"enableMANTA\":True}"