vantage6 5.0.0a35__py3-none-any.whl → 5.0.0a37__py3-none-any.whl

vantage6/cli/dev/rebuild.py

@@ -0,0 +1,39 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+@click.option("--only-server", is_flag=True, help="Rebuild the server image.")
+@click.option("--only-node", is_flag=True, help="Rebuild the node image.")
+@click.option("--only-store", is_flag=True, help="Rebuild the store image.")
+@click.option("--only-ui", is_flag=True, help="Rebuild the ui image.")
+def cli_rebuild_dev_env(
+    only_server: bool, only_node: bool, only_store: bool, only_ui: bool
+):
+    """Rebuild Docker images for your development environment."""
+    check_devspace_installed()
+
+    try:
+        info("🔄 Rebuilding development environment with devspace...")
+        cmd = ["devspace", "run", "rebuild"]
+
+        if only_server:
+            cmd.append("--server")
+        if only_node:
+            cmd.append("--node")
+        if only_store:
+            cmd.append("--store")
+        if only_ui:
+            cmd.append("--ui")
+
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment rebuilt successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error rebuilding development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/dev/start.py

@@ -0,0 +1,36 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_start_dev_env():
+    """Start the development environment using devspace."""
+    check_devspace_installed()
+
+    try:
+        info("🚀 Starting development environment with devspace...")
+
+        # Build the devspace command
+        cmd = ["devspace", "run", "start-dev"]
+
+        # Run the devspace command
+        result = subprocess.run(cmd, check=True, capture_output=False)
+
+        if result.returncode == 0:
+            info("✅ Development environment started successfully!")
+        else:
+            error("❌ Failed to start development environment.")
+            sys.exit(result.returncode)
+
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error running devspace: {e}")
+        sys.exit(e.returncode)
+    except Exception as e:
+        error(f"❌ Unexpected error: {e}")
+        sys.exit(1)

vantage6/cli/dev/stop.py

@@ -0,0 +1,23 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_stop_dev_env():
+    """Stop the development environment."""
+    check_devspace_installed()
+
+    try:
+        info("🛑 Stopping development environment with devspace...")
+        cmd = ["devspace", "run", "stop-dev"]
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment stopped successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error stopping development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/globals.py

@@ -56,11 +56,12 @@ DEFAULT_PROMETHEUS_IMAGE = "prom/prometheus"
 PROMETHEUS_CONFIG = "prometheus.yml"
 PROMETHEUS_DIR = "prometheus"
 
-# template folder
+# template configuration files
 TEMPLATE_FOLDER = PACKAGE_FOLDER / APPNAME / "cli" / "template"
 SERVER_TEMPLATE_FILE = "server_config.j2"
 NODE_TEMPLATE_FILE = "node_config.j2"
 ALGO_STORE_TEMPLATE_FILE = "algo_store_config.j2"
+AUTH_TEMPLATE_FILE = "auth_config.j2"
 
 
 # datasets included in the nodes of the dev network
@@ -95,8 +96,10 @@ class CLICommandName(StrEnumBase):
     NODE = "node"
     ALGORITHM = "algorithm"
     TEST = "test"
+    SANDBOX = "sandbox"
     DEV = "dev"
     USE = "use"
+    AUTH = "auth"
 
 
 class InfraComponentName(StrEnumBase):
@@ -105,3 +108,4 @@ class InfraComponentName(StrEnumBase):
     SERVER = "server"
     ALGORITHM_STORE = "store"
     NODE = "node"
+    AUTH = "auth"

vantage6/cli/node/common/__init__.py

@@ -8,11 +8,16 @@ import docker
 from colorama import Fore, Style
 
 from vantage6.common import debug, error, info
-from vantage6.common.globals import APPNAME, InstanceType, RequiredNodeEnvVars
+from vantage6.common.globals import (
+    APPNAME,
+    HTTP_LOCALHOST,
+    InstanceType,
+    RequiredNodeEnvVars,
+)
 
 from vantage6.client import UserClient
 
-from vantage6.cli.configuration_wizard import select_configuration_questionaire
+from vantage6.cli.configuration_create import select_configuration_questionnaire
 from vantage6.cli.context.node import NodeContext
 
 
@@ -33,7 +38,7 @@ def create_client(ctx: NodeContext) -> UserClient:
     # if the server is run locally, we need to use localhost here instead of
     # the host address of docker
     if host in ["http://host.docker.internal", "http://172.17.0.1"]:
-        host = "http://localhost"
+        host = HTTP_LOCALHOST
     port = ctx.config["port"]
     api_path = ctx.config["api_path"]
     info(f"Connecting to server at '{host}:{port}{api_path}'")
