feat: clean enable

Author: cc3630

README.md

@@ -137,6 +137,7 @@ S3 支持使用虚拟域名作为 endpoint，即可以将 region 或者 bucket 
 
 - MONGO_URI: 必填，uri，例如 `mongodb://root:[email protected]/some-db?authSource=admin`
 - FILE_PREFIX: 选填，备份文件前缀，例如 fcp
+- BACKUP_CLEAN_ENABLE: 选填，开启备份清理，默认为 true 表示启用
 - BACKUP_SAVE_NUMS: 选填，备份保存数量，例如 3，默认保存 3 份
 - MONGO_COLLECTION: 选填，集合名称，不支持多个，例如 gantry，若不为空，则需保证 MONGO_DB 也存在
 - MONGO_EXCLUDE_COLLECTIONS: 选填，忽略的集合名称，支持多个，例如 test1,test2，若不为空，则需保证 MONGO_DB 也存在，且若 MONGO_COLLECTION 不为空，则忽略该参数

docker/backup.py

@@ -24,6 +24,7 @@
 other_inputs = [
     "FILE_PREFIX",
     "BACKUP_PATH",
+    "BACKUP_CLEAN_ENABLE",
     "BACKUP_SAVE_NUMS",
     "MONGO_COLLECTION",
     "MONGO_EXCLUDE_COLLECTIONS",
@@ -67,6 +68,9 @@ def check_bool(key):
 backup_path = (
     os.environ["BACKUP_PATH"] if check_var("BACKUP_PATH") else DEFAULT_BACKUP_PATH
 )
+backup_clean_enable = (
+    check_bool("BACKUP_CLEAN_ENABLE") if check_var("BACKUP_CLEAN_ENABLE") else True
+)
 backup_save_nums = (
     int(os.environ["BACKUP_SAVE_NUMS"])
     if check_var("BACKUP_SAVE_NUMS")
@@ -214,34 +218,41 @@ def upload_s3(prefix):
     upload_path = f"{s3_prefix}/{file_name}" if s3_prefix else file_name
     client.upload_file(f"{backup_path}/{file_name}", s3_bucket, upload_path)
 
-    # 清理 S3 上的多余备份文件
-    list_prefix = f"{s3_prefix}/" if s3_prefix else ""
-    resp = client.list_objects_v2(Bucket=s3_bucket, Prefix=list_prefix, Delimiter="/")
-    if "Contents" in resp:
-        objects = resp["Contents"]
-
-        file_prefix = f"{list_prefix}{prefix}"
-        # 构造正则表达式
-        regex_pattern = f"^{re.escape(file_prefix)}(\\d{{14}})\\.tar\\.gz(\\.crypt)?$"
-        compiled_regex = re.compile(regex_pattern)
-        keys = [
-            object["Key"] for object in objects if compiled_regex.match(object["Key"])
-        ]
-
-        # 根据文件名排序（这使得最新的备份文件位于列表的末尾）
-        keys.sort()
-
-        # 确定需要删除的文件（保留最后N个文件，这里是backup_save_nums）
-        keys_to_remove = keys[:-backup_save_nums]
-
-        # 删除旧的备份文件
-        if keys_to_remove:
-            for key in keys_to_remove:
-                client.delete_object(
-                    Bucket=s3_bucket,
-                    Key=key,
-                )
-            print(f"Deleted s3 old backup files: {keys_to_remove}")
+    if backup_clean_enable:
+        # 清理 S3 上的多余备份文件
+        list_prefix = f"{s3_prefix}/" if s3_prefix else ""
+        resp = client.list_objects_v2(
+            Bucket=s3_bucket, Prefix=list_prefix, Delimiter="/"
+        )
+        if "Contents" in resp:
+            objects = resp["Contents"]
+
+            file_prefix = f"{list_prefix}{prefix}"
+            # 构造正则表达式
+            regex_pattern = (
+                f"^{re.escape(file_prefix)}(\\d{{14}})\\.tar\\.gz(\\.crypt)?$"
+            )
+            compiled_regex = re.compile(regex_pattern)
+            keys = [
+                object["Key"]
+                for object in objects
+                if compiled_regex.match(object["Key"])
+            ]
+
+            # 根据文件名排序（这使得最新的备份文件位于列表的末尾）
+            keys.sort()
+
+            # 确定需要删除的文件（保留最后N个文件，这里是backup_save_nums）
+            keys_to_remove = keys[:-backup_save_nums]
+
+            # 删除旧的备份文件
+            if keys_to_remove:
+                for key in keys_to_remove:
+                    client.delete_object(
+                        Bucket=s3_bucket,
+                        Key=key,
+                    )
+                print(f"Deleted s3 old backup files: {keys_to_remove}")
 
 
 try:
@@ -259,8 +270,9 @@ def upload_s3(prefix):
     print("backup end")
 
     # 2. 清理备份，保留最近的若干份
-    cleanup_files(final_prefix)
-    print("cleanup end")
+    if backup_clean_enable:
+        cleanup_files(final_prefix)
+        print("cleanup end")
 
     if s3_enable:
         # 3. 将备份文件上传到 S3，并清理 S3 上的多余备份文件

helm-chart/Chart.yaml

@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.6.4
+version: 1.6.5
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "1.6.4"
+appVersion: "1.6.5"

helm-chart/values.yaml

@@ -69,7 +69,7 @@ backup:
   image:
     registry: ""
     repository: 36node/mongodb-backup
-    tag: 1.6.4
+    tag: 1.6.5
     digest: ""
     ## Specify a imagePullPolicy
     ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
@@ -134,7 +134,7 @@ restore:
   image:
     registry: ""
     repository: 36node/mongodb-backup
-    tag: 1.6.4
+    tag: 1.6.5
     digest: ""
     ## Specify a imagePullPolicy
     ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'