Configuring and validating the Open Data for Industries environment
After you install the Open Data for Industries service, you need to configure and validate your environment through build verification test (BVT).
Before you begin
Ensure that the software utilities are installed. For more information, see Installing software utilities.
Make sure that you have a Docker or Podman container runtime setup. For more information, see
Installing software
utilities.
Prerequisites
-
If the Utility Installer Container is not running, you need to pull and run the installer image. Use the following command with Podman runtime.
podman run -it --rm icr.io/odi-utility-tool/odi-ansible-installer:stable302 - Validate that the values of the
odi-vars.ymlmatch the values that you use during the software utilities install process. The file is located in theplaybooks/varsfolder of the running container.Note: In case of verified certificate, setstorage_classtoibmc-block-goldanduse_default_catofalse. For not-verified or self-signed certificate, setstorage_classtoocs-storagecluster-ceph-rbdanduse_default_catotrue.Variable Type Required Default value Description project_nameString Yes Osdu-tenantThe Red Hat® OpenShift® project where the utilities are provisioned. storage_classString Yes ibmc-block-goldClass of storage that abstracts underlying storage provider. For more information, see Storage requirements. block_storage_classString Yes ibmc-block-bronzeThe block storage class. For more information, see Storage requirements. file_storage_classString Yes ibmc-file-goldThe file storage class. For more information, see Storage requirements. use_default_caBoolean string Yes falseIf set to "true" indicates that the Open Data for Industries endpoints use an internal CA.
Configuration procedure
- Log in to the target Red Hat OpenShift cluster.
Use the command line of the running container and run the oc
command.
oc login --token={user_token_Openshift_Webconsole} --server=https://{server_API_url} - Use the command line of the running container to run the Ansible® playbook that configures the
IBM Open Data for Industries utilities. Make sure that the
command line is at path
/playbooksin the running container.ansible-playbook odi-install/post-install.yml --extra-vars="@vars/odi-vars.yaml" - Check whether the default Open Data for Industries schemas are ingested.
- Get CouchDB credentials.
- Get the URL to log in to CouchDB web console.Note: Replace the
project_namewith the project where the Open Data for Industries is installed.oc get routes -n {{project_name}} | egrep -ai couch | awk '{print $2}' - To get to the CouchDB database console:
- Add
https://at the beginning of the URL that you obtained. - Add
_utilsto the end of the URL.
- Add
- Locate the
oc-cpd-dataecosystem-opendes-schema2database. It contains the Open Data for Industries schema documents.
- Validate that the Apache Airflow utility is installed and configured.
- Get the Airflow
URL.
oc get routes -n {{project_name}} | egrep -ai airflow-web | awk '{print $2}' - Get the Apache Airflow console URL by adding
https://to the path you already obtained. - Get the configured default credentials (username and password) for Apache
airflow.
oc get secrets props-secret -n {{project_name}} -o jsonpath="{.data.ibm\.username4airflow}"|base64 -doc get secrets props-secret -n {{project_name}} -o jsonpath="{.data.ibm\.password4airflow}"|base64 -d - Log in to the Apache Airflow console by using the credentials and validate that the Apache Airflow variables are all set.
- Get the Airflow
URL.
- To check the rest of the available utility services URLs, use the following commands:
- Red Hat AMQ Broker
-
oc get routes -n {{project_name}} | egrep -ai amq | awk '{print $2}'
- Keycloak
-
oc get routes -n {{project_name}} | egrep -ai keycloak | awk '{print $2}'
- MinIO
-
oc get routes -n {{project_name}} | egrep -ai minio | awk '{print $2}'
- Elasticsearch
-
oc get routes -n {{project_name}} | egrep -ai elastic | awk '{print $2}'
- Cloud Pak for Data control plane
-
oc get routes -n {{project_name}} | egrep -ai cpd | awk '{print $2}'
Validation procedure
To validate the successful installation and configuration of the Open Data for Industries core services, you can run:
- Preliminary regression testing
- Use it to quickly check the minimum configurations that are required by the core services.
- Preliminary functional smoke test
- Use this API test suite to validate the interaction between the Open Data for Industries core services and the utilities.