docker-compose-demo

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!

Synopsis

Using Docker compose, bring up a Docker compose formation for demonstrating Senzing.

Overview

1. TL;DR - A Simple example

   1. Prerequisites:

      1. Docker compose

   2. Download docker-compose file:

      curl -O https://raw.githubusercontent.com/senzing-garage/docker-compose-demo/refs/heads/main/docker-compose/senzing-docker-compose-postgresql.yaml

      Alternatively, use a web browser to download senzing-docker-compose-postgresql.yaml.

   3. Bring up the docker-compose formation:

      docker compose --profile truthset --file senzing-docker-compose-postgresql.yaml up --pull always

   4. In a separate terminal, exec into the senzingsdk-tools container:

      docker exec -it senzingsdk-tools /bin/bash

2. In addition to the TL;DR, this repository contains a multitude of docker-compose.yaml files in the docker-compose directory. Variations:

   Variation	Example filename
   database	senzing-docker-compose-<database>.yaml
   multi use	senzing-docker-compose-<database>-multi.yaml

   For step-by-step instructions, see Examples.

Caveat

This demonstration runs on platforms that support docker and docker-compose.

⚠️ RedHat has explicitly stated that Docker is not supported in RHEL 8. As such, these demonstrations of Senzing using docker and docker-compose do not run in a RedHat Enterprise Linux 8 environment natively. Likewise, docker is not a CentOS 8 supported project. Although with user-modification it has been shown that docker and docker-compose can run in these environments, the onus is on the user for proper operation of docker and docker networking.

Usage

1. ✏️ Identify the file to be downloaded. Choose from the files in the docker-compose directory.

   Example:

   export SENZING_TOOLS_DOCKER_COMPOSE_FILE=senzing-docker-compose-postgresql.yaml

2. Download the docker-compose file.

   curl -O https://raw.githubusercontent.com/senzing-garage/docker-compose-demo/refs/heads/main/docker-compose/${SENZING_TOOLS_DOCKER_COMPOSE_FILE}

3. Bring up Docker compose formation.

   docker-compose --profile new --file ${SENZING_TOOLS_DOCKER_COMPOSE_FILE} up --pull always

   1. --profile

      The --profile parameter specifies which variation of the docker-compose formation to bring up. Not all profiles exist for each docker-compose .yaml file.

      Profile	Description
      new	New formation with empty Senzing datastore.
      resume	Resume a prior docker-compose formation.
      truthset	New formation with Senzing TruthSets installed.

      For more information, see Profiles.

   2. --file

      The --file parameter specifies the file containing the docker-compose YAML specification.

   3. --pull always

      The optional --pull always parameter pulls the latest version of the Docker images before running. Omit the --pull always parameter if using the currently cached Docker images is preferred.

4. Work with Docker compose formation. See Services section.

5. Bring down Docker formation.

   docker-compose --profile new --file ${SENZING_TOOLS_DOCKER_COMPOSE_FILE} down --volumes

   1. --volumes

      The optional --volumes parameter cleans up the volumes. Omit the --volumes parameter if the data is to be reused via --profile resume.

Services

See Services for services rendered by each docker compose formation.

References

• Development
• Errors
• Examples
• Services