From a38d65bb211cc51c7b85da8d10836e0a3432dfca Mon Sep 17 00:00:00 2001 From: "David P. Steelman" Date: Thu, 24 Oct 2024 14:10:00 -0400 Subject: [PATCH] LIBDRUM-882. Renamed "drum_pg_restore.sh" script to "pg_restore_drum.sh" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Renamed the "drum_pg_restore.sh" script added in LIBDRUM-814 to "pg_restore_drum.sh", because the Postgres database dump also typically begins with the “drum” prefix, which made it slightly irksome when using tab completion on the command-line. This is a just minor “quality of life” improvement. https://umd-dit.atlassian.net/browse/LIBDRUM-882 --- .gitignore | 2 +- dspace/docs/DrumDBRestore.md | 2 +- postgres-init/README.md | 10 +++++----- .../{drum_pg_restore.sh => pg_restore_drum.sh} | 0 4 files changed, 7 insertions(+), 7 deletions(-) rename postgres-init/{drum_pg_restore.sh => pg_restore_drum.sh} (100%) diff --git a/.gitignore b/.gitignore index 0572904c5c7f..9c2a94050926 100644 --- a/.gitignore +++ b/.gitignore @@ -10,7 +10,7 @@ dspace/src/main/docker/nginx/certs/* # Ignore database dump directory to be used with docker-compose for initializing postgres-init/* !postgres-init/README.md -!postgres-init/drum_pg_restore.sh +!postgres-init/pg_restore_drum.sh ## End UMD Customization ## Ignore the MVN compiled output directories from version tracking diff --git a/dspace/docs/DrumDBRestore.md b/dspace/docs/DrumDBRestore.md index f8a6bd32433c..0d01acd96e6c 100644 --- a/dspace/docs/DrumDBRestore.md +++ b/dspace/docs/DrumDBRestore.md @@ -19,7 +19,7 @@ with DRUM running DSpace 7. ``` **Note:** The output file MUST use a ".dump" extension, in order for the - "drum_pg_restore.sh" script to process it, see + "pg_restore_drum.sh" script to process it, see "[postgres-init/README.md](../../postgres-init/README.md)" 3) (Optional) This step can be skipped, if you are following the instructions in diff --git a/postgres-init/README.md b/postgres-init/README.md index 424cb624f2b1..b51b44095ce1 100644 --- a/postgres-init/README.md +++ b/postgres-init/README.md @@ -1,9 +1,9 @@ # Database initialization for docker-compose Place your database dump file in this directory, and the "dspacedb" container -will use it to initialize the database, via the "drum_pg_restore.sh" script. +will use it to initialize the database, via the "pg_restore_drum.sh" script. -## drum_pg_restore.sh and CVE-2023-2454 +## pg_restore_drum.sh and CVE-2023-2454 Prior to DSpace 7.6.2, it was possible to use "pg_dump" to create a "plain" SQL file (with a ".sql" extension), and the "postgres" Docker image @@ -16,12 +16,12 @@ process running as the "postgres" user, and the use of the "pgcrypto" extension). Note that plain SQL dumps *will* work when run from the Docker container's command-line. -The workaround was to create the "postgres-init/drum_pg_restore.sh", script +The workaround was to create the "postgres-init/pg_restore_drum.sh", script which uses "pg_restore" to populate the database with a Postgres "custom" dump file. This is used in preference to a plain SQL file, to keep the automatic Docker initialization from interfering with the process. -The "postgres-init/drum_pg_restore.sh" will run automatically when the Docker +The "postgres-init/pg_restore_drum.sh" will run automatically when the Docker container starts, *if* a database doesn't already exist. ## Creating the Postgres dump @@ -33,7 +33,7 @@ $ kubectl exec drum-db-0 -- pg_dump -Fc -C -O -U drum -d drum > postgres-init/dr ``` **Note:** The output file MUST use a ".dump" extension, in order for the -"drum_pg_restore.sh" script to process it. +"pg_restore_drum.sh" script to process it. ## Delete local database data diff --git a/postgres-init/drum_pg_restore.sh b/postgres-init/pg_restore_drum.sh similarity index 100% rename from postgres-init/drum_pg_restore.sh rename to postgres-init/pg_restore_drum.sh