vantage6 5.0.0a36__py3-none-any.whl → 5.0.0a38__py3-none-any.whl

vantage6/cli/algorithm/generate_algorithm_json.py

@@ -215,7 +215,6 @@ class Function:
                 "display_name": self._pretty_print_name(name),
                 "description": self._extract_parameter_description(name),
                 "type": type_.value if type_ else None,
-                "required": param.default == inspect.Parameter.empty,
                 "has_default_value": param.default != inspect.Parameter.empty,
                 "is_frontend_only": False,
             }

vantage6/cli/algostore/attach.py

@@ -2,13 +2,38 @@ import click
 
 from vantage6.common import info
 
-from vantage6.cli.common.utils import attach_logs
+from vantage6.cli.common.attach import attach_logs
+from vantage6.cli.context import InstanceType
+from vantage6.cli.globals import InfraComponentName
 
 
 @click.command()
-def cli_algo_store_attach() -> None:
+@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("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=is_sandbox,
+        additional_labels="component=store-server",
+    )

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/cli/algostore/new.py

@@ -8,7 +8,7 @@ from vantage6.common.globals import (
 )
 
 from vantage6.cli.common.new import new
-from vantage6.cli.configuration_wizard import add_common_server_config
+from vantage6.cli.configuration_create import add_common_server_config
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 
 
