https://github.com/senzing-garage/docker-compose-demo
Demonstrate Senzing stack using `docker-compose`.
https://github.com/senzing-garage/docker-compose-demo
demonstration docker-compose senzing-cleanup senzing-garage senzing-stack top-pick
Last synced: about 2 months ago
JSON representation
Demonstrate Senzing stack using `docker-compose`.
- Host: GitHub
- URL: https://github.com/senzing-garage/docker-compose-demo
- Owner: senzing-garage
- License: apache-2.0
- Created: 2019-05-02T23:13:54.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2026-02-13T22:22:52.000Z (4 months ago)
- Last Synced: 2026-02-14T00:33:09.722Z (4 months ago)
- Topics: demonstration, docker-compose, senzing-cleanup, senzing-garage, senzing-stack, top-pick
- Homepage:
- Size: 13.4 MB
- Stars: 18
- Watchers: 5
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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]
1. Download docker-compose file:
```console
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].
1. Bring up the docker-compose formation:
```console
docker compose --profile truthset --file senzing-docker-compose-postgresql.yaml up --pull always
```
1. In a separate terminal, exec into the `senzingsdk-tools` container:
```console
docker exec -it senzingsdk-tools /bin/bash
```
1. 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-.yaml` |
| multi use | `senzing-docker-compose--multi.yaml` |
For step-by-step instructions, see [Examples].
## Caveat
This demonstration runs on platforms that support `docker` and `docker-compose`.
:warning: 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. :pencil2: Identify the file to be downloaded.
Choose from the files in the [docker-compose directory].
Example:
```console
export SENZING_TOOLS_DOCKER_COMPOSE_FILE=senzing-docker-compose-postgresql.yaml
```
1. Download the docker-compose file.
```console
curl -O https://raw.githubusercontent.com/senzing-garage/docker-compose-demo/refs/heads/main/docker-compose/${SENZING_TOOLS_DOCKER_COMPOSE_FILE}
```
1. Bring up Docker compose formation.
```console
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].
1. `--file`
The [--file] parameter specifies the file containing the docker-compose YAML specification.
1. `--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.
1. Work with Docker compose formation.
See [Services] section.
1. Bring down Docker formation.
```console
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]
[--file]: https://docs.docker.com/reference/cli/docker/compose/
[--profile resume]: https://docs.docker.com/reference/cli/docker/compose/up/#options
[--profile]: https://docs.docker.com/reference/cli/docker/compose/
[--pull always]: https://docs.docker.com/reference/cli/docker/compose/up/#options
[--volumes]: https://docs.docker.com/reference/cli/docker/compose/down/#options
[Development]: docs/development.md
[Docker compose]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker-compose.md
[Docker is not supported in RHEL 8]: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/building_running_and_managing_containers/index#con_running-containers-without-docker_assembly_starting-with-containers
[docker-compose directory]: https://github.com/senzing-garage/docker-compose-demo/tree/main/docker-compose
[download senzing-docker-compose-postgresql.yaml]: https://raw.githubusercontent.com/senzing-garage/docker-compose-demo/refs/heads/main/docker-compose/senzing-docker-compose-postgresql.yaml
[Errors]: docs/errors.md
[Examples]: docs/examples.md
[Profiles]: docs/services.md#profiles
[Senzing Garage]: https://github.com/senzing-garage
[Senzing Quick Start guides]: https://docs.senzing.com/quickstart/
[Senzing]: https://senzing.com/
[Services]: docs/services.md