vantage6 5.0.0a37__tar.gz → 5.0.0a38__tar.gz

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vantage6
-Version: 5.0.0a37
+Version: 5.0.0a38
 Summary: vantage6 command line interface
 Author: Vantage6 Team
 Maintainer-email: Frank Martin <f.martin@iknl.nl>, Bart van Beusekom <b.vanbeusekom@iknl.nl>
@@ -18,8 +18,8 @@ Requires-Dist: questionary==2.1.1
 Requires-Dist: rich==13.5.2
 Requires-Dist: schema==0.7.5
 Requires-Dist: sqlalchemy==2.0.37
-Requires-Dist: vantage6-client==5.0.0a37
-Requires-Dist: vantage6-common==5.0.0a37
+Requires-Dist: vantage6-client==5.0.0a38
+Requires-Dist: vantage6-common==5.0.0a38
 Provides-Extra: dev
 Requires-Dist: black; extra == 'dev'
 Requires-Dist: coverage==7.10.2; extra == 'dev'

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vantage6"
-version = "5.0.0a37"
+version = "5.0.0a38"
 description = "vantage6 command line interface"
 readme = "README.md"
 license = {text = "MIT"}
@@ -29,8 +29,8 @@ dependencies = [
     "rich==13.5.2",
     "schema==0.7.5",
     "sqlalchemy==2.0.37",
-    "vantage6-common==5.0.0a37",
-    "vantage6-client==5.0.0a37",
+    "vantage6-common==5.0.0a38",
+    "vantage6-client==5.0.0a38",
 ]
 
 [project.optional-dependencies]

vantage6-5.0.0a38/vantage6/cli/algostore/attach.py

@@ -0,0 +1,39 @@
+import click
+
+from vantage6.common import info
+
+from vantage6.cli.common.attach import attach_logs
+from vantage6.cli.context import InstanceType
+from vantage6.cli.globals import InfraComponentName
+
+
+@click.command()
+@click.option("-n", "--name", default=None, help="Name of the configuration")
+@click.option("--system", "system_folders", flag_value=True, help="Use system folders")
+@click.option("--user", "system_folders", flag_value=False, help="Use user folders")
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "--sandbox", "is_sandbox", flag_value=True, help="Attach to a sandbox environment"
+)
+def cli_algo_store_attach(
+    name: str | None,
+    system_folders: bool,
+    context: str,
+    namespace: str,
+    is_sandbox: bool,
+) -> None:
+    """
+    Show the store logs in the current console.
+    """
+    info("Attaching to store logs...")
+    attach_logs(
+        name,
+        instance_type=InstanceType.ALGORITHM_STORE,
+        infra_component=InfraComponentName.ALGORITHM_STORE,
+        system_folders=system_folders,
+        context=context,
+        namespace=namespace,
+        is_sandbox=is_sandbox,
+        additional_labels="component=store-server",
+    )

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/algostore/list.py

@@ -2,7 +2,7 @@ import click
 
 from vantage6.common.globals import InstanceType
 
-from vantage6.cli.common.utils import get_server_configuration_list
+from vantage6.cli.common.list import get_configuration_list
 
 
 @click.command()
@@ -10,4 +10,4 @@ def cli_algo_store_configuration_list() -> None:
     """
     Print the available server configurations.
     """
-    get_server_configuration_list(InstanceType.ALGORITHM_STORE)
+    get_configuration_list(InstanceType.ALGORITHM_STORE)

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/algostore/start.py

@@ -6,6 +6,7 @@ from vantage6.common.globals import (
     Ports,
 )
 
