Docker Deployment

In this section:

This section provides prerequisites and describes how to deploy ibi Data Quality using Docker Compose.

Prerequisites

Before continuing, ensure your system has the following prerequisites:

Installing Docker Desktop or Docker Engine with Compose

Install Docker as documented for your environment. To install Docker Desktop, follow the instructions found on the following website:

https://docs.docker.com/get-docker/

Installing Loqate With Data Packs

Install and configure Loqate as documented in the Omni-Gen® Address Cleansing (Loqate®) Installation and Configuration Guide:

https://docs.tibco.com/pub/og/3.16.0/doc/pdf/TIB_og_3.16.0_address_cleansing_install.pdf

Installing WebFOCUS DSML Services Container Edition

To install WebFOCUS DSML Services Container Edition:

Download and Configure

  1. Go to TIBCO eDelivery and download the TIB_dsmlce_1.0.0_linux_x86_64.tar file.
  2. Untar the file to a local directory.
  3. Go to the TIB_dsmlce_1.0.2_linux_x86_64/dsml-build-context/metadata directory and edit Dockerfile.
  4. Locate the following COPY command section in the file:
    ENV DSML_USER=dsml
    RUN adduser --disabled-password --gecos '' $DSML_USER
    WORKDIR /metadata
    COPY --chown=$DSML_USER:$DSML_USER metadata /metadata/run_service
  5. Add the following line above the COPY command:
    RUN chown -R $DSML_USER:$DSML_USER /metadata

    The resulting file should look like the following:

    #Create User
    ENV DSML_USER=dsml
    RUN adduser --disabled-password --gecos '' $DSML_USER
    
    WORKDIR /metadata
    RUN chown -R $DSML_USER:$DSML_USER /metadata
    COPY --chown=$DSML_USER:$DSML_USER metadata /metadata/run_service
  6. Do not change anything else in the file and save your changes.

Build Metadata Service Image

  1. Using the command line, change directory to the TIB_dsmlce_1.0.2_linux_x86_64/dsml-build-context/metadata directory.
  2. Run the following command:
    docker build --no-cache -t ibi2020/webfocus:metadata-9.0-1.0.0 .

    Note: The dot (.) at the end is part of the command and must be included.

  3. To verify that the image has been built, execute the following command:
    $ docker image ls ibi2020/webfocus
    REPOSITORY         TAG                  IMAGE ID       CREATED       SIZE
    ibi2020/webfocus   metadata-9.0-1.0.0   fd19b79b06d8   3 weeks ago   295MB

Installing ibi Data Quality

To install ibi Data Quality:

  1. Download and unzip the ibi_tdq_5.2.0_container.zip file.
  2. Edit the install/.env file.
    1. Change the HOSTDOMAIN. This is required if you intend to access ibi Data Quality from a machine other than the one where it is installed.
    2. Change the location of your Loqate Linux installation. This is required if you intend to use the Loqate address cleansing services.

      For example, if you extracted a Linux installation of Loqate in the C:\Loqate_Linux folder, then change the value of LOQATE_HOME in the .env file to:

      LOQATE_HOME=C:/loqate_linux
    3. By default, ibi Data Quality starts three replicas of the dq-profiler container. This improves performance and scalability when profiling large data sets, at the cost of increased resource use. If you do not expect to profile large data sets, then you can limit resource consumption by setting PROFILER_SCALE to 1 or 2.

      Note: If you are using Docker Compose version 2.x and require profiler scaling, then you must edit the docker-compose.yaml file.

      By default, the docker-compose.yaml file sets the scaling properties used by Docker Compose version 1.x:

      dq-profiler:
          build:
      	...
          scale: ${PROFILER_SCALE}
      #   comment scale and use deploy section instead for compose 
      #   version 2.x
      #    deploy:
      #      mode: replicated
      #      replicas: ${PROFILER_SCALE}

      For Docker Compose version 2.x, edit this section in the docker-compose.yaml file as follows:

      dq-profiler:
          build:
      	...
      #    scale: ${PROFILER_SCALE}
      #   comment scale and use deploy section instead for compose 
      #   version 2.x
           deploy:
             mode: replicated
             replicas: ${PROFILER_SCALE}
    4. Other settings in the .env file should not be changed.
  3. Open Windows PowerShell or any Linux shell.
  4. Change your directory to the folder where you extracted the ibi_tdq_5.2.0_container.zip file.
  5. Change your directory to the /install folder.
  6. Run the following command:
    docker-compose up --build
  7. Wait to confirm that WSO2 Identity Server is started and running.
  8. Open the WSO2 console at https://localhost:9801 and accept the self-signed certificate.

    Note: ibi Data Quality is packaged with a self-signed certificate for HTTPS. It is recommended that you replace this with your own certificate. If you have a signed certificate and key, replace tdq-cert.crt and tdq-cert.key in the install/dq-nginx/dockerRoot folder with your own files, using those file names. If OpenSSL is available, then you can generate your own self-signed certificate by editing tdq-nginx-cert.conf and executing the command found in the gen-cert-script.txt file.

  9. Enter the following URL in your browser to access the ibi Data Quality valet console:
    https://localhost:9800/

    The default login credentials (user ID and password) are:

    • User ID: dqadmin
    • Password: dqadmin

    Note: It is recommended that you change the default login credentials in the User Management Console. For more information, see Managing Existing Users.

  10. To restart ibi Data Quality after the first time, remove the –build switch from the command line. Simply run:
    docker-compose up