From 61e7d63ff7d42b0f5fcd572e50f19836c726a29d Mon Sep 17 00:00:00 2001
From: jsjiang <jing.jiang@ucop.edu>
Date: Tue, 10 Oct 2023 14:49:18 -0700
Subject: [PATCH] update minter migration notes

---
 deploy_minter_migration.sh        | 71 -------------------------------
 doc/bdb_minter_migration.md       | 42 ------------------
 doc/bdb_minter_migration_notes.md | 65 ++++++++++++++++++++++++++++
 3 files changed, 65 insertions(+), 113 deletions(-)
 delete mode 100755 deploy_minter_migration.sh
 delete mode 100644 doc/bdb_minter_migration.md
 create mode 100644 doc/bdb_minter_migration_notes.md

diff --git a/deploy_minter_migration.sh b/deploy_minter_migration.sh
deleted file mode 100755
index 448c99f2..00000000
--- a/deploy_minter_migration.sh
+++ /dev/null
@@ -1,71 +0,0 @@
-echo "Start minter migration steps ..."
-echo "1. Check minters"
-
-read -p "Have you run the shoulder-check-minters command to check the minters? [yes/no]: " yn
-if [[ "$yn" == "yes" ]]; then
-  read -p "Do you wish to continue to next step? [yes/no]: " next_step
-  if [[ "$next_step" != "yes" ]]; then
-    echo "Minter migration aborted."
-    exit
-  fi
-elif [[ "$yn" == "no" ]]; then
-  cat <<EOF
-Please finish checking minters before proceeding to the next step:
-  a. Run the shoulder-check-minters:
-     python manage.py shoulder-check-minters"
-  b. Review the output
-  c. Fix issues if needed
-  d. Rerun this minter migration script
-EOF
-  exit
-else
-  echo "Please answer yes or no."
-  exit
-fi
-
-echo "2. Shutdown EZID servies"
-sudo cdlsysctl stop ezid
-sudo cdlsysctl stop ezid-proc-*
-
-echo "3. Update/Deploy EZID code"
-read -p "Is EZID on the right tag/branch? [yes/no]: " yn
-if [[ "$yn" != "yes" ]]; then
-  echo "Please update/deploy EZID code to the preferred tag/branch."
-  echo "On EZID  Stg/Prd  server, run the Puppet apply script to deploy EZID code:"
-  echo "uc3_pupapply.sh --exec --no-services"
-  exit
-fi
-
-echo "4. Modify EZID settings to use the eziddba account for data model migration."
-read -p "Is EZID on the right tag/branch? [yes/no]: " yn
-if [[ "$yn" != "yes" ]]; then
-  echo "Please update the database user to eziddba in the settings.py file."
-  exit
-fi
-
-echo "5. Backup minter files"
-timestamp=`date '+%Y%m%d%H%M%S'`
-minters_bk="minters.${timestamp}"
-
-cp -r ~/var/minters ~/var/${minters_bk}
-
-echo "Minter files are backed up to: ${minters_bk}"
-
-echo "6. Apply EZID migration files to the database"
-python manage.py migrate
-
-echo "7. Run the minter data migration script"
-python manage.py migrate-minters-to-mysql
-
-echo "8. Rename var/minters to disable BDB version minters" 
-mv ~/var/minters ~/var/minters.sql_migration
-
-echo "BDB minters has been renamed to ~/var/minters.sql_migration"
-
-echo "Perform post-migration steps:"
-echo "9. Review minter data migration results"
-echo "10. Modify EZID settings to use the ezidrw account"
-echo "11. Restart EZID services"
-
-
-
diff --git a/doc/bdb_minter_migration.md b/doc/bdb_minter_migration.md
deleted file mode 100644
index ee0faf61..00000000
--- a/doc/bdb_minter_migration.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# Berkeley DB minter migraiton notes
-
-0. Preparation steps
-
-a. Stop the EZID and background services
-b. Backup the BDB minter folder (optional)
-
-1. Create the minter table in the EZID database
-
-Required files:
-* data model: minter.py
-* migration file: 0004_minter.py
-
-Run the "migrate" command to create the `minter` table:
-
-python manage.py migrate
-
-2. Perform data migraiton
-
-Run the data migration script to convert the BDB minters to JSON objects and load them to the minter table in MySQL.
-
-Script: `migrate-minters-to-mysql.py`
-Folder: /ezidapp/management/commands
-
-The script takes two optional arguments:
-* --dry-run/-r: dry run without updating the minter table in the EZID database
-* --output-file/-o: save BDB datasets in an output file in JSON format
-
-Sample command
-
-```
-$ python manage.py migrate-minters-to-mysql.py
-```
-
-3. Disable the Berkeley minter database 
-
-a. Rename the Berkeley minter folder
-b. Modify the settings.py file to remove Berkeley minter related entries
-
-
- 
- 
diff --git a/doc/bdb_minter_migration_notes.md b/doc/bdb_minter_migration_notes.md
new file mode 100644
index 00000000..b1531f50
--- /dev/null
+++ b/doc/bdb_minter_migration_notes.md
@@ -0,0 +1,65 @@
+# Berkeley DB minter migraiton notes
+
+## Preparation steps
+
+### 1. Check the minters
+
+Run the shoulder-check-minters command to check the minters.
+```
+python manage.py shoulder-check-minters
+```
+Review the output and fix issues if needed.
+
+
+### 2. Stop the EZID and background services
+
+### 3. Backup the BDB minters folder
+
+### 4. Backup the EZID RDS database
+
+### 5. Update/Deploy EZID code
+
+* Make sure the puppet deploy script does not start EZID and background jobs after code deployment
+* Make sure EZID is on the preferred tag/branch
+
+## Create the minter table in the EZID database
+
+### 1. Modify the EZID settings to use the eziddba account for data model migration
+### 2. Make sure the required data model and mingration files are in place
+* data model: minter.py
+* migration file: 0004_minter.py
+
+### 3. Run the "migrate" migrate command to create the `minter` table:
+```
+python manage.py migrate
+```
+
+## Perform minter data migraiton
+
+Run the minter data migration script to convert the BDB minters to JSON objects and load them to the minter table in MySQL.
+
+Script: `migrate-minters-to-mysql.py`
+Folder: /ezidapp/management/commands
+
+The script takes two optional arguments:
+* --dry-run/-r: dry run without updating the minter table in the EZID database
+* --output-file/-o: save BDB datasets in an output file in JSON format
+
+Sample command
+
+```
+$ python manage.py migrate-minters-to-mysql.py
+```
+
+## Disable the Berkeley minter database 
+
+* Rename the Berkeley minter folder
+* Modify the settings.py file to remove Berkeley minter related entries
+
+## Perform post-migration steps
+Perform post-migraiton steps:
+* Review minter data migration results
+* Modify the EZID settings to use the ezidrw account
+* Restart EZID and back ground jobs
+ 
+