Provide more helpful information for Docker Compose Override file

getsentry · Jan 12, 2025 · 4135ee6 · 4135ee6
1 parent 8e5aa7d
commit 4135ee6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/patches/README.md b/patches/README.md
@@ -11,7 +11,7 @@ to modify the existing configuration to achieve the desired goal.
 
 ## How to use patches
 
-The patches are designed mostly to help modify the existing configuration files. You will need to run the `install.sh` script afterwards. 
+The patches are designed mostly to help modify the existing configuration files. You will need to run the `install.sh` script afterwards.
 They should be run from the root directory. For example, the `external-kafka.sh` patch should be run as:
 ```bash
 ./patches/external-kafka.sh

diff --git a/patches/external-kafka.sh b/patches/external-kafka.sh
@@ -241,7 +241,9 @@ services:
 EOF
 )
 if [[ -f "docker-compose.override.yml" ]]; then
-  echo "🚨 docker-compose.override.yml already exists. You will need to modify it manually:"
+  echo "🚨 docker-compose.override.yml already exists. You will need to modify it manually with the following content."
+  echo "Changes: Reset the 'kafka' service block, add additional Kafka-related environment variables to 'vroom', 'relay', 'sentry'-related and 'snuba'-related services."
+  echo ""
   echo "$COMPOSE_OVERRIDE_CONTENT"
 else
   echo "🚨 docker-compose.override.yml  does not exist. Creating it now."
@@ -257,4 +259,6 @@ echo "-   2. Modify the Kafka credentials on your $RELAY_CONFIG_YML file."
 echo "-   3. Run ./install.sh"
 echo "-"
 echo "-   NOTE: Remove or comment the corresponding line if you don't use it."
+echo "-         It is also safe to prune/delete 'sentry-kafka'"
+echo "-         and 'sentry-kafka-log' Docker volumes."
 echo "------------------------------------------------------------------------"