Add mirage cleanup command

Author: badrogger

node_cli/cli/mirage_node.py

@@ -19,9 +19,10 @@
 
 import click
 
-from node_cli.core.node import get_node_signature, backup, get_node_info
-from node_cli.mirage.mirage_node import restore_mirage, request_repair
-from node_cli.utils.helper import error_exit, streamed_cmd, abort_if_false, URL_TYPE
+from node_cli.core.node import backup, get_node_info, get_node_signature
+from node_cli.mirage.mirage_node import cleanup as mirage_cleanup
+from node_cli.mirage.mirage_node import request_repair, restore_mirage
+from node_cli.utils.helper import URL_TYPE, abort_if_false, error_exit, streamed_cmd
 from node_cli.utils.texts import safe_load_texts
 
 TEXTS = safe_load_texts()
@@ -116,3 +117,16 @@ def restore_node(backup_path, env_file, config_only):
 )
 def repair(snapshot_from: str = '') -> None:
     request_repair(snapshot_from=snapshot_from)
+
+
+@node.command('cleanup', help='Cleanup Mirage node.')
+@click.option(
+    '--yes',
+    is_flag=True,
+    callback=abort_if_false,
+    expose_value=False,
+    prompt='Are you sure you want to cleanup Mirage node?',
+)
+@streamed_cmd
+def cleanup_node():
+    mirage_cleanup()

node_cli/core/docker_config.py

@@ -1,5 +1,5 @@
-import grp
 import enum
+import grp
 import json
 import logging
 import os
@@ -8,19 +8,17 @@
 import typing
 from typing import Optional, Tuple
 
-
 from node_cli.configs import (
-    DOCKER_DEAMON_CONFIG_PATH,
     DOCKER_DAEMON_HOSTS,
+    DOCKER_DEAMON_CONFIG_PATH,
     DOCKER_SERVICE_CONFIG_DIR,
     DOCKER_SERVICE_CONFIG_PATH,
     DOCKER_SOCKET_PATH,
     NODE_DOCKER_CONFIG_PATH,
     SKALE_RUN_DIR,
 )
-from node_cli.utils.helper import run_cmd
 from node_cli.utils.docker_utils import docker_client, get_containers
-
+from node_cli.utils.helper import run_cmd
 
 logger = logging.getLogger(__name__)
 
@@ -184,3 +182,54 @@ def configure_docker() -> None:
     save_docker_group_id(group_id)
 
     logger.info('Docker configuration finished')
+
+
+def remove_docker_service_override_config() -> None:
+    if os.path.isfile(DOCKER_SERVICE_CONFIG_PATH):
+        logger.info('Removing docker service override config')
+        os.remove(DOCKER_SERVICE_CONFIG_PATH)
+
+
+def reset_docker_daemon_config() -> None:
+    if os.path.isfile(DOCKER_DEAMON_CONFIG_PATH):
+        logger.info('Resetting docker daemon config')
+        with open(DOCKER_DEAMON_CONFIG_PATH, 'r') as daemon_config:
+            config = json.load(daemon_config)
+
+        # Remove the keys we added
+        config.pop('live-restore', None)
+        config.pop('hosts', None)
+
+        if config:
+            # Write back remaining config
+            with open(DOCKER_DEAMON_CONFIG_PATH, 'w') as daemon_config:
+                json.dump(config, daemon_config)
+        else:
+            # Remove file if empty
+            os.remove(DOCKER_DEAMON_CONFIG_PATH)
+
+
+def remove_node_docker_config() -> None:
+    if os.path.isfile(NODE_DOCKER_CONFIG_PATH):
+        logger.info('Removing node docker config')
+        os.remove(NODE_DOCKER_CONFIG_PATH)
+
+
+def remove_skale_run_dir() -> None:
+    if os.path.isdir(SKALE_RUN_DIR):
+        os.rmdir(SKALE_RUN_DIR)
+        logger.info('Removed SKALE run directory')
+
+
+def cleanup_docker_configuration() -> None:
+    """Cleanup all skale specific docker configuration files and directories"""
+    logger.info('Cleaning up docker configuration')
+
+    remove_docker_service_override_config()
+    reset_docker_daemon_config()
+    remove_node_docker_config()
+    remove_skale_run_dir()
+    restart_docker_service()
+    wait_for_socket_initialization()
+
+    logger.info('Docker configuration cleanup finished')