@@ -43,7 +43,8 @@ def cli_algo_store_new(
     """
 
     new(
-        questionnaire_function=algo_store_configuration_questionaire,
+        config_producing_func=algo_store_configuration_questionaire,
+        config_producing_func_args=(name,),
         name=name,
         system_folders=system_folders,
         namespace=namespace,

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,11 +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()
@@ -30,8 +31,13 @@ from vantage6.cli.globals import ChartName
     default=False,
     help="Print server logs to the console after start",
 )
+@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.ALGORITHM_STORE, include_name=True, include_system_folders=True
+    InstanceType.ALGORITHM_STORE,
+    include_name=True,
+    include_system_folders=True,
+    sandbox_param="sandbox",
 )
 def cli_algo_store_start(
     ctx: AlgorithmStoreContext,
@@ -42,14 +48,18 @@ def cli_algo_store_start(
     ip: str,
     port: int,
     attach: bool,
+    local_chart_dir: str,
 ) -> None:
     """
     Start the algorithm store.
     """
     info("Starting algorithm store...")
 
-    prestart_checks(
-        ctx, InstanceType.ALGORITHM_STORE, name, system_folders, context, namespace
+    prestart_checks(ctx, InstanceType.ALGORITHM_STORE, name, system_folders)
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
     )
 
     create_directory_if_not_exists(ctx.log_dir)
@@ -60,6 +70,7 @@ def cli_algo_store_start(
         values_file=ctx.config_file,
         context=context,
         namespace=namespace,
+        local_chart_dir=local_chart_dir,
     )
 
     info("Port forwarding for algorithm store")
@@ -73,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/cli/algostore/stop.py

@@ -25,6 +25,7 @@ from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS, InfraComponentNa
     flag_value=False,
     help="Search for configuration in the user folders instead of system folders.",
 )
+@click.option("--sandbox/--no-sandbox", "sandbox", default=False)
 @click.option("--all", "all_stores", flag_value=True, help="Stop all algorithm stores")
 def cli_algo_store_stop(
     name: str,
@@ -32,6 +33,7 @@ def cli_algo_store_stop(
     namespace: str,
     system_folders: bool,
     all_stores: bool,
+    sandbox: bool,
 ):
     """
     Stop one or all running algorithm store(s).
@@ -45,6 +47,7 @@ def cli_algo_store_stop(
         namespace=namespace,
         context=context,
         system_folders=system_folders,
+        is_sandbox=sandbox,
     )
 
 

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/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/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/cli/auth/new.py

@@ -44,7 +44,8 @@ def cli_auth_new(
     Create a new server configuration.
     """
     new(
-        questionnaire_function=auth_configuration_questionaire,
+        config_producing_func=auth_configuration_questionaire,
+        config_producing_func_args=tuple(),
         name=name,
         system_folders=system_folders,
         namespace=namespace,
@@ -53,7 +54,7 @@ def cli_auth_new(
     )
 
 
-def auth_configuration_questionaire(instance_name: str) -> dict[str, Any]:
+def auth_configuration_questionaire() -> dict[str, Any]:
     """
     Kubernetes-specific questionnaire to generate Helm values for the Keycloak helm
     chart.

vantage6/cli/auth/remove.py

@@ -1,11 +1,13 @@
 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()
@@ -23,9 +25,65 @@ def cli_auth_remove(
     ----------
     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/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,9 +9,7 @@ from vantage6.cli.common.start import (
     prestart_checks,
     start_port_forward,
 )
-from vantage6.cli.common.utils import (
-    attach_logs,
-)
+from vantage6.cli.common.utils import select_context_and_namespace
 from vantage6.cli.context.auth import AuthContext
 from vantage6.cli.globals import ChartName
 
@@ -32,8 +30,13 @@ from vantage6.cli.globals import ChartName
     default=False,
     help="Print server logs to the console after start",
 )
+@click.option("--local-chart-dir", default=None, help="Local chart directory to use")
+@click.option("--sandbox/--no-sandbox", "sandbox", default=False)
 @click_insert_context(
-    type_=InstanceType.AUTH, include_name=True, include_system_folders=True
+    type_=InstanceType.AUTH,
+    include_name=True,
+    include_system_folders=True,
+    sandbox_param="sandbox",
 )
 def cli_auth_start(
     ctx: AuthContext,
@@ -44,23 +47,31 @@ def cli_auth_start(
     ip: str,
     port: int,
     attach: bool,
+    local_chart_dir: str,
 ) -> None:
     """
     Start the auth service.
     """
     info("Starting authentication service...")
 
-    prestart_checks(ctx, InstanceType.AUTH, name, system_folders, context, namespace)
+    prestart_checks(ctx, InstanceType.AUTH, name, system_folders)
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
 
     # TODO: re-enable when we save the auth logs
     # create_directory_if_not_exists(ctx.log_dir)
 
+    info("Starting auth service. This may take a few minutes...")
     helm_install(
         release_name=ctx.helm_release_name,
         chart_name=ChartName.AUTH,
         values_file=ctx.config_file,
         context=context,
         namespace=namespace,
+        local_chart_dir=local_chart_dir,
     )
 
     # port forward for auth service
@@ -75,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/cli/auth/stop.py

@@ -25,11 +25,13 @@ from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS, InfraComponentNa
     flag_value=False,
     help="Search for configuration in the user folders instead of system folders.",
 )
+@click.option("--sandbox/--no-sandbox", "sandbox", default=False)
 def cli_auth_stop(
     name: str,
     context: str,
     namespace: str,
     system_folders: bool,
+    sandbox: bool,
 ):
     """
     Stop a running auth service.
@@ -43,6 +45,7 @@ def cli_auth_stop(
         namespace=namespace,
         context=context,
         system_folders=system_folders,
+        is_sandbox=sandbox,
     )
 
 

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
@@ -35,6 +36,10 @@ from vantage6.cli.node.set_api_key import cli_node_set_api_key
 from vantage6.cli.node.start import cli_node_start
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.version import cli_node_version
+from vantage6.cli.sandbox.new import cli_new_sandbox
+from vantage6.cli.sandbox.remove import cli_sandbox_remove
+from vantage6.cli.sandbox.start import cli_sandbox_start
+from vantage6.cli.sandbox.stop import cli_sandbox_stop
 from vantage6.cli.server.attach import cli_server_attach
 from vantage6.cli.server.files import cli_server_files
 from vantage6.cli.server.import_ import cli_server_import
@@ -94,6 +99,20 @@ cli_node.add_command(cli_node_stop, name="stop")
 cli_node.add_command(cli_node_version, name="version")
 
 
+# Define the sandbox group
+@click.group(name=CLICommandName.SANDBOX.value)
+def cli_sandbox() -> None:
+    """
+    Setup and manage a sandbox environment.
+    """
+
+
+cli_sandbox.add_command(cli_new_sandbox, name="new")
+cli_sandbox.add_command(cli_sandbox_start, name="start")
+cli_sandbox.add_command(cli_sandbox_stop, name="stop")
+cli_sandbox.add_command(cli_sandbox_remove, name="remove")
+
+
 # Define the dev group
 @click.group(name=CLICommandName.DEV.value)
 def cli_dev() -> None:
@@ -157,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
@@ -204,6 +224,7 @@ def cli_complete() -> None:
 # Add the subcommands to the overall group
 cli_complete.add_command(cli_node)
 cli_complete.add_command(cli_server)
+cli_complete.add_command(cli_sandbox)
 cli_complete.add_command(cli_dev)
 cli_complete.add_command(cli_algorithm)
 cli_complete.add_command(cli_test)

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()