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

vantage6/cli/algorithm/generate_algorithm_json.py

@@ -276,23 +276,23 @@ class Function:
         else:
             type_ = param.annotation
 
-        if type_ == str:
+        if type_ is str:
             return AlgorithmArgumentType.STRING
-        elif type_ == dict:
+        elif type_ is dict:
             return AlgorithmArgumentType.JSON
-        elif type_ == int:
+        elif type_ is int:
             return AlgorithmArgumentType.INTEGER
-        elif type_ == float:
+        elif type_ is float:
             return AlgorithmArgumentType.FLOAT
-        elif type_ == bool:
+        elif type_ is bool:
             return AlgorithmArgumentType.BOOLEAN
-        elif type_ == list:
+        elif type_ is list:
             return AlgorithmArgumentType.STRINGS
-        elif type_ == list[str]:
+        elif type_ is list[str]:
             return AlgorithmArgumentType.STRINGS
-        elif type_ == list[int]:
+        elif type_ is list[int]:
             return AlgorithmArgumentType.INTEGERS
-        elif type_ == list[float]:
+        elif type_ is list[float]:
             return AlgorithmArgumentType.FLOATS
         else:
             warning(

vantage6/cli/algorithm/update.py

@@ -2,9 +2,9 @@ import os
 from pathlib import Path
 
 import click
+import copier.errors
 import questionary as q
 from copier import run_update
-import copier.errors
 
 from vantage6.common import info, warning
 

vantage6/cli/algostore/attach.py

@@ -1,6 +1,7 @@
 import click
 
 from vantage6.common import info
+
 from vantage6.cli.common.utils import attach_logs
 
 

vantage6/cli/algostore/files.py

@@ -1,10 +1,11 @@
 import click
 
 from vantage6.common import info
-from vantage6.cli.context.server import ServerContext
-from vantage6.cli.common.decorator import click_insert_context
 from vantage6.common.globals import InstanceType
 
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.context.server import ServerContext
+
 
 @click.command()
 @click_insert_context(type_=InstanceType.ALGORITHM_STORE)

vantage6/cli/algostore/list.py

@@ -1,6 +1,5 @@
 import click
 
-from vantage6.common.docker.addons import check_docker_running
 from vantage6.common.globals import InstanceType
 
 from vantage6.cli.common.utils import get_server_configuration_list
@@ -11,6 +10,4 @@ def cli_algo_store_configuration_list() -> None:
     """
     Print the available server configurations.
     """
-    check_docker_running()
-
     get_server_configuration_list(InstanceType.ALGORITHM_STORE)

vantage6/cli/algostore/new.py

@@ -1,8 +1,14 @@
 import click
+import questionary as q
 
-from vantage6.common.globals import InstanceType
+from vantage6.common.globals import (
+    DEFAULT_API_PATH,
+    InstanceType,
+    Ports,
+)
 
 from vantage6.cli.common.new import new
+from vantage6.cli.configuration_wizard import add_common_server_config
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 
 
@@ -36,4 +42,79 @@ def cli_algo_store_new(
     Create a new server configuration.
     """
 
-    new(name, system_folders, namespace, context, InstanceType.ALGORITHM_STORE)
+    new(
+        questionnaire_function=algo_store_configuration_questionaire,
+        name=name,
+        system_folders=system_folders,
+        namespace=namespace,
+        context=context,
+        type_=InstanceType.ALGORITHM_STORE,
+    )
+
+
+def algo_store_configuration_questionaire(instance_name: str) -> dict:
+    """
+    Questionary to generate a config file for the algorithm store server
+    instance.
+
+    Parameters
+    ----------
+    instance_name : str
+        Name of the server instance.
+
+    Returns
+    -------
+    dict
+        Dictionary with the new server configuration
+    """
+    config = {"store": {}, "database": {}}
+
+    config, is_production = add_common_server_config(
+        config, InstanceType.ALGORITHM_STORE, instance_name
+    )
+    if not is_production:
+        config["store"]["dev"] = {
+            "host_uri": "host.docker.internal",
+            "disable_review": True,
+            "review_own_algorithm": True,
+        }
+
+    default_v6_server_uri = f"http://localhost:{Ports.DEV_SERVER}{DEFAULT_API_PATH}"
+    default_root_username = "admin"
+
+    v6_server_uri = q.text(
+        "What is the Vantage6 server linked to the algorithm store? "
+        "Provide the link to the server endpoint.",
+        default=default_v6_server_uri,
+    ).unsafe_ask()
+
+    root_username = q.text(
+        "What is the username of the root user?",
+        default=default_root_username,
+    ).unsafe_ask()
+
+    config["root_user"] = {
+        "v6_server_uri": v6_server_uri,
+        "username": root_username,
+    }
+
+    # ask about openness of the algorithm store
+    config["policies"] = {}
+    is_open = q.confirm(
+        "Do you want to open the algorithm store to the public? This will allow anyone "
+        "to view the algorithms, but they cannot modify them.",
+        default=False,
+    ).unsafe_ask()
+    if is_open:
+        open_algos_policy = "public"
+    else:
+        is_open_to_whitelist = q.confirm(
+            "Do you want to allow all authenticated users to access "
+            "the algorithms in the store? If not allowing this, you will have to assign"
+            " the appropriate permissions to each user individually.",
+            default=True,
+        ).unsafe_ask()
+        open_algos_policy = "authenticated" if is_open_to_whitelist else "private"
+    config["policies"]["algorithm_view"] = open_algos_policy
+
+    return config

vantage6/cli/algostore/remove.py

@@ -1,21 +1,21 @@
-import itertools
-from pathlib import Path
-from shutil import rmtree
 import click
-import questionary as q
 
-from vantage6.common import info
-from vantage6.common.docker.addons import check_docker_running
+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 import AlgorithmStoreContext
-from vantage6.cli.utils import remove_file
-from vantage6.common.globals import InstanceType
+from vantage6.cli.globals import InfraComponentName
 
 
 @click.command()
-@click_insert_context(type_=InstanceType.ALGORITHM_STORE)
+@click_insert_context(
+    type_=InstanceType.ALGORITHM_STORE, include_name=True, include_system_folders=True
+)
 @click.option("-f", "--force", "force", flag_value=True)
-def cli_algo_store_remove(ctx: AlgorithmStoreContext, force: bool) -> None:
+def cli_algo_store_remove(
+    ctx: AlgorithmStoreContext, name: str, system_folders: bool, force: bool
+) -> None:
     """
     Function to remove an algorithm store.
 
@@ -26,27 +26,11 @@ def cli_algo_store_remove(ctx: AlgorithmStoreContext, force: bool) -> None:
     force : bool
         Whether to ask for confirmation before removing or not
     """
-    check_docker_running()
-
-    if not force:
-        if not q.confirm(
-            "This algorithm store will be deleted permanently including its "
-            "configuration. Are you sure?",
-            default=False,
-        ).ask():
-            info("Algorithm store will not be deleted")
-            exit(0)
-
-    # now remove the folders...
-    remove_file(ctx.config_file, "configuration")
-
-    # ensure log files are closed before removing
-    log_dir = Path(ctx.log_file.parent)
-    info(f"Removing log directory: {log_dir}")
-    for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
-        handler.close()
-    # remove the whole folder with all the log files (if it exists)
-    try:
-        rmtree(log_dir)
-    except FileNotFoundError:
-        pass
+    execute_remove(
+        ctx,
+        InstanceType.ALGORITHM_STORE,
+        InfraComponentName.ALGORITHM_STORE,
+        name,
+        system_folders,
+        force,
+    )

vantage6/cli/algostore/start.py

@@ -9,12 +9,12 @@ from vantage6.common.globals import (
 from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.common.start import (
     helm_install,
+    prestart_checks,
     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
@@ -30,9 +30,13 @@ from vantage6.cli.globals import ChartName
     default=False,
     help="Print server logs to the console after start",
 )
-@click_insert_context(InstanceType.ALGORITHM_STORE)
+@click_insert_context(
+    InstanceType.ALGORITHM_STORE, include_name=True, include_system_folders=True
+)
 def cli_algo_store_start(
     ctx: AlgorithmStoreContext,
+    name: str,
+    system_folders: bool,
     context: str,
     namespace: str,
     ip: str,
@@ -43,9 +47,9 @@ def cli_algo_store_start(
     Start the algorithm store.
     """
     info("Starting algorithm store...")
-    context, namespace = select_context_and_namespace(
-        context=context,
-        namespace=namespace,
+
+    prestart_checks(
+        ctx, InstanceType.ALGORITHM_STORE, name, system_folders, context, namespace
     )
 
     create_directory_if_not_exists(ctx.log_dir)
@@ -58,10 +62,9 @@ def cli_algo_store_start(
         namespace=namespace,
     )
 
-    # 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_name=f"{ctx.helm_release_name}-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,

vantage6/cli/algostore/stop.py

@@ -1,17 +1,10 @@
 import click
-from colorama import Fore, Style
 
-from vantage6.common import error, info
+from vantage6.common import info
 from vantage6.common.globals import InstanceType
 
-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
+from vantage6.cli.common.stop import execute_stop, helm_uninstall, stop_port_forward
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS, InfraComponentName
 
 
 @click.command()
@@ -43,54 +36,23 @@ def cli_algo_store_stop(
     """
     Stop one or all running algorithm store(s).
     """
-    context, namespace = select_context_and_namespace(
-        context=context,
-        namespace=namespace,
-    )
-
-    running_stores = find_running_service_names(
+    execute_stop(
+        stop_function=_stop_store,
         instance_type=InstanceType.ALGORITHM_STORE,
-        only_system_folders=system_folders,
-        only_user_folders=not system_folders,
-        context=context,
+        infra_component=InfraComponentName.ALGORITHM_STORE,
+        stop_all=all_stores,
+        to_stop=name,
         namespace=namespace,
+        context=context,
+        system_folders=system_folders,
     )
 
-    if not running_stores:
-        error("No running algorithm stores found.")
-        return
-
-    if all_stores:
-        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
-
-        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?!")
-
 
 def _stop_store(store_name: str, namespace: str, context: str) -> None:
     info(f"Stopping store {store_name}...")
 
-    # uninstall the helm release
-    helm_uninstall(
-        release_name=store_name,
-        context=context,
-        namespace=namespace,
-    )
+    helm_uninstall(release_name=store_name, context=context, namespace=namespace)
 
-    stop_port_forward(
-        service_name=f"{store_name}-vantage6-algorithm-store-service",
-    )
+    stop_port_forward(service_name=f"{store_name}-store-service")
 
     info(f"Store {store_name} stopped successfully.")

vantage6/cli/auth/attach.py

@@ -0,0 +1,60 @@
+import click
+
+from vantage6.common import error, info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import (
+    attach_logs,
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+
+
+@click.command()
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "-n", "--name", default=None, help="Name of the auth service to attach to"
+)
+def cli_auth_attach(context: str, namespace: str, name: str) -> None:
+    """
+    Show the server logs in the current console.
+    """
+    info("Attaching to auth logs...")
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    running_services = find_running_service_names(
+        instance_type=InstanceType.AUTH,
+        only_system_folders=False,
+        only_user_folders=False,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_services:
+        error("No running auth services found.")
+        return
+
+    if name:
+        # search for a running auth service started up either in user or system folders
+        svc_name_options = [
+            f"vantage6-{name}-user-auth",
+            f"vantage6-{name}-system-auth",
+        ]
+        helm_name = next(
+            (svc for svc in svc_name_options if svc in running_services), None
+        )
+        if not helm_name:
+            error(f"No running auth service found for {name}.")
+            return
+    else:
+        helm_name = select_running_service(running_services, InstanceType.AUTH)
+
+    attach_logs(
+        f"app.kubernetes.io/instance={helm_name}",
+    )

vantage6/cli/auth/files.py

@@ -0,0 +1,16 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.context.auth import AuthContext
+
+
+@click.command()
+@click_insert_context(type_=InstanceType.AUTH)
+def cli_auth_files(ctx: AuthContext) -> None:
+    """
+    List files that belong to a particular auth instance.
+    """
+    info(f"Configuration file = {ctx.config_file}")

vantage6/cli/auth/list.py

@@ -0,0 +1,13 @@
+import click
+
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import get_server_configuration_list
+
+
+@click.command()
+def cli_auth_configuration_list() -> None:
+    """
+    Print the available auth configurations.
+    """
+    get_server_configuration_list(InstanceType.AUTH)

vantage6/cli/auth/new.py

@@ -0,0 +1,80 @@
+from typing import Any
+
+import click
+import questionary as q
+
+from vantage6.common.globals import (
+    InstanceType,
+)
+
+from vantage6.cli.common.new import new
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option(
+    "-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("--context", default=None, help="Kubernetes context to use")
+@click.option(
+    "--namespace",
+    default=None,
+    help="Kubernetes namespace to use",
+)
+def cli_auth_new(
+    name: str,
+    system_folders: bool,
+    namespace: str,
+    context: str,
+) -> None:
+    """
+    Create a new server configuration.
+    """
+    new(
+        questionnaire_function=auth_configuration_questionaire,
+        name=name,
+        system_folders=system_folders,
+        namespace=namespace,
+        context=context,
+        type_=InstanceType.AUTH,
+    )
+
+
+def auth_configuration_questionaire(instance_name: str) -> dict[str, Any]:
+    """
+    Kubernetes-specific questionnaire to generate Helm values for the Keycloak helm
+    chart.
+    """
+    config = {"keycloak": {}}
+
+    is_production = q.confirm(
+        "Do you want to use production settings? If not, the service will be configured"
+        " to be more suitable for development or testing purposes.",
+        default=True,
+    ).unsafe_ask()
+
+    config["keycloak"]["production"] = is_production
+
+    if is_production:
+        ui_url = q.text(
+            "Please provide the URL of the UI. This is the URL that users will use to "
+            "log in to the service.",
+            default="https://ui.vantage6.ai",
+        ).unsafe_ask()
+        # add http://localhost:7681 as that is used by the Python client
+        config["keycloak"]["redirectUris"] = [ui_url, "http://localhost:7681"]
+
+    return config

vantage6/cli/auth/remove.py

@@ -0,0 +1,31 @@
+import click
+
+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
+
+
+@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
+    force : bool
+        Whether to ask for confirmation before removing or not
+    """
+    execute_remove(
+        ctx, InstanceType.AUTH, InfraComponentName.AUTH, name, system_folders, force
+    )

vantage6/cli/auth/start.py

@@ -0,0 +1,80 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import InstanceType, Ports
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.common.start import (
+    helm_install,
+    prestart_checks,
+    start_port_forward,
+)
+from vantage6.cli.common.utils import (
+    attach_logs,
+)
+from vantage6.cli.context.auth import AuthContext
+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 for the auth service",
+)
+@click.option(
+    "--attach/--detach",
+    default=False,
+    help="Print server logs to the console after start",
+)
+@click_insert_context(
+    type_=InstanceType.AUTH, include_name=True, include_system_folders=True
+)
+def cli_auth_start(
+    ctx: AuthContext,
+    name: str,
+    system_folders: bool,
+    context: str,
+    namespace: str,
+    ip: str,
+    port: int,
+    attach: bool,
+) -> None:
+    """
+    Start the auth service.
+    """
+    info("Starting authentication service...")
+
+    prestart_checks(ctx, InstanceType.AUTH, name, system_folders, context, namespace)
+
+    # TODO: re-enable when we save the auth logs
+    # create_directory_if_not_exists(ctx.log_dir)
+
+    helm_install(
+        release_name=ctx.helm_release_name,
+        chart_name=ChartName.AUTH,
+        values_file=ctx.config_file,
+        context=context,
+        namespace=namespace,
+    )
+
+    # port forward for auth service
+    info("Port forwarding for auth service")
+    start_port_forward(
+        service_name=f"{ctx.helm_release_name}-keycloak",
+        service_port=Ports.HTTP.value,
+        port=port or Ports.DEV_AUTH.value,
+        ip=ip,
+        context=context,
+        namespace=namespace,
+    )
+
+    if attach:
+        attach_logs(
+            f"app.kubernetes.io/instance={ctx.helm_release_name}",
+        )