+from vantage6.cli.common.attach import attach_logs
 from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.common.start import (
     helm_install,
@@ -13,12 +14,11 @@ from vantage6.cli.common.start import (
     start_port_forward,
 )
 from vantage6.cli.common.utils import (
-    attach_logs,
     create_directory_if_not_exists,
     select_context_and_namespace,
 )
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
-from vantage6.cli.globals import ChartName
+from vantage6.cli.globals import ChartName, InfraComponentName
 
 
 @click.command()
@@ -84,4 +84,12 @@ def cli_algo_store_start(
     )
 
     if attach:
-        attach_logs("app=store", "component=store-server")
+        attach_logs(
+            name,
+            instance_type=InstanceType.ALGORITHM_STORE,
+            infra_component=InfraComponentName.ALGORITHM_STORE,
+            system_folders=system_folders,
+            context=context,
+            namespace=namespace,
+            is_sandbox=ctx.is_sandbox,
+        )

vantage6-5.0.0a38/vantage6/cli/algostore/version.py

@@ -0,0 +1,62 @@
+import click
+import requests
+
+from vantage6.common import error, info
+from vantage6.common.globals import (
+    DEFAULT_API_PATH,
+    HTTP_LOCALHOST,
+    InstanceType,
+    Ports,
+)
+
+from vantage6.cli import __version__
+from vantage6.cli.common.version import get_and_select_ctx
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option("-n", "--name", default=None, help="Configuration name")
+@click.option("--system", "system_folders", flag_value=True)
+@click.option(
+    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
+)
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "--sandbox", "is_sandbox", flag_value=True, help="Is this a sandbox environment?"
+)
+def cli_algo_store_version(
+    name: str, system_folders: bool, context: str, namespace: str, is_sandbox: bool
+) -> None:
+    """
+    Print the version of the vantage6 algorithm store.
+    """
+
+    ctx = get_and_select_ctx(
+        InstanceType.ALGORITHM_STORE,
+        name,
+        system_folders,
+        context,
+        namespace,
+        is_sandbox,
+    )
+    store_config = ctx.config.get("store", {})
+
+    port = store_config.get("port", Ports.DEV_ALGO_STORE.value)
+    api_path = store_config.get("api_path", DEFAULT_API_PATH)
+    if not port:
+        error("No port found in algorithm store configuration.")
+        return
+    if not api_path:
+        error("No API path found in algorithm store configuration.")
+        return
+
+    response = requests.get(f"{HTTP_LOCALHOST}:{port}{api_path}/version")
+    if response.status_code != 200:
+        error("Failed to get algorithm store version.")
+        return
+    algorithm_store_version = response.json().get("version", "")
+
+    info("")
+    info(f"Algorithm store version: {algorithm_store_version}")
+    info(f"CLI version: {__version__}")

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/auth/attach.py

@@ -3,8 +3,8 @@ import click
 from vantage6.common import error, info
 from vantage6.common.globals import InstanceType
 
