senzing/init-postgresql repository overview

⁠init-postgresql

⁠Synopsis

Initializes a PostgreSQL database for use with Senzing.

⁠Overview

The init-postgresqll.py⁠ python script is a "run-to-completion" job that initializes a PostgreSQL database for use with Senzing. It create the Senzing database schema and populates the database with an initial Senzing configuration.

The senzing/init-postgresql Docker image is a wrapper for use in Docker formations (e.g. docker-compose, kubernetes).

To see all of the subcommands, run:

$ ./init-postgresql.py
usage: init-postgres.py [-h] {mandatory,sleep,version,docker-acceptance-test} ...

Add description. For more information, see https://github.com/Senzing/init-postgres

positional arguments:
  {mandatory,sleep,version,docker-acceptance-test}
                        Subcommands [SENZING_SUBCOMMAND]:
    mandatory           Perform mandatory initialization tasks.
    sleep               Do nothing but sleep. For Docker testing.
    version             Print version of program.
    docker-acceptance-test
                        For Docker acceptance testing.

optional arguments:
  -h, --help            show this help message and exit

⁠Contents

1. Preamble⁠
   1. Legend⁠
2. Expectations⁠
3. Demonstrate using Docker⁠
4. Demonstrate using docker-compose⁠
5. Configuration⁠
6. License⁠
7. References⁠

⁠Preamble

At Senzing⁠, we strive to create GitHub documentation in a "don't make me think⁠" style. For the most part, instructions are copy and paste. Whenever thinking is needed, it's marked with a "thinking" icon :thinking:. Whenever customization is needed, it's marked with a "pencil" icon :pencil2:. If the instructions are not clear, please let us know by opening a new Documentation issue⁠ describing where we can improve. Now on with the show...

⁠Legend

1. :thinking: - A "thinker" icon means that a little extra thinking may be required. Perhaps there are some choices to be made. Perhaps it's an optional step.
2. :pencil2: - A "pencil" icon means that the instructions may need modification before performing.
3. :warning: - A "warning" icon means that something tricky is happening, so pay attention.

⁠Expectations

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

⁠Demonstrate using Docker

1. :pencil2: Specify database connection information. Example:

   export DATABASE_PROTOCOL=postgresql
   export DATABASE_USERNAME=postgres
   export DATABASE_PASSWORD=postgres
   export DATABASE_HOST=example.com
   export DATABASE_PORT=5432
   export DATABASE_DATABASE=G2
   
   

   Copy

2. :thinking: Tip: Do not set DATABASE_HOST to localhost nor 127.0.0.1 as that assumes the database is inside the Docker container. If the database is running on the local system, here's a method of finding the IP address of the local system. Example:

   export DATABASE_HOST=$(curl --silent https://raw.githubusercontent.com/Senzing/knowledge-base/main/gists/find-local-ip-address/find-local-ip-address.py | python3 -)
   
   

   Copy

3. Construct Database URL. Example:

   export SENZING_DATABASE_URL="${DATABASE_PROTOCOL}://${DATABASE_USERNAME}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_DATABASE}"
   
   

   Copy

4. Run Docker container. Example:

   sudo --preserve-env docker run \
     --env SENZING_DATABASE_URL \
     --rm \
     senzing/init-postgresql mandatory
   
   

   Copy

5. Alternative: Run Docker container. Example:

   sudo --preserve-env docker run \
     --env SENZING_DATABASE_URL \
     --env SENZING_SUBCOMMAND=mandatory \
     --rm \
     senzing/init-postgresql
   
   

   Copy

⁠Demonstrate using docker-compose

1. :pencil2: Specify a new directory to hold demonstration artifacts on the local host. Example:

   export SENZING_VOLUME=~/my-senzing
   
   

   Copy
   1. :warning: macOS - File sharing⁠ must be enabled for SENZING_VOLUME.
   2. :warning: Windows - File sharing⁠ must be enabled for SENZING_VOLUME.

2. Set environment variables. Example:

   export PGADMIN_DIR=${SENZING_VOLUME}/pgadmin
   export POSTGRES_DIR=${SENZING_VOLUME}/postgres
   
   

   Copy

3. Create directories. Example:

   mkdir -p ${PGADMIN_DIR} ${POSTGRES_DIR}
   
   

   Copy

4. Get versions of Docker images. Example:

   curl -X GET \
       --output ${SENZING_VOLUME}/docker-versions-stable.sh \
       https://raw.githubusercontent.com/Senzing/knowledge-base/main/lists/docker-versions-stable.sh
   source ${SENZING_VOLUME}/docker-versions-stable.sh
   
   

   Copy

5. Download docker-compose.yaml and Docker images. Example:

   curl -X GET \
       --output ${SENZING_VOLUME}/docker-compose.yaml \
       "https://raw.githubusercontent.com/Senzing/init-postgresql/main/docker-compose.yaml"
   cd ${SENZING_VOLUME}
   sudo --preserve-env docker-compose pull
   
   

   Copy

6. Bring up Senzing docker-compose stack. Example:

   cd ${SENZING_VOLUME}
   sudo --preserve-env docker-compose up
   
   

   Copy

7. Allow time for the components to be downloaded, start, and initialize.

   1. There will be errors in some Docker logs as they wait for dependent services to become available. docker-compose isn't the best at orchestrating Docker container dependencies.

⁠Configuration

Configuration values specified by environment variable or command line parameter.

• SENZING_CONFIGURATION_MODIFICATIONS⁠
• SENZING_DATABASE_URL⁠
• SENZING_DEBUG⁠
• SENZING_ENGINE_CONFIGURATION_JSON⁠
• SENZING_INPUT_SQL_URL⁠
• SENZING_SUBCOMMAND⁠

⁠License

View license information⁠ for the software container in this Docker image. Note that this license does not permit further distribution.

This Docker image may also contain software from the Senzing GitHub community⁠ under the Apache License 2.0⁠.

Further, as with all Docker images, this likely also contains other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

⁠References

1. Development⁠
2. Errors⁠
3. Examples⁠
4. Related artifacts:
   1. DockerHub⁠
   2. Helm Chart⁠