vantage6 5.0.0a29__py3-none-any.whl → 5.0.0a34__py3-none-any.whl

vantage6/cli/__init__.py

@@ -1,3 +1,7 @@
 """Command line interface for the vantage6 infrastructure."""
 
-from ._version import version_info, __version__  # noqa: F401
+import importlib.metadata
+
+# note that here we cannot use __package__ because __package__ resolves to vantage6.cli
+# whereas the PyPi package is called vantage6
+__version__ = importlib.metadata.version("vantage6")

vantage6/cli/algorithm/generate_algorithm_json.py

@@ -19,8 +19,6 @@ from vantage6.common.algorithm_function import (
 )
 from vantage6.common.enum import AlgorithmArgumentType, AlgorithmStepType, StrEnumBase
 
-from vantage6.algorithm.tools import DecoratorStepType
-
 from vantage6.algorithm.client import AlgorithmClient
 from vantage6.algorithm.preprocessing.algorithm_json_data import (
     PREPROCESSING_FUNCTIONS_JSON_DATA,
@@ -120,7 +118,7 @@ class Function:
         # infrastructure-defined function
         if (
             not self.func.__module__.startswith("vantage6.algorithm.")
-            or not self.json["name"] in PREPROCESSING_FUNCTIONS_JSON_DATA
+            or self.json["name"] not in PREPROCESSING_FUNCTIONS_JSON_DATA
         ):
             return
 
@@ -327,14 +325,8 @@ class Function:
     def _get_step_type(self) -> AlgorithmStepType | None:
         """Get the step type of the function"""
         decorator_type = get_vantage6_decorator_type(self.func)
-        if decorator_type == DecoratorStepType.FEDERATED:
-            return AlgorithmStepType.FEDERATED_COMPUTE
-        elif decorator_type == DecoratorStepType.CENTRAL:
-            return AlgorithmStepType.CENTRAL_COMPUTE
-        elif decorator_type == DecoratorStepType.PREPROCESSING:
-            return AlgorithmStepType.PREPROCESSING
-        elif decorator_type == DecoratorStepType.DATA_EXTRACTION:
-            return AlgorithmStepType.DATA_EXTRACTION
+        if decorator_type in AlgorithmStepType.list():
+            return decorator_type
         else:
             warning(
                 f"Unsupported decorator type: {decorator_type} for function {self.name}"

vantage6/cli/algostore/new.py

@@ -1,61 +1,39 @@
 import click
-from colorama import Fore, Style
 
-from vantage6.common import info, error, ensure_config_dir_writable
 from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.new import new
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
-from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
-from vantage6.cli.configuration_wizard import configuration_wizard
-from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
 
 
 @click.command()
 @click.option(
-    "-n", "--name", default=None, help="name of the configuration you want to use."
+    "-n", "--name", default=None, help="Name of the configuration you want to use."
+)
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Use system folders instead of user folders. This is the default",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+    help="Use user folders instead of system folders",
 )
-@click.option("--system", "system_folders", flag_value=True)
+@click.option("--context", default=None, help="Kubernetes context to use")
 @click.option(
-    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
+    "--namespace",
+    default=None,
+    help="Kubernetes namespace to use",
 )
-def cli_algo_store_new(name: str, system_folders: bool) -> None:
+def cli_algo_store_new(
+    name: str, system_folders: bool, namespace: str, context: str
+) -> None:
     """
     Create a new server configuration.
     """
-    name = prompt_config_name(name)
-
-    # check if name is allowed for docker volume, else exit
-    check_config_name_allowed(name)
-
-    # check that this config does not exist
-    try:
-        if AlgorithmStoreContext.config_exists(name, system_folders):
-            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already " "exists!")
-            exit(1)
-    except Exception as e:
-        error(e)
-        exit(1)
-
-    # Check that we can write in this folder
-    if not ensure_config_dir_writable(system_folders):
-        error("Your user does not have write access to all folders. Exiting")
-        info(
-            f"Create a new server using '{Fore.GREEN}v6 algorithm-store new "
-            f"--user{Style.RESET_ALL}' instead!"
-        )
-        exit(1)
-
-    # create config in ctx location
-    try:
-        cfg_file = configuration_wizard(
-            InstanceType.ALGORITHM_STORE, name, system_folders
-        )
-    except KeyboardInterrupt:
-        error("Configuration creation aborted.")
-        exit(1)
-    info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
 
-    flag = "" if system_folders else "--user"
-    info(
-        f"You can start the algorithm store by running {Fore.GREEN}v6 "
-        f"algorithm-store start {flag}{Style.RESET_ALL}"
-    )
+    new(name, system_folders, namespace, context, InstanceType.ALGORITHM_STORE)

vantage6/cli/algostore/start.py

@@ -2,39 +2,29 @@ import click
 
 from vantage6.common import info
 from vantage6.common.globals import (
-    APPNAME,
-    DEFAULT_ALGO_STORE_IMAGE,
     InstanceType,
     Ports,
 )
 
 from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.common.start import (
+    helm_install,
+    start_port_forward,
+)
+from vantage6.cli.common.utils import (
     attach_logs,
-    check_for_start,
-    get_image,
-    mount_config_file,
-    mount_database,
-    mount_source,
-    pull_infra_image,
+    create_directory_if_not_exists,
+    select_context_and_namespace,
 )
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+from vantage6.cli.globals import ChartName
 
 
 @click.command()
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
 @click.option("--ip", default=None, help="IP address to listen on")
 @click.option("-p", "--port", default=None, type=int, help="Port to listen on")
-@click.option("-i", "--image", default=None, help="Algorithm store Docker image to use")
-@click.option(
-    "--keep/--auto-remove",
-    default=False,
-    help="Keep image after algorithm store has been stopped. Useful for debugging",
-)
-@click.option(
-    "--mount-src",
-    default="",
-    help="Override vantage6 source code in container with the source code in this path",
-)
 @click.option(
     "--attach/--detach",
     default=False,
@@ -43,65 +33,41 @@ from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
 @click_insert_context(InstanceType.ALGORITHM_STORE)
 def cli_algo_store_start(
     ctx: AlgorithmStoreContext,
+    context: str,
+    namespace: str,
     ip: str,
     port: int,
-    image: str,
-    keep: bool,
-    mount_src: str,
     attach: bool,
 ) -> None:
     """
-    Start the algorithm store server.
+    Start the algorithm store.
     """
     info("Starting algorithm store...")
-    docker_client = check_for_start(ctx, InstanceType.ALGORITHM_STORE)
-
-    image = get_image(image, ctx, "algorithm-store", DEFAULT_ALGO_STORE_IMAGE)
-
-    info("Pulling algorithm store image...")
-    pull_infra_image(docker_client, image, InstanceType.ALGORITHM_STORE)
-
-    config_file = "/mnt/config.yaml"
-    mounts = mount_config_file(ctx, config_file)
-
-    src_mount = mount_source(mount_src)
-    if src_mount:
-        mounts.append(src_mount)
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
 
-    mount, environment_vars = mount_database(ctx, InstanceType.ALGORITHM_STORE)
-    if mount:
-        mounts.append(mount)
+    create_directory_if_not_exists(ctx.log_dir)
 
-    # The `ip` and `port` refer here to the ip and port within the container.
-    # So we do not really care that is it listening on all interfaces.
-    internal_port = 5000
-    cmd = (
-        f"uwsgi --http :{internal_port} --gevent 1000 --http-websockets "
-        "--master --callable app --disable-logging "
-        "--wsgi-file /vantage6/vantage6-algorithm-store/vantage6/algorithm"
-        f"/store/wsgi.py --pyargv {config_file}"
+    helm_install(
+        release_name=ctx.helm_release_name,
+        chart_name=ChartName.ALGORITHM_STORE,
+        values_file=ctx.config_file,
+        context=context,
+        namespace=namespace,
     )
-    info(cmd)
 
-    info("Run Docker container")
-    port_ = str(port or ctx.config["port"] or Ports.DEV_ALGO_STORE)
-    container = docker_client.containers.run(
-        image,
-        command=cmd,
-        mounts=mounts,
-        detach=True,
-        labels={
-            f"{APPNAME}-type": InstanceType.ALGORITHM_STORE.value,
-            "name": ctx.config_file_name,
-        },
-        environment=environment_vars,
-        ports={f"{internal_port}/tcp": (ip, port_)},
-        name=ctx.docker_container_name,
-        auto_remove=not keep,
-        tty=True,
+    # port forward for server
+    info("Port forwarding for algorithm store")
+    start_port_forward(
+        service_name=f"{ctx.helm_release_name}-vantage6-algorithm-store-service",
+        service_port=ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        port=port or ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        ip=ip,
+        context=context,
+        namespace=namespace,
     )
 
-    info(f"Success! container id = {container.id}")
-
     if attach:
-        attach_logs(container, InstanceType.ALGORITHM_STORE)
+        attach_logs("app=store", "component=store-server")

vantage6/cli/algostore/stop.py

@@ -1,61 +1,96 @@
 import click
-import docker
 from colorama import Fore, Style
 
-from vantage6.common import error, info, warning
-from vantage6.common.docker.addons import (
-    check_docker_running,
-    remove_container_if_exists,
-)
-from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.common import error, info
+from vantage6.common.globals import InstanceType
 
-from vantage6.cli.common.decorator import click_insert_context
-from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+from vantage6.cli.common.stop import helm_uninstall, stop_port_forward
+from vantage6.cli.common.utils import (
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+from vantage6.cli.context import get_context
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 
 
 @click.command()
-@click_insert_context(InstanceType.ALGORITHM_STORE)
+@click.option("-n", "--name", default=None, help="Configuration name")
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+    help="Search for configuration in system folders instead of user folders. "
+    "This is the default.",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    help="Search for configuration in the user folders instead of system folders.",
+)
 @click.option("--all", "all_stores", flag_value=True, help="Stop all algorithm stores")
-def cli_algo_store_stop(ctx: AlgorithmStoreContext, all_stores: bool):
+def cli_algo_store_stop(
+    name: str,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+    all_stores: bool,
+):
     """
-    Stop one or all running server(s).
+    Stop one or all running algorithm store(s).
     """
-    check_docker_running()
-    client = docker.from_env()
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
 
-    running_stores = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE}"}
+    running_stores = find_running_service_names(
+        instance_type=InstanceType.ALGORITHM_STORE,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+        context=context,
+        namespace=namespace,
     )
 
     if not running_stores:
-        warning("No algorithm stores are currently running.")
+        error("No running algorithm stores found.")
         return
 
-    running_store_names = [server.name for server in running_stores]
-
     if all_stores:
-        for container_name in running_store_names:
-            _stop_algorithm_store(client, container_name)
-        return
+        for store in running_stores:
+            _stop_store(store["name"], namespace, context)
+    else:
+        if not name:
+            store_name = select_running_service(
+                running_stores, InstanceType.ALGORITHM_STORE
+            )
+        else:
+            ctx = get_context(InstanceType.ALGORITHM_STORE, name, system_folders)
+            store_name = ctx.helm_release_name
 
-    container_name = ctx.docker_container_name
-    if container_name not in running_store_names:
-        error(f"{Fore.RED}{ctx.name}{Style.RESET_ALL} is not running!")
-        return
+        if store_name in running_stores:
+            _stop_store(store_name, namespace, context)
+            info(f"Stopped the {Fore.GREEN}{store_name}{Style.RESET_ALL} store.")
+        else:
+            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
 
-    _stop_algorithm_store(client, container_name)
 
+def _stop_store(store_name: str, namespace: str, context: str) -> None:
+    info(f"Stopping store {store_name}...")
 
-def _stop_algorithm_store(client, container_name) -> None:
-    """
-    Stop the algorithm store server.
-
-    Parameters
-    ----------
-    client : DockerClient
-        The docker client
-    container_name : str
-        The name of the container to stop
-    """
-    remove_container_if_exists(client, name=container_name)
-    info(f"Stopped the {Fore.GREEN}{container_name}{Style.RESET_ALL} server.")
+    # uninstall the helm release
+    helm_uninstall(
+        release_name=store_name,
+        context=context,
+        namespace=namespace,
+    )
+
+    stop_port_forward(
+        service_name=f"{store_name}-vantage6-algorithm-store-service",
+    )
+
+    info(f"Store {store_name} stopped successfully.")

vantage6/cli/common/new.py

@@ -0,0 +1,60 @@
+from colorama import Fore, Style
+
+from vantage6.common import ensure_config_dir_writable, error, info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import get_main_cli_command_name
+from vantage6.cli.config import CliConfig
+from vantage6.cli.configuration_wizard import configuration_wizard
+from vantage6.cli.context import select_context_class
+from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
+
+
+def new(
+    name: str, system_folders: bool, namespace: str, context: str, type_: InstanceType
+):
+    cli_config = CliConfig()
+    context, namespace = cli_config.compare_changes_config(
+        context=context,
+        namespace=namespace,
+    )
+
+    name = prompt_config_name(name)
+
+    # check if name is valid
+    check_config_name_allowed(name)
+
+    # check that this config does not exist
+    ctx_class = select_context_class(type_)
+    try:
+        if ctx_class.config_exists(name, system_folders):
+            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already exists!")
+            exit(1)
+    except Exception as e:
+        error(e)
+        exit(1)
+
+    command_name = get_main_cli_command_name(type_)
+
+    # Check that we can write in this folder
+    if not ensure_config_dir_writable(system_folders):
+        error("Your user does not have write access to all folders. Exiting")
+        info(
+            f"Create a new {command_name} using '{Fore.GREEN}v6 {command_name} new "
+            f"--user{Style.RESET_ALL}' instead!"
+        )
+        exit(1)
+
+    # create config in ctx location
+    try:
+        cfg_file = configuration_wizard(type_, name, system_folders)
+    except KeyboardInterrupt:
+        error("Configuration creation aborted.")
+        exit(1)
+    info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
+
+    flag = "" if system_folders else "--user"
+    info(
+        f"You can start the {command_name} by running {Fore.GREEN}v6 {command_name} "
+        f"start {flag}{Style.RESET_ALL}"
+    )