+from vantage6.cli.common.attach import attach_logs
 from vantage6.cli.common.utils import (
-    attach_logs,
     find_running_service_names,
     select_context_and_namespace,
     select_running_service,

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/auth/list.py

@@ -2,7 +2,7 @@ import click
 
 from vantage6.common.globals import InstanceType
 
-from vantage6.cli.common.utils import get_server_configuration_list
+from vantage6.cli.common.list import get_configuration_list
 
 
 @click.command()
@@ -10,4 +10,4 @@ def cli_auth_configuration_list() -> None:
     """
     Print the available auth configurations.
     """
-    get_server_configuration_list(InstanceType.AUTH)
+    get_configuration_list(InstanceType.AUTH)

vantage6-5.0.0a38/vantage6/cli/auth/remove.py

@@ -0,0 +1,89 @@
+import click
+
+from vantage6.common import info, warning
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.common.remove import execute_remove
+from vantage6.cli.context.auth import AuthContext
+from vantage6.cli.globals import InfraComponentName
+from vantage6.cli.utils_kubernetes import get_core_api_with_ssl_handling
+
+
+@click.command()
+@click_insert_context(
+    type_=InstanceType.AUTH, include_name=True, include_system_folders=True
+)
+@click.option("-f", "--force", "force", flag_value=True)
+def cli_auth_remove(
+    ctx: AuthContext, name: str, system_folders: bool, force: bool
+) -> None:
+    """
+    Function to remove a server.
+
+    Parameters
+    ----------
+    ctx : ServerContext
+        Server context object
+    name : str
+        Name of the auth server
+    system_folders : bool
+        Whether to use system folders or user folders
+    force : bool
+        Whether to ask for confirmation before removing or not
+    """
+    auth_remove(ctx, name, system_folders, force)
+
+
+# this new function is just here so that it can be called from the sandbox remove
+# command
+def auth_remove(ctx: AuthContext, name: str, system_folders: bool, force: bool) -> None:
+    # Best-effort cleanup of Keycloak PVCs and their bound PVs after uninstall
+    try:
+        _cleanup_auth_volumes(ctx)
+    except Exception as e:
+        # Cleanup is best-effort; do not fail the remove command if cleanup fails
+        warning(f"Failed to cleanup auth volumes: {e}")
+
+    execute_remove(
+        ctx, InstanceType.AUTH, InfraComponentName.AUTH, name, system_folders, force
+    )
+
+
+def _cleanup_auth_volumes(ctx: AuthContext) -> None:
+    core_api = get_core_api_with_ssl_handling()
+
+    # Label used by the auth chart to tag its resources
+    label_selector = f"app.kubernetes.io/instance={ctx.helm_release_name}"
+
+    # Collect PVCs across all namespaces that belong to this release
+    pvcs = core_api.list_persistent_volume_claim_for_all_namespaces(
+        label_selector=label_selector
+    ).items
+
+    # Track PV names bound to these PVCs
+    pv_names = {
+        pvc.spec.volume_name for pvc in pvcs if pvc.spec and pvc.spec.volume_name
+    }
+
+    # Delete PVCs first (namespaced)
+    for pvc in pvcs:
+        ns = pvc.metadata.namespace
+        name_ = pvc.metadata.name
+        try:
+            info(f"Deleting persistent volume claim {name_} in namespace {ns}")
+            core_api.delete_namespaced_persistent_volume_claim(name=name_, namespace=ns)
+        except Exception as e:
+            # Ignore failures; continue attempting other deletions
+            warning(
+                f"Failed to delete persistent volume claim {name_} in namespace {ns}: "
+                f"{e}"
+            )
+
+    # Delete PVs that were bound to those PVCs (cluster-scoped)
+    for pv_name in pv_names:
+        try:
+            info(f"Deleting persistent volume: {pv_name}")
+            core_api.delete_persistent_volume(name=pv_name)
+        except Exception as e:
+            warning(f"Failed to delete persistent volume {pv_name}: {e}")

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/auth/start.py

@@ -1,6 +1,6 @@
 import click
 
-from vantage6.common import info
+from vantage6.common import info, warning
 from vantage6.common.globals import InstanceType, Ports
 
 from vantage6.cli.common.decorator import click_insert_context
@@ -9,10 +9,7 @@ from vantage6.cli.common.start import (
     prestart_checks,
     start_port_forward,
 )
-from vantage6.cli.common.utils import (
-    attach_logs,
-    select_context_and_namespace,
-)
+from vantage6.cli.common.utils import select_context_and_namespace
 from vantage6.cli.context.auth import AuthContext
 from vantage6.cli.globals import ChartName
 
@@ -89,6 +86,13 @@ def cli_auth_start(
     )
 
     if attach:
-        attach_logs(
-            [f"app.kubernetes.io/instance={ctx.helm_release_name}"],
-        )
+        warning("Attaching to auth logs is not supported yet.")
+        # attach_logs(
+        #     name,
+        #     instance_type=InstanceType.AUTH,
+        #     infra_component=InfraComponentName.AUTH,
+        #     system_folders=system_folders,
+        #     context=context,
+        #     namespace=namespace,
+        #     is_sandbox=ctx.is_sandbox,
+        # )

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/cli.py

@@ -12,6 +12,7 @@ from vantage6.cli.algostore.new import cli_algo_store_new
 from vantage6.cli.algostore.remove import cli_algo_store_remove
 from vantage6.cli.algostore.start import cli_algo_store_start
 from vantage6.cli.algostore.stop import cli_algo_store_stop
+from vantage6.cli.algostore.version import cli_algo_store_version
 from vantage6.cli.auth.attach import cli_auth_attach
 from vantage6.cli.auth.files import cli_auth_files
 from vantage6.cli.auth.list import cli_auth_configuration_list
@@ -175,6 +176,7 @@ cli_algo_store.add_command(cli_algo_store_stop, name="stop")
 cli_algo_store.add_command(cli_algo_store_files, name="files")
 cli_algo_store.add_command(cli_algo_store_configuration_list, name="list")
 cli_algo_store.add_command(cli_algo_store_remove, name="remove")
+cli_algo_store.add_command(cli_algo_store_version, name="version")
 
 
 # Define the auth group

vantage6-5.0.0a38/vantage6/cli/common/attach.py

@@ -0,0 +1,114 @@
+from subprocess import Popen
+
+from vantage6.common import Fore, Style, error
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import (
+    extract_name_and_is_sandbox,
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+from vantage6.cli.context import get_context
+from vantage6.cli.globals import InfraComponentName
+
+
+def attach_logs(
+    name: str | None,
+    instance_type: InstanceType,
+    infra_component: InfraComponentName,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+    is_sandbox: bool = False,
+    additional_labels: str | None = None,
+) -> None:
+    """
+    Attach to the logs of the given labels.
+
+    Parameters
+    ----------
+    name : str | None
+        The name of the service to attach to. If None, the user will be asked to
+        select a service.
+    instance_type : InstanceType
+        The instance type of the service.
+    infra_component : InfraComponentName
+        The infra component of the service.
+    system_folders : bool
+        Whether to use system folders.
+    context : str
+        The context of the service.
+    namespace : str
+        The namespace of the service.
+    is_sandbox : bool
+        Whether the configuration is a sandbox configuration, by default False
+    additional_labels : str | None
+        Additional labels to filter the logs by.
+    """
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+    running_services = find_running_service_names(
+        instance_type=instance_type,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_services:
+        error(f"No running {infra_component.value}s found.")
+        return
+
+    if not name:
+        helm_name = select_running_service(running_services, instance_type)
+    else:
+        name, is_sandbox = extract_name_and_is_sandbox(name, is_sandbox)
+        ctx = get_context(instance_type, name, system_folders, is_sandbox=is_sandbox)
+        helm_name = ctx.helm_release_name
+
+    if helm_name in running_services:
+        _attach_logs(helm_name, namespace, context, additional_labels)
+    else:
+        error(f"{Fore.RED}{helm_name}{Style.RESET_ALL} is not running?!")
+
+
+def _attach_logs(
+    service: str, namespace: str, context: str, additional_labels: str | None = None
+) -> None:
+    """
+    Attach to the logs of the given service.
+
+    Parameters
+    ----------
+    service : str
+        The name of the service to attach to.
+    namespace : str
+        The namespace of the service.
+    context : str
+        The context of the service.
+    additional_labels : str | None
+        Additional labels to filter the logs by.
+    """
+    labels = f"release={service}"
+    if additional_labels:
+        labels += f",{additional_labels}"
+    # Stream logs from all pods that belong to this Helm release, within the
+    # provided namespace and context. Using label selection ensures we attach
+    # to pods rather than higher-level resources.
+    command = [
+        "kubectl",
+        "--context",
+        context,
+        "-n",
+        namespace,
+        "logs",
+        "--follow",
+        "--selector",
+        labels,
+        "--all-containers=true",
+    ]
+    process = Popen(command, stdout=None, stderr=None)
+    process.wait()

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/common/decorator.py

@@ -4,8 +4,9 @@ from pathlib import Path
 import click
 
 from vantage6.common import error
-from vantage6.common.globals import SANDBOX_SUFFIX, InstanceType
+from vantage6.common.globals import InstanceType
 
+from vantage6.cli.common.utils import extract_name_and_is_sandbox
 from vantage6.cli.configuration_create import select_configuration_questionnaire
 from vantage6.cli.context import get_context, select_context_class
 
@@ -88,8 +89,9 @@ def click_insert_context(
             if sandbox_param is not None:
                 # Pop to avoid passing unknown kwarg to the wrapped function
                 runtime_is_sandbox = bool(kwargs.pop(sandbox_param, False))
-            if runtime_is_sandbox and name and name.endswith(SANDBOX_SUFFIX):
-                name = name[: -len(SANDBOX_SUFFIX)]
+            name, runtime_is_sandbox = extract_name_and_is_sandbox(
+                name, runtime_is_sandbox
+            )
 
             # path to configuration file always overrides name
             if config:

vantage6-5.0.0a38/vantage6/cli/common/list.py

@@ -0,0 +1,68 @@
+import click
+from colorama import Fore, Style
+
+from vantage6.common import warning
+from vantage6.common.globals import (
+    APPNAME,
+    SANDBOX_SUFFIX,
+    InstanceType,
+)
+
+from vantage6.cli.common.utils import find_running_service_names
+from vantage6.cli.context import select_context_class
+
+
+def get_configuration_list(instance_type: InstanceType) -> None:
+    """
+    Print list of available server configurations.
+
+    Parameters
+    ----------
+    instance_type : InstanceType
+        The type of instance to get the configurations for
+    """
+    ctx_class = select_context_class(instance_type)
+
+    running_server_names = find_running_service_names(instance_type)
+    header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
+
+    click.echo(header)
+    click.echo("-" * len(header))
+
+    running = Fore.GREEN + "Running" + Style.RESET_ALL
+    stopped = Fore.RED + "Not running" + Style.RESET_ALL
+
+    # system folders
+    configs, failed_imports_system = ctx_class.available_configurations(
+        system_folders=True
+    )
+    for config in configs:
+        config.name = config.name.replace(SANDBOX_SUFFIX, "")
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-system-{instance_type.value}"
+            in running_server_names
+            else stopped
+        )
+        click.echo(f"{config.name:25}{status:25} System ")
+
+    # user folders
+    configs, failed_imports_user = ctx_class.available_configurations(
+        system_folders=False
+    )
+    for config in configs:
+        config.name = config.name.replace(SANDBOX_SUFFIX, "")
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-user-{instance_type.value}"
+            in running_server_names
+            else stopped
+        )
+        click.echo(f"{config.name:25}{status:25} User   ")
+
+    click.echo("-" * 85)
+    if len(failed_imports_system) + len(failed_imports_user):
+        warning(
+            f"{Fore.RED}Failed imports: "
+            f"{len(failed_imports_system) + len(failed_imports_user)}{Style.RESET_ALL}"
+        )

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/common/remove.py

@@ -24,6 +24,24 @@ def execute_remove(
     system_folders: bool,
     force: bool,
 ) -> None:
+    """
+    Function to remove a vantage6 service instance.
+
+    Parameters
+    ----------
+    ctx : AppContext
+        App context object
+    instance_type : InstanceType
+        Type of instance that is checked
+    infra_component : InfraComponentName
+        The infra component of the service
+    name : str
+        Name of the instance
+    system_folders : bool
+        Whether to use system folders or user folders
+    force : bool
+        Whether to ask for confirmation before removing or not
+    """
     if check_running(ctx.helm_release_name, instance_type, name, system_folders):
         error(
             f"The {infra_component.value} {name} is still running! Please stop the "

{vantage6-5.0.0a37 → vantage6-5.0.0a38}/vantage6/cli/common/stop.py

@@ -5,9 +5,10 @@ import subprocess
 from colorama import Fore, Style
 
 from vantage6.common import error, info, warning
-from vantage6.common.globals import SANDBOX_SUFFIX, InstanceType
+from vantage6.common.globals import InstanceType
 
 from vantage6.cli.common.utils import (
+    extract_name_and_is_sandbox,
     find_running_service_names,
     select_context_and_namespace,
     select_running_service,
@@ -81,14 +82,7 @@ def execute_stop(
         if not to_stop:
             helm_name = select_running_service(running_services, instance_type)
         else:
-            if to_stop.endswith(SANDBOX_SUFFIX):
-                to_stop = to_stop[: -len(SANDBOX_SUFFIX)]
-                is_sandbox = True
-            elif is_sandbox:
-                warning(
-                    "Sandbox configuration detected, but no sandbox suffix found. "
-                    "This may lead to issues."
-                )
+            to_stop, is_sandbox = extract_name_and_is_sandbox(to_stop, is_sandbox)
             ctx = get_context(
                 instance_type, to_stop, system_folders, is_sandbox=is_sandbox
             )