node_cli/core/schains.py

@@ -58,6 +58,12 @@
 BLUEPRINT_NAME = 'schains'
 
 
+class NoDataDirForChainError(Exception):
+    """Raised when no data directory is found"""
+
+    pass
+
+
 def get_schain_firewall_rules(schain: str) -> None:
     status, payload = get_request(
         blueprint=BLUEPRINT_NAME, method='firewall-rules', params={'schain_name': schain}
@@ -249,8 +255,17 @@ def ensure_schain_volume(schain: str, schain_type: str, env_type: str) -> None:
         logger.warning('Volume %s already exists', schain)
 
 
-def cleanup_sync_datadir(schain_name: str, base_path: str = SCHAINS_MNT_DIR_SINGLE_CHAIN) -> None:
-    base_path = os.path.join(base_path, schain_name)
+def cleanup_datadir_for_single_chain_node(
+    chain_name: str = '', base_path: str = SCHAINS_MNT_DIR_SINGLE_CHAIN
+) -> None:
+    if not chain_name:
+        folders = [f for f in os.listdir(base_path) if os.path.isdir(os.path.join(base_path, f))]
+        if not folders:
+            raise NoDataDirForChainError(
+                f'No data directory found in {base_path}. Please check the path or specify a chain name.'
+            )
+        chain_name = folders[0]
+    base_path = os.path.join(base_path, chain_name)
     regular_folders_pattern = f'{base_path}/[!snapshots]*'
     logger.info('Removing regular folders')
     for filepath in glob.glob(regular_folders_pattern):

node_cli/mirage/mirage_node.py

@@ -21,20 +21,23 @@
 import logging
 import time
 
-from node_cli.configs import SKALE_DIR, RESTORE_SLEEP_TIMEOUT
+from node_cli.configs import RESTORE_SLEEP_TIMEOUT, SKALE_DIR
 from node_cli.configs.env import SKALE_DIR_ENV_FILEPATH
-from node_cli.core.node import compose_node_env
+from node_cli.core.docker_config import cleanup_docker_configuration
 from node_cli.core.host import save_env_params
+from node_cli.core.node import compose_node_env
 from node_cli.core.static_config import get_static_params
 from node_cli.mirage.record.chain_record import ChainRecord
-from node_cli.operations import restore_mirage_op
-from node_cli.utils.decorators import check_inited, check_not_inited
+from node_cli.operations import (
+    cleanup_mirage_op,
+    restore_mirage_op,
+)
+from node_cli.utils.decorators import check_inited, check_not_inited, check_user
 from node_cli.utils.exit_codes import CLIExitCodes
 from node_cli.utils.helper import error_exit
 from node_cli.utils.node_type import NodeType
 from node_cli.utils.texts import safe_load_texts
 
-
 logger = logging.getLogger(__name__)
 TEXTS = safe_load_texts()
 
@@ -64,3 +67,13 @@ def request_repair(snapshot_from: str = '') -> None:
     record.set_snapshot_from(snapshot_from)
 
     print(TEXTS['mirage']['node']['repair']['repair_requested'])
+
+
+@check_inited
+@check_user
+def cleanup() -> None:
+    env = compose_node_env(SKALE_DIR_ENV_FILEPATH, save=False, node_type=NodeType.MIRAGE)
+    chain_name = env['SCHAIN_NAME']
+    cleanup_mirage_op(env, chain_name)
+    logger.info('Mirage node was cleaned up, all containers and data removed')
+    cleanup_docker_configuration()

node_cli/operations/__init__.py

@@ -32,3 +32,9 @@
     cleanup_sync as cleanup_sync_op,
     configure_nftables,
 )
