/g2configtool

Distributed with Senzing API package

Primary LanguagePythonApache License 2.0Apache-2.0

g2configtool

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Overview

This Dockerfile is a wrapper over Senzing's G2ConfigTool.py.

Contents

  1. Expectations
  2. Demonstrate using Docker
    1. Configuration
    2. Volumes
    3. Database support
    4. Run docker container
  3. References

Legend

  1. 🤔 - A "thinker" icon means that a little extra thinking may be required. Perhaps you'll need to make some choices. Perhaps it's an optional step.
  2. ✏️ - A "pencil" icon means that the instructions may need modification before performing.
  3. ⚠️ - A "warning" icon means that something tricky is happening, so pay attention.

Expectations

  • Space: This repository and demonstration require 1 GB free disk space.
  • Time: Budget 40 minutes to get the demonstration up-and-running, depending on CPU and network speeds.
  • Background knowledge: This repository assumes a working knowledge of:

Demonstrate using Docker

Configuration

Configuration values specified by environment variable or command line parameter.

Volumes

  1. ✏️ Specify the directory containing the Senzing installation. Example:

    export SENZING_VOLUME=/opt/my-senzing
    1. ⚠️ macOS - File sharing must be enabled for SENZING_VOLUME.
    2. ⚠️ Windows - File sharing must be enabled for SENZING_VOLUME.

  2. Identify the data_version, etc, g2, and var directories. Example:

    export SENZING_ETC_DIR=${SENZING_VOLUME}/etc

Database support

🤔 Optional: Some database need additional support. For other databases, these steps may be skipped.

  1. Db2: See Support Db2 instructions to set SENZING_OPT_IBM_DIR_PARAMETER.
  2. MS SQL: See Support MS SQL instructions to set SENZING_OPT_MICROSOFT_DIR_PARAMETER.

Run docker container

  1. Run docker container. Example:

    sudo docker run \
  --interactive \
  --rm \
  --tty \
  --volume ${SENZING_ETC_DIR}:/etc/opt/senzing \
  ${SENZING_OPT_IBM_DIR_PARAMETER} \
  ${SENZING_OPT_MICROSOFT_DIR_PARAMETER} \
  senzing/g2configtool \
    --iniFile /etc/opt/senzing/G2Project.ini \
    --g2ConfigFile /etc/opt/senzing/g2config.json \
    --g2VariantFile /etc/opt/senzing/cfgVariant.json

References