Merge branch 'improvement/rotate-bash-logs' into q/125.0

scality · Mar 20, 2023 · b629d64 · b629d64
2 parents 9e87757 + 368104e
commit b629d64
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -93,6 +93,9 @@
   - Bump prometheus-operator and prometheus-config-reloader containers version to
     [0.63.0](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.63.0)
 
+- Add log rotation to shell scripts
+  (PR[#4030](https://github.com/scality/metalk8s/pull/4030))
+
 ### Bug fixes
 
 - Fix a bug in Workload Plane Ingress Virtual IPs that make the DaemonSet Pod

diff --git a/scripts/backup.sh.in b/scripts/backup.sh.in
@@ -52,8 +52,14 @@ done
 TMPFILES=$(mktemp -d)
 BACKUP_DIR=$(mktemp -d)
 
+BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "$LOGFILE")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- Backup started on $(date -u -R) ---
 EOF
@@ -67,10 +73,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 _save_cp() {
     local -r src="$(readlink -f "$1")"
     local -r dst="$2"

diff --git a/scripts/bootstrap.sh.in b/scripts/bootstrap.sh.in
@@ -37,8 +37,14 @@ done
 
 TMPFILES=$(mktemp -d)
 
+BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "${LOGFILE}")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- Bootstrap started on $(date -u -R) ---
 EOF
@@ -51,8 +57,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-
 SALT_CALL=${SALT_CALL:-salt-call}
 
 declare -a PACKAGES=(
@@ -63,9 +67,6 @@ declare -a PACKAGES=(
     genisoimage
 )
 
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 orchestrate_bootstrap() {
     local -r control_plane_ip=$(
         $SALT_CALL --local grains.get metalk8s:control_plane_ip --out txt \

diff --git a/scripts/common.sh.in b/scripts/common.sh.in
@@ -13,6 +13,8 @@ RPM=${RPM:-$(command -v rpm || true)}
 YUM=${YUM:-$(command -v yum || true)}
 SYSTEMCTL=${SYSTEMCTL:-$(command -v systemctl)}
 PYTHON=${PYTHON:-$(command -v python3 || command -v python || true)}
+LOGFILE_MAX_ROTATIONS=10
+
 
 determine_os() {
     # We rely on /etc/os-release to discover the OS because its present on all
@@ -371,3 +373,27 @@ check_minion_id() {
         return 1
     fi
 }
+
+rotate_logfile() {
+    # because set -u, we pass an empty string as default value
+    _rotate_logfile ""
+}
+
+_rotate_logfile() {
+    # Rotate logfile if it exists
+    if [ -n "$1" ]; then
+        if [ "$1" -gt "$LOGFILE_MAX_ROTATIONS" ]; then
+            rm -f "$LOGFILE.$1"
+            return
+        fi
+        if [ -f "$LOGFILE.$1" ]; then
+            _rotate_logfile $(($1+1))
+            mv "$LOGFILE.$1" "$LOGFILE.$(($1+1))"
+        fi
+    else
+        if [ -f "$LOGFILE" ]; then
+            _rotate_logfile 1
+            mv "$LOGFILE" "$LOGFILE.1"
+        fi
+    fi
+}
diff --git a/scripts/downgrade.sh.in b/scripts/downgrade.sh.in
@@ -69,8 +69,13 @@ done
 
 TMPFILES=$(mktemp -d)
 
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "${LOGFILE}")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- MetalK8s downgrade started on $(date -u -R) ---
 EOF
@@ -83,9 +88,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 precheck_downgrade () {
     SALT_MASTER_CALL=(crictl exec -i "$(get_salt_container)")
     "${SALT_MASTER_CALL[@]}" salt-run saltutil.sync_all \

diff --git a/scripts/iso-manager.sh b/scripts/iso-manager.sh
@@ -56,8 +56,14 @@ done
 
 TMPFILES=$(mktemp -d)
 
+BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "${LOGFILE}")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- MetalK8s ISO manager started on $(date -u -R) ---
 EOF
@@ -70,11 +76,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 # helper function to set the current saltenv
 _set_env() {
     if [ -z "$SALTENV" ]; then

diff --git a/scripts/restore.sh.in b/scripts/restore.sh.in
@@ -50,8 +50,14 @@ done
 TMPFILES=$(mktemp -d)
 BACKUP_DIR=$(mktemp -d)
 
+BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "$LOGFILE")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- Restore started on $(date -u -R) ---
 EOF
@@ -65,8 +71,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-
 SALT_CALL=${SALT_CALL:-salt-call}
 
 declare -a PACKAGES=(
@@ -77,9 +81,6 @@ declare -a PACKAGES=(
     genisoimage
 )
 
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 _save_cp() {
     local -r src="$(readlink -f "$1")"
     local -r dst="$2"

diff --git a/scripts/solutions.sh b/scripts/solutions.sh
@@ -195,8 +195,14 @@ done
 
 TMPFILES=$(mktemp -d)
 
+BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "$LOGFILE")"
 
+rotate_logfile
+
 exec > >(tee -ia "$LOGFILE") 2>&1
 
 cleanup() {
@@ -205,10 +211,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-BASE_DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 check_command_mandatory_options() {
     local -a missing_options=()
     local -r command=$1

diff --git a/scripts/upgrade.sh.in b/scripts/upgrade.sh.in
@@ -57,8 +57,13 @@ done
 
 TMPFILES=$(mktemp -d)
 
+# shellcheck disable=SC1090,SC1091
+. "$BASE_DIR"/common.sh
+
 mkdir -p "$(dirname "${LOGFILE}")"
 
+rotate_logfile
+
 cat << EOF >> "${LOGFILE}"
 --- MetalK8s Upgrade started on $(date -u -R) ---
 EOF
@@ -71,9 +76,6 @@ cleanup() {
 
 trap cleanup EXIT
 
-# shellcheck disable=SC1090,SC1091
-. "$BASE_DIR"/common.sh
-
 upgrade_bootstrap () {
     "$SALT_CALL" saltutil.sync_all saltenv="$SALTENV"