Installing Data Catalog

Get started with Pentaho Data Catalog

Part Number
Important: It is a best practice before installing Data Catalog to save a copy of your conf/.env file to save any environment customizations you have made in case the file is overwritten during the installation process. During installation, Data Catalog checks for a PDC_DATA_ENCRYPTION_KEY environment variable in the conf/.env file. If the variable exists, the conf/.env file is retained. However, if the variable does not exist, Data Catalog generates a new .env file containing a PDC_DATA_ENCRYPTION_KEY environment variable. If needed, you can add any custom environment variable settings back in to the new .env file from your saved file.

Perform the following steps to install Data Catalog:

  1. Verify that you have root privileges or have the necessary permissions to run Docker.
  2. Open a terminal window on your dedicated Data Catalog deployment server.
  3. Save the Data Catalog release package in the Data Catalog server.
  4. Open a terminal window on your dedicated Data Catalog deployment server and extract the files from the release package to the /opt directory using the following command:

    tar -xvf [name of release package].tar.gz -C /opt

    The command creates a pentaho directory and extracts the contents of the deployment into a pdc-docker-deployment subdirectory.
  5. Load the required installation images that are packaged in the vendor directory into Docker using the following command:
    cd /opt/pentaho/pdc-docker-deployment
    ./ load-images
    You may get a message to set the GLOBAL_SERVER_HOST_NAME variable:
    GLOBAL_SERVER_HOST_NAME env is not set, please select an environment variable value from the list or type your own:
    1.	IP address
    2.	Hostname
    3.	Hostname.localhost.localdomain
    4.	Other 
    #?    1
  6. (Optional) If you get the GLOBAL_SERVER_HOST_NAME env is not set message, enter the number for the option that you want to set as the variable and press Enter.
    If you select 1, the script sets the GLOBAL_SERVER_HOST_NAME variable to the IP address in the conf/.env file.
  7. Edit the conf/.env file to add email domains and keycloak SMTP configuration:
    sudo vi conf/.env
    1. Add new email allowed domains into the .env file. By default, Data Catalog includes users that use emails. You can add your own domain to this list:
      EMAIL_DOMAINS='["", "", "", "", ""]'
    2. Add configuration for Keycloak SMTP. In the example value below, SMTP configuration is set to use emails, but you can change these to point to your company’s SMTP server configuration:
      KEYCLOAK_SMTP='{"replyToDisplayName" : "","starttls" : "true","auth" : "true","envelopeFrom" : "", "ssl" : "true","password" : "fwjx mpvb hcdb yofp","port" : "465","host" : "","replyTo" : "","from" : "","fromDisplayName" : "","user" : ""}'
    3. Save the file.
    The email and SMTP settings are complete.
    Note: If you want to update email or SMTP settings after installation, this will need to be done using IAM APIs.
  8. Start all the Docker containers using the following command:
    sh up
    The installation script uses the packaged Docker images for the Data Catalog release and the Data Storage Optimizer release, if installed, to create and run Docker containers on your dedicated server.
The installation is ready for use after all the Docker containers have successfully started.

Access Data Catalog through your browser (the Chrome browser is recommended) using the hostname name or IP address and confirm that the application is successfully installed and running.

Access Data Storage Optimizer, if installed, through your browser using the hostname or IP address: [hostname or IP]/pdso and confirm that the applications are successfully installed and running.

Note: For new installations, you are redirected to the PDC login page.
Data Catalog provides a set of default users for demonstrating and testing. These default users have the following specific roles assigned:
Role Actions
Admin A user who can configure the product
Data User A user who is interested in leveraging Data Catalog to find data for use for a business operation
Data Steward A user who will update and process data in Data Catalog for use for a business operation, including migrating data for Pentaho Data Storage Optimizer
Business User A user who needs to view business-specific glossaries and dictionaries
Business Steward A user who will maintain business-specific glossaries and dictionaries
Data Developer A user who will create and update business rules in Data Catalog or metadata rules in Data Storage Optimizer
For more information, see Manage users and permissions in the Administer Pentaho Data Catalog document.
Refer to the installation package for credential details for the default users. This information is found in an encrypted file.
Important: For Development and Production environments, it is a best practice to create users upon installation and deprecate these default users.
After installing Data Catalog, there may be other components you need to set up, depending on your environment. For more information, see the Administer Pentaho Data Catalog document.