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

vantage6/cli/algostore/new.py

@@ -1,61 +1,120 @@
 import click
-from colorama import Fore, Style
+import questionary as q
 
-from vantage6.common import info, error, ensure_config_dir_writable
-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
-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(
+        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

@@ -2,106 +2,75 @@ 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,
+    prestart_checks,
+    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,
 )
 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,
     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,
     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)
+    prestart_checks(
+        ctx, InstanceType.ALGORITHM_STORE, name, system_folders, context, 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,
+    info("Port forwarding for algorithm store")
+    start_port_forward(
+        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,
+        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,58 @@
 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 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 execute_stop, helm_uninstall, stop_port_forward
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS, InfraComponentName
 
 
 @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()
-
-    running_stores = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE}"}
+    execute_stop(
+        stop_function=_stop_store,
+        instance_type=InstanceType.ALGORITHM_STORE,
+        infra_component=InfraComponentName.ALGORITHM_STORE,
+        stop_all=all_stores,
+        to_stop=name,
+        namespace=namespace,
+        context=context,
+        system_folders=system_folders,
     )
 
-    if not running_stores:
-        warning("No algorithm stores are currently running.")
-        return
 
-    running_store_names = [server.name for server in running_stores]
+def _stop_store(store_name: str, namespace: str, context: str) -> None:
+    info(f"Stopping store {store_name}...")
 
-    if all_stores:
-        for container_name in running_store_names:
-            _stop_algorithm_store(client, container_name)
-        return
+    helm_uninstall(release_name=store_name, context=context, namespace=namespace)
 
-    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
+    stop_port_forward(service_name=f"{store_name}-store-service")
 
-    _stop_algorithm_store(client, container_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.")
+    info(f"Store {store_name} stopped successfully.")

vantage6/cli/cli.py

@@ -1,17 +1,19 @@
 import click
 
-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
-from vantage6.cli.server.list import cli_server_configuration_list
-from vantage6.cli.server.new import cli_server_new
-from vantage6.cli.server.remove import cli_server_remove
-from vantage6.cli.server.shell import cli_server_shell
-from vantage6.cli.server.start import cli_server_start
-from vantage6.cli.server.stop import cli_server_stop
-from vantage6.cli.server.version import cli_server_version
+from vantage6.cli.algorithm.create import cli_algorithm_create
+from vantage6.cli.algorithm.generate_algorithm_json import (
+    cli_algorithm_generate_algorithm_json,
+)
+from vantage6.cli.algorithm.update import cli_algorithm_update
+from vantage6.cli.algostore.attach import cli_algo_store_attach
+from vantage6.cli.algostore.files import cli_algo_store_files
+from vantage6.cli.algostore.list import cli_algo_store_configuration_list
+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.globals import CLICommandName
 from vantage6.cli.node.attach import cli_node_attach
-from vantage6.cli.node.clean import cli_node_clean
 from vantage6.cli.node.create_private_key import cli_node_create_private_key
 from vantage6.cli.node.files import cli_node_files
 from vantage6.cli.node.list import cli_node_list
@@ -22,29 +24,26 @@ 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.algorithm.create import cli_algorithm_create
-from vantage6.cli.algorithm.update import cli_algorithm_update
-from vantage6.cli.algorithm.generate_algorithm_json import (
-    cli_algorithm_generate_algorithm_json,
-)
+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
+from vantage6.cli.server.list import cli_server_configuration_list
+from vantage6.cli.server.new import cli_server_new
+from vantage6.cli.server.remove import cli_server_remove
+from vantage6.cli.server.shell import cli_server_shell
+from vantage6.cli.server.start import cli_server_start
+from vantage6.cli.server.stop import cli_server_stop
+from vantage6.cli.server.version import cli_server_version
 
 # from vantage6.cli.test.client_script import cli_test_client_script
-from vantage6.cli.test.feature_tester import cli_test_features
-
 # from vantage6.cli.test.integration_test import cli_test_integration
-from vantage6.cli.algostore.attach import cli_algo_store_attach
-from vantage6.cli.algostore.new import cli_algo_store_new
-from vantage6.cli.algostore.start import cli_algo_store_start
-from vantage6.cli.algostore.stop import cli_algo_store_stop
-from vantage6.cli.algostore.files import cli_algo_store_files
-from vantage6.cli.algostore.list import cli_algo_store_configuration_list
-from vantage6.cli.algostore.remove import cli_algo_store_remove
+from vantage6.cli.test.feature_tester import cli_test_features
 from vantage6.cli.use.context import cli_use_context
 from vantage6.cli.use.namespace import cli_use_namespace
 
 
 # Define the server group
-@click.group(name="server")
+@click.group(name=CLICommandName.SERVER.value)
 def cli_server() -> None:
     """
     Manage your vantage6 server instances.
@@ -65,7 +64,7 @@ cli_server.add_command(cli_server_version, name="version")
 
 
 # Define the node group
-@click.group(name="node")
+@click.group(name=CLICommandName.NODE.value)
 def cli_node() -> None:
     """
     Manage your vantage6 node instances.
@@ -74,7 +73,6 @@ def cli_node() -> None:
 
 # Define the commands for the node group
 cli_node.add_command(cli_node_attach, name="attach")
-cli_node.add_command(cli_node_clean, name="clean")
 cli_node.add_command(cli_node_create_private_key, name="create-private-key")
 cli_node.add_command(cli_node_files, name="files")
 cli_node.add_command(cli_node_list, name="list")
@@ -88,7 +86,7 @@ cli_node.add_command(cli_node_version, name="version")
 
 
 # Define the dev group
-@click.group(name="dev")
+@click.group(name=CLICommandName.DEV.value)
 def cli_dev() -> None:
     """
     Quickly manage a test network with a server and several nodes.
@@ -101,7 +99,7 @@ def cli_dev() -> None:
 
 
 # Define the algorithm group
-@click.group(name="algorithm")
+@click.group(name=CLICommandName.ALGORITHM.value)
 def cli_algorithm() -> None:
     """
     Manage your vantage6 algorithms.
@@ -117,7 +115,7 @@ cli_algorithm.add_command(
 
 
 # Define the test group
-@click.group(name="test")
+@click.group(name=CLICommandName.TEST.value)
 def cli_test() -> None:
     """
     Execute tests on your vantage6 infrastructure.
@@ -131,7 +129,7 @@ cli_test.add_command(cli_test_features, name="feature-test")
 
 
 # Define the algorithm-store group
-@click.group(name="algorithm-store")
+@click.group(name=CLICommandName.ALGORITHM_STORE.value)
 def cli_algo_store() -> None:
     """
     Manage your vantage6 algorithm store server instances.
@@ -149,7 +147,7 @@ cli_algo_store.add_command(cli_algo_store_remove, name="remove")
 
 
 # Add the use group
-@click.group(name="use")
+@click.group(name=CLICommandName.USE.value)
 def cli_use() -> None:
     """
     Manage Kubernetes context and namespace.