+from node_cli.operations.mirage import (  # noqa
+    update_mirage as update_mirage_op,
+    MirageUpdateType,
+    restore_mirage as restore_mirage_op,
+    cleanup as cleanup_mirage_op,
+)

node_cli/operations/base.py

@@ -17,20 +17,22 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-import time
-
-import distro
 import functools
 import logging
+import time
 from typing import Dict, Optional
 
+import distro
+
+from node_cli.cli.info import TYPE, VERSION
 from node_cli.configs import (
     CONTAINER_CONFIG_PATH,
     CONTAINER_CONFIG_TMP_PATH,
-    SKALE_DIR,
     GLOBAL_SKALE_DIR,
+    SKALE_DIR,
 )
-from node_cli.core.checks import CheckType, run_checks as run_host_checks
+from node_cli.core.checks import CheckType
+from node_cli.core.checks import run_checks as run_host_checks
 from node_cli.core.docker_config import configure_docker
 from node_cli.core.host import (
     ensure_btrfs_kernel_module_autoloaded,
@@ -40,19 +42,19 @@
 from node_cli.core.nftables import configure_nftables
 from node_cli.core.nginx import generate_nginx_config
 from node_cli.core.node_options import NodeOptions
-from node_cli.core.resources import update_resource_allocation, init_shared_space_volume
+from node_cli.core.resources import init_shared_space_volume, update_resource_allocation
 from node_cli.core.schains import (
+    cleanup_datadir_for_single_chain_node,
     update_node_cli_schain_status,
-    cleanup_sync_datadir,
 )
-from node_cli.cli.info import VERSION, TYPE
 from node_cli.operations.common import configure_filebeat, configure_flask, unpack_backup_archive
 from node_cli.operations.docker_lvmpy import lvmpy_install
 from node_cli.operations.skale_node import (
     download_skale_node,
     sync_skale_node,
     update_images,
 )
+from node_cli.operations.docker_lvmpy import lvmpy_install
 from node_cli.operations.volume import (
     cleanup_volume_artifacts,
     ensure_filestorage_mapping,
@@ -64,12 +66,16 @@
     docker_cleanup,
     remove_dynamic_containers,
 )
+<<<<<<< Updated upstream
 from node_cli.utils.helper import str_to_bool, rm_dir
 from node_cli.utils.meta import get_meta_info, update_meta
+=======
+from node_cli.utils.helper import rm_dir, str_to_bool
+from node_cli.utils.meta import CliMetaManager, MirageCliMetaManager
+>>>>>>> Stashed changes
 from node_cli.utils.node_type import NodeType
 from node_cli.utils.print_formatters import print_failed_requirements_checks
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -508,6 +514,6 @@ def restore_mirage(env, backup_path, config_only=False):
 
 def cleanup_sync(env, schain_name: str) -> None:
     turn_off(env, node_type=NodeType.SYNC)
-    cleanup_sync_datadir(schain_name=schain_name)
+    cleanup_datadir_for_single_chain_node(schain_name=schain_name)
     rm_dir(GLOBAL_SKALE_DIR)
     rm_dir(SKALE_DIR)

node_cli/operations/common.py

@@ -17,19 +17,18 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+import logging
 import os
+import secrets
+import shutil
 import stat
 import tarfile
-import logging
-import shutil
-import secrets
-
 from shutil import copyfile
 
 from node_cli.configs import (
-    G_CONF_HOME,
     FILEBEAT_CONFIG_PATH,
     FLASK_SECRET_KEY_FILE,
+    G_CONF_HOME,
     SRC_FILEBEAT_CONFIG_PATH,
 )