@@ -64,26 +69,37 @@ def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
         client.authenticate()
     except Exception as exc:
         error("Could not authenticate with server!")
-        debug(exc)
+        debug(str(exc))
         exit(1)
 
     return client
 
 
-def select_node(name: str, system_folders: bool) -> tuple[str, str]:
+def select_node(name: str, system_folders: bool) -> str:
     """
     Let user select node through questionnaire if name is not given.
 
+    Parameters
+    ----------
+    name : str
+        Name of the node to select
+    system_folders : bool
+        Whether to use system folders or not
+
     Returns
     -------
     str
         Name of the configuration file
     """
-    name = (
-        name
-        if name
-        else select_configuration_questionaire(InstanceType.NODE, system_folders)
-    )
+    try:
+        name = (
+            name
+            if name
+            else select_configuration_questionnaire(InstanceType.NODE, system_folders)
+        )
+    except Exception:
+        error("No configurations could be found!")
+        exit()
 
     # raise error if config could not be found
     if not NodeContext.config_exists(name, system_folders):

vantage6/cli/node/list.py

@@ -3,8 +3,9 @@ import docker
 from colorama import Fore, Style
 
 from vantage6.common import warning
-from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import check_docker_running
+from vantage6.common.globals import APPNAME
+
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.node.common import find_running_node_names
 
@@ -39,7 +40,7 @@ def cli_node_list() -> None:
             if f"{APPNAME}-{config.name}-system" in running_node_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25}System ")
+        click.echo(f"{config.name:25}{status:25}System ")
 
     # user folders
     configs, f2 = NodeContext.available_configurations(system_folders=False)
@@ -49,8 +50,8 @@ def cli_node_list() -> None:
             if f"{APPNAME}-{config.name}-user" in running_node_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25}User   ")
+        click.echo(f"{config.name:25}{status:25}User   ")
 
     click.echo("-" * 53)
     if len(f1) + len(f2):
-        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+        warning(f"{Fore.RED}Failed imports: {len(f1) + len(f2)}{Style.RESET_ALL}")

vantage6/cli/node/new.py

@@ -6,8 +6,10 @@ import questionary as q
 
 from vantage6.common import error, info, warning
 from vantage6.common.client.node_client import NodeClient
+from vantage6.common.context import AppContext
 from vantage6.common.globals import (
     FILE_BASED_DATABASE_TYPES,
+    HTTP_LOCALHOST,
     SERVICE_BASED_DATABASE_TYPES,
     InstanceType,
     NodePolicy,
@@ -17,6 +19,7 @@ from vantage6.common.globals import (
 
 from vantage6.cli.common.new import new
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+from vantage6.cli.utils import prompt_config_name
 
 
 @click.command()
@@ -52,8 +55,12 @@ def cli_node_new_configuration(
     Checks if the configuration already exists. If this is not the case
     a questionnaire is invoked to create a new configuration file.
     """
+    name = prompt_config_name(name)
+    dirs = AppContext.instance_folders(InstanceType.NODE, name, system_folders)
+    default_data_dir = str(dirs["data"])
     new(
-        questionnaire_function=node_configuration_questionaire,
+        config_producing_func=node_configuration_questionaire,
+        config_producing_func_args=(default_data_dir, name),
         name=name,
         system_folders=system_folders,
         namespace=namespace,
@@ -62,14 +69,14 @@ def cli_node_new_configuration(
     )
 
 
-def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
+def node_configuration_questionaire(data_dir: str, instance_name: str) -> dict:
     """
     Questionary to generate a config file for the node instance.
 
     Parameters
     ----------
-    dirs : dict
-        Dictionary with the directories of the node instance.
+    data_dir : str
+        Path to the data directory of the node instance.
     instance_name : str
         Name of the node instance.
 
@@ -85,7 +92,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
                 "type": "text",
                 "name": "server_url",
                 "message": "The base-URL of the server:",
-                "default": "http://localhost",
+                "default": HTTP_LOCALHOST,
             },
         ]
     )
@@ -117,7 +124,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
                 "type": "text",
                 "name": "task_dir",
                 "message": "Task directory path:",
-                "default": str(dirs["data"]),
+                "default": data_dir,
             },
         ]
     )

vantage6/cli/node/set_api_key.py

@@ -3,7 +3,7 @@ import questionary as q
 
 from vantage6.common import ensure_config_dir_writable, error, info
 
-from vantage6.cli.configuration_wizard import NodeConfigurationManager
+from vantage6.cli.configuration_create import NodeConfigurationManager
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.node.common import select_node

vantage6/cli/node/start.py

