From e2683893b4cacb25fd6a8f823705dfccd8a0772f Mon Sep 17 00:00:00 2001
From: Kyle Snavely <kjsnavely@gmail.com>
Date: Tue, 19 Nov 2024 14:52:47 -0500
Subject: [PATCH] fix(UPM-42248): Updates the run-cdcreader.sh script example
 (#6260)

---
 .../getting_started/config_reader.mdx         | 62 +++++++++++++------
 1 file changed, 42 insertions(+), 20 deletions(-)

diff --git a/advocacy_docs/edb-postgres-ai/migration-etl/data-migration-service/getting_started/config_reader.mdx b/advocacy_docs/edb-postgres-ai/migration-etl/data-migration-service/getting_started/config_reader.mdx
index db3a3149fa0..611f32c0f97 100644
--- a/advocacy_docs/edb-postgres-ai/migration-etl/data-migration-service/getting_started/config_reader.mdx
+++ b/advocacy_docs/edb-postgres-ai/migration-etl/data-migration-service/getting_started/config_reader.mdx
@@ -21,51 +21,70 @@ redirects:
 
 1.  Open the EDB DMS reader located in `/opt/cdcreader/run-cdcreader.sh` and ensure you have write permissions. 
 
-1.  Set the variables according to your environment and uncomment the edited lines. See [parameters](#parameters) for further guidance.
+1.  Set the variables according to your environment and uncomment the edited lines. See [parameters](#parameters) for further guidance. The script is reproduced below.
 
 ```shell
-### set the following environment variables:
+#!/bin/bash -e
+# run_cdcreader.sh
+#
+# This script provides a convenient place to specify
+# environment variables used to configure the
+# EDB Data Migration Service Reader.
+#
+# After env exports, `java` is called to start the
+# software.
 
-##############################################
-# Data Migration Service Cloud Configuration #
-##############################################
+##########################################
+# DMS Reader General Configuration       #
+##########################################
 
-# This ID is used to identify the cdcreader.
+# This ID is used to identify DMS Reader
+# and is specified by the user.
 #export DBZ_ID=
 
-# Now we only support aws
+# Supported options include: appliance (the hybrid PG AI platform), aws
 #export CLOUD_PROVIDER=
 
-# No need to change about this field
+# This is the DMS backend service used by the Reader
+# If your CLOUD_PROVIDER is `appliance`, consult your system administrators
+# The default value supports the `aws` CLOUD_PROVIDER
 #export RW_SERVICE_HOST=https://transporter-rw-service.biganimal.com
 
-# You need to create migration credentials in EDB postgresAI platform and set these fields with the path of credential files
-#export TLS_PRIVATE_KEY_PATH=$MY_CREDENTIALS_PATH/client-key.pem
-#export TLS_CERTIFICATE_PATH=$MY_CREDENTIALS_PATH/client-cert.pem
-#export TLS_CA_PATH=$MY_CREDENTIALS_PATH/int.crt
-#export APICURIOREQUEST_CLIENT_KEYSTORE_LOCATION=$MY_CREDENTIALS_PATH/client.keystore.p12
-#export APICURIOREQUEST_TRUSTSTORE_LOCATION=$MY_CREDENTIALS_PATH/int.truststore.p12
-#export KAFKASECURITY_CLIENT_KEYSTORE_LOCATION=$MY_CREDENTIALS_PATH/client.keystore.p12
-#export KAFKASECURITY_TRUSTSTORE_LOCATION=$MY_CREDENTIALS_PATH/int.truststore.p12
+# You need to create migration credentials in EDB Postgres AI platform
+# and set these fields with the path of the credential files
+#export TLS_PRIVATE_KEY_PATH=$HOME/credentials/client-key.pem
+#export TLS_CERTIFICATE_PATH=$HOME/credentials/client-cert.pem
+#export TLS_CA_PATH=$HOME/credentials/int.crt
+#export APICURIOREQUEST_CLIENT_KEYSTORE_LOCATION=$HOME/credentials/client.keystore.p12
+#export APICURIOREQUEST_TRUSTSTORE_LOCATION=$HOME/credentials/int.truststore.p12
+#export KAFKASECURITY_CLIENT_KEYSTORE_LOCATION=$HOME/credentials/client.keystore.p12
+#export KAFKASECURITY_TRUSTSTORE_LOCATION=$HOME/credentials/int.truststore.p12
 
-################################################## 
-# Data Migration Service Source DB Configuration #
-##################################################
+##########################################
+# DMS Reader Source DB Configuration     #
+##########################################
 
 # A sample configuration to create a single postgres database connection:
 #export DBZ_DATABASES_0__TYPE=POSTGRES
 #export DBZ_DATABASES_0__HOSTNAME=localhost
 #export DBZ_DATABASES_0__PORT=5432
+# The CATALOG is the database name
 #export DBZ_DATABASES_0__CATALOG=source
 #export DBZ_DATABASES_0__USERNAME=postgres
+# The password env can be set without specifing it here
+# but the env structure looks like this
 #export DBZ_DATABASES_0__PASSWORD=password
 
-# You can increase the index to config more database for the reader
+# You can increase the index to configure more than
+# one database for the DMS Reader
 #export DBZ_DATABASES_1__TYPE=ORACLE
 #export DBZ_DATABASES_1__HOSTNAME=localhost
 #export DBZ_DATABASES_1__PORT=1521
+# The CATALOG is the database name
 #export DBZ_DATABASES_1__CATALOG=ORCLCDB/ORCLPDB1
 #export DBZ_DATABASES_1__USERNAME=oracle
+# The password env can be set without specifing it here
+# but the env structure looks like this
 #export DBZ_DATABASES_1__PASSWORD=password
 
 ##########################################
@@ -77,6 +96,9 @@ redirects:
 #export QUARKUS_LOG_LEVEL=DEBUG
 # Loglevel for a single package
 #export QUARKUS_LOG_CATEGORY__COM_ENTERPRISEDB__LEVEL=DEBUG
+
+cd $(dirname $0)
+java ${JAVA_OPTS} -jar quarkus-run.jar
 ```
 
 ## Parameters