Add HEALTHCHECKs to middleware containers (#27)

* Add healthcheck.sh
* Add healthcheck logic for consumer/redoer containers

Additionally:
* Small update to readme
* Add Q_URL env var to consumer entry im docker-compose

Author: spompea-cfa

.trivyignore.yaml

@@ -2,7 +2,5 @@ misconfigurations:
   # The tools Dockerfile doesn't need a healthcheck.
   - id: AVD-DS-0026
     paths:
-      - Dockerfile.consumer # Jira -67
-      - Dockerfile.redoer # Jira -67
       - Dockerfile.exporter # ephemeral container, healthcheck not necessary
       - Dockerfile.tools

Dockerfile.consumer

@@ -3,13 +3,15 @@ FROM senzing/senzingsdk-runtime:4.0.0
 USER root
 
 RUN apt-get update \
- && apt-get -y install --no-install-recommends python3 python3-pip python3-boto3 \
+ && apt-get -y install --no-install-recommends python3 python3-pip python3-boto3 procps \
  && apt-get -y autoremove \
  && apt-get -y clean
 
 WORKDIR /app
 COPY middleware/* .
 
+RUN chmod +x healthcheck.sh
+
 # Add a new user and switch to it.
 RUN useradd -m -u 1001 senzing
 USER senzing
@@ -23,4 +25,6 @@ ENV PYTHONUNBUFFERED=1
 # Fargate.
 VOLUME ["/home/senzing", "/var/lib/amazon", "/var/log"]
 
+HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 CMD ./healthcheck.sh consumer.py || exit 1
+
 CMD ["python3", "consumer.py"]

Dockerfile.redoer

@@ -10,6 +10,8 @@ RUN apt-get update \
 WORKDIR /app
 COPY middleware/* .
 
+RUN chmod +x healthcheck.sh
+
 # Add a new user and switch to it.
 RUN useradd -m -u 1001 senzing
 USER senzing
@@ -19,4 +21,6 @@ ENV PYTHONPATH=/opt/senzing/er/sdk/python:/app
 # Flush buffer - helps with print statements.
 ENV PYTHONUNBUFFERED=1
 
+HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 CMD ./healthcheck.sh redoer.py || exit 1
+
 CMD ["python3", "redoer.py"]

README.md

@@ -181,7 +181,7 @@ simultaneously as needed):
    ```bash
    docker compose run --env AWS_PROFILE=localstack --env \
    Q_URL="http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/sqs-senzing-local-ingest" \
-   --env LOG_LEVEL=INFO consumer
+   --env LOG_LEVEL=DEBUG consumer
    ```
 
 `LOG_LEVEL` is optional; defaults to `INFO`.
@@ -191,7 +191,7 @@ simultaneously as needed):
 Similar to the consumer, the redoer is also a continually-running process.
 
     ```bash
-    docker compose run --env AWS_PROFILE=localstack --env LOG_LEVEL=debug redoer
+    docker compose run --env AWS_PROFILE=localstack --env LOG_LEVEL=DEBUG redoer
     ```
 
 `LOG_LEVEL` is optional; defaults to `INFO`.

docker-compose.yaml

@@ -104,6 +104,7 @@ services:
             "CONNECTION": "postgresql://${POSTGRES_USERNAME:-senzing}:${POSTGRES_PASSWORD:-senzing}@db:5432:${POSTGRES_DB:-G2}/?sslmode=disable"
           }
         }
+      Q_URL: http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/sqs-senzing-local-ingest
     volumes:
       # Note: `.aws` mount might not be needed later.
       - ~/.aws:/home/senzing/.aws

middleware/healthcheck.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+ps -ef | grep $1 | grep -v grep