@@ -12,6 +12,7 @@ from vantage6.cli.common.start import (
 from vantage6.cli.common.utils import (
     attach_logs,
     create_directory_if_not_exists,
+    select_context_and_namespace,
 )
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import ChartName
@@ -27,7 +28,14 @@ from vantage6.node.globals import DEFAULT_PROXY_SERVER_PORT
     default=False,
     help="Show node logs on the current console after starting the node",
 )
-@click_insert_context(InstanceType.NODE, include_name=True, include_system_folders=True)
+@click.option("--local-chart-dir", default=None, help="Local chart directory to use")
+@click.option("--sandbox/--no-sandbox", "sandbox", default=False)
+@click_insert_context(
+    InstanceType.NODE,
+    include_name=True,
+    include_system_folders=True,
+    sandbox_param="sandbox",
+)
 def cli_node_start(
     ctx: NodeContext,
     name: str,
@@ -35,13 +43,19 @@ def cli_node_start(
     context: str,
     namespace: str,
     attach: bool,
+    local_chart_dir: str,
 ) -> None:
     """
     Start the node.
     """
     info("Starting node...")
 
-    prestart_checks(ctx, InstanceType.NODE, name, system_folders, context, namespace)
+    prestart_checks(ctx, InstanceType.NODE, name, system_folders)
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
 
     create_directory_if_not_exists(ctx.log_dir)
     create_directory_if_not_exists(ctx.data_dir)
@@ -96,13 +110,14 @@ def cli_node_start(
         values_file=ctx.config_file,
         context=context,
         namespace=namespace,
+        local_chart_dir=local_chart_dir,
     )
 
     # start port forward for the node proxy server
     start_port_forward(
         service_name=f"{ctx.helm_release_name}-node-service",
-        service_port=ctx.config["node"].get("port", DEFAULT_PROXY_SERVER_PORT),
-        port=ctx.config["node"].get("port", DEFAULT_PROXY_SERVER_PORT),
+        service_port=ctx.config["node"].get("proxyPort", DEFAULT_PROXY_SERVER_PORT),
+        port=ctx.config["node"].get("proxyPort", DEFAULT_PROXY_SERVER_PORT),
         context=context,
         namespace=namespace,
     )

vantage6/cli/node/stop.py

@@ -1,13 +1,20 @@
 import click
+from kubernetes import client as k8s_client, config as k8s_config
+from kubernetes.client import ApiException
+from kubernetes.config.config_exception import ConfigException
 
-from vantage6.common import info
-from vantage6.common.globals import InstanceType
+from vantage6.common import error, info, warning
+from vantage6.common.globals import APPNAME, InstanceType
 
 from vantage6.cli.common.stop import execute_stop, helm_uninstall, stop_port_forward
+from vantage6.cli.common.utils import get_config_name_from_helm_release_name
+from vantage6.cli.context import get_context
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import (
     DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL,
     InfraComponentName,
 )
+from vantage6.cli.node.task_cleanup import delete_job_related_pods
 
 
 @click.command()
@@ -29,18 +36,23 @@ from vantage6.cli.globals import (
     "system folders. This is the default.",
 )
 @click.option("--all", "all_nodes", flag_value=True, help="Stop all running nodes")
+@click.option(
+    "--sandbox", "is_sandbox", flag_value=True, help="Stop a sandbox environment"
+)
 def cli_node_stop(
     name: str,
     context: str,
     namespace: str,
     system_folders: bool,
     all_nodes: bool,
+    is_sandbox: bool,
 ) -> None:
     """
     Stop one or all running nodes.
     """
     execute_stop(
         stop_function=_stop_node,
+        stop_function_args={"system_folders": system_folders, "is_sandbox": is_sandbox},
         instance_type=InstanceType.NODE,
         infra_component=InfraComponentName.NODE,
         stop_all=all_nodes,
@@ -48,24 +60,158 @@ def cli_node_stop(
         namespace=namespace,
         context=context,
         system_folders=system_folders,
+        is_sandbox=is_sandbox,
     )
 
 
-def _stop_node(node_name: str, namespace: str, context: str) -> None:
+def _stop_node(
+    node_helm_name: str,
+    namespace: str,
+    context: str,
+    system_folders: bool,
+    is_sandbox: bool,
+) -> None:
     """
     Stop a node
 
     Parameters
     ----------
-    node_name : str
+    node_helm_name : str
         Name of the node to stop
     namespace : str
         Kubernetes namespace to use
     context : str
         Kubernetes context to use
+    system_folders: bool
+        Whether to use the system folders or not
+    is_sandbox: bool
+        Whether node is a sandbox node or not
     """
-    helm_uninstall(release_name=node_name, context=context, namespace=namespace)
+    helm_uninstall(release_name=node_helm_name, context=context, namespace=namespace)
+
+    stop_port_forward(service_name=f"{node_helm_name}-node-service")
+
+    _stop_node_tasks(node_helm_name, system_folders, is_sandbox)
+
+    info(f"Node {node_helm_name} stopped successfully.")
+
+
+def _stop_node_tasks(
+    node_helm_name: str, system_folders: bool, is_sandbox: bool
+) -> None:
+    """
+    Stop the tasks of a node
+    """
+    node_name = get_config_name_from_helm_release_name(node_helm_name)
+    node_ctx = get_context(
+        InstanceType.NODE, node_name, system_folders, is_sandbox=is_sandbox
+    )
+
+    task_namespace = node_ctx.config.get("node", {}).get("taskNamespace")
+    if not task_namespace:
+        warning("Could not find node's task namespace. Node tasks will not be stopped.")
+        return
+
+    # detect tasks from the task namespace that this node is assigned to
+    cleanup_task_jobs(task_namespace, node_ctx, all_nodes=False)
+
+
+def cleanup_task_jobs(
+    namespace: str, node_ctx: NodeContext | None = None, all_nodes: bool = False
+) -> bool:
+    """
+    Cleanup Vantage6 task jobs in a given namespace.
+
+    Parameters
+    ----------
+    namespace: str
+        Namespace to cleanup
+    node_ctx: NodeContext | None
+        Node context to cleanup. If not given, all_nodes must be True.
+    all_nodes: bool
+        Cleanup all nodes. If not given, node_name must be given.
+
+    Returns
+    -------
+    bool
+        True if cleanup was successful, False otherwise
+    """
+    info(f"Cleaning up Vantage6 task jobs in namespace '{namespace}'")
+
+    if not all_nodes and not node_ctx:
+        error("Either all_nodes or node_ctx must be given to cleanup task jobs")
+        return False
+
+    # Load Kubernetes configuration (in-cluster first, fallback to kubeconfig)
+    try:
+        k8s_config.load_incluster_config()
+    except ConfigException:
+        try:
+            k8s_config.load_kube_config()
+        except ConfigException as exc:
+            error(f"Failed to load Kubernetes configuration: {exc}")
+            return False
+
+    core_api = k8s_client.CoreV1Api()
+    batch_api = k8s_client.BatchV1Api()
+
+    jobs = _get_jobs(namespace, batch_api)
+
+    deletions = 0
+    for job in jobs:
+        if not all_nodes and job.metadata.labels.get("node_id") != node_ctx.identifier:
+            # if all_nodes is False, we should only delete jobs assigned to the current
+            # node
+            continue
+        elif all_nodes and not _is_vantage6_task_job(job):
+            # if all_nodes is True, we should only delete vantage6 task jobs, not other
+            # jobs
+            continue
+
+        run_id = _get_job_run_id(job)
+        if run_id is None:
+            error(f"Job '{job.metadata.name}' has no run_id annotation, skipping...")
+            continue
+
+        # Use shared cleanup to delete job, pods and related secret
+        job_name = job.metadata.name
+        info(f"Deleting job '{job_name}' (run_id={run_id})")
+        delete_job_related_pods(
+            run_id=run_id,
+            container_name=f"{APPNAME}-run-{run_id}",
+            namespace=namespace,
+            core_api=core_api,
+            batch_api=batch_api,
+        )
+        deletions += 1
+
+    if deletions == 0:
+        info(f"No Vantage6 task jobs found to delete in namespace '{namespace}'")
+    else:
+        info(f"Deleted {deletions} Vantage6 task job(s) in namespace '{namespace}'")
+    return True
+
+
+def _is_vantage6_task_job(job: k8s_client.V1Job) -> bool:
+    # Vantage6 task jobs can be identified by their name, which is of the form
+    # "vantage6-run-<run_id>"
+    return job.metadata.name.startswith(f"{APPNAME}-run-")
+
+
+def _get_jobs(
+    namespace: str, batch_api: k8s_client.BatchV1Api
+) -> list[k8s_client.V1Job]:
+    try:
+        return batch_api.list_namespaced_job(namespace=namespace).items
+    except ApiException as exc:
+        error(f"Failed to list jobs in namespace {namespace}: {exc}")
+        return []
 
-    stop_port_forward(service_name=f"{node_name}-vantage6-node-service")
 
-    info(f"Node {node_name} stopped successfully.")
+def _get_job_run_id(job: k8s_client.V1Job) -> int | None:
+    annotations = job.metadata.annotations or {}
+    try:
+        return int(annotations.get("run_id"))
+    except ValueError:
+        error(f"Job '{job.metadata.name}' has no run_id annotation, skipping")
+        return None