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

vantage6/cli/node/stop.py

@@ -1,26 +1,19 @@
-import time
-
 import click
-import docker
-import questionary as q
-from colorama import Fore, Style
 
-from vantage6.common import error, info, warning
-from vantage6.common.docker.addons import (
-    check_docker_running,
-    delete_volume_if_exists,
-    get_server_config_name,
-    stop_container,
-)
-from vantage6.common.globals import APPNAME
+from vantage6.common import info
+from vantage6.common.globals import InstanceType
 
-from vantage6.cli.context import NodeContext
-from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-from vantage6.cli.node.common import find_running_node_names
+from vantage6.cli.common.stop import execute_stop, helm_uninstall, stop_port_forward
+from vantage6.cli.globals import (
+    DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL,
+    InfraComponentName,
+)
 
 
 @click.command()
 @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",
@@ -36,96 +29,43 @@ from vantage6.cli.node.common import find_running_node_names
     "system folders. This is the default.",
 )
 @click.option("--all", "all_nodes", flag_value=True, help="Stop all running nodes")
-@click.option(
-    "--force",
-    "force",
-    flag_value=True,
-    help="Kill nodes instantly; don't wait for them to shut down",
-)
 def cli_node_stop(
-    name: str, system_folders: bool, all_nodes: bool, force: bool
+    name: str,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+    all_nodes: bool,
 ) -> None:
     """
     Stop one or all running nodes.
     """
-    check_docker_running()
-    client = docker.from_env()
-
-    running_node_names = find_running_node_names(client)
-
-    if not running_node_names:
-        warning("No nodes are currently running.")
-        return
-
-    if force:
-        warning(
-            "Forcing the node to stop will not terminate helper "
-            "containers, neither will it remove routing rules made on the "
-            "host!"
-        )
-
-    if all_nodes:
-        for container_name in running_node_names:
-            _stop_node(client, container_name, force, system_folders)
-    else:
-        if not name:
-            try:
-                container_name = q.select(
-                    "Select the node you wish to stop:", choices=running_node_names
-                ).unsafe_ask()
-            except KeyboardInterrupt:
-                error("Aborted by user!")
-                return
-        else:
-            post_fix = "system" if system_folders else "user"
-            container_name = f"{APPNAME}-{name}-{post_fix}"
-
-        if container_name in running_node_names:
-            _stop_node(client, container_name, force, system_folders)
-            info(f"Stopped the {Fore.GREEN}{container_name}{Style.RESET_ALL} Node.")
-        else:
-            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
-
-
-def _stop_node(
-    client: docker.DockerClient, container_name: str, force: bool, system_folders: bool
-) -> None:
+    execute_stop(
+        stop_function=_stop_node,
+        instance_type=InstanceType.NODE,
+        infra_component=InfraComponentName.NODE,
+        stop_all=all_nodes,
+        to_stop=name,
+        namespace=namespace,
+        context=context,
+        system_folders=system_folders,
+    )
+
+
+def _stop_node(node_name: str, namespace: str, context: str) -> None:
     """
     Stop a node
 
     Parameters
     ----------
-    client : docker.DockerClient
-        Docker client
-    name : str
-        Name of the node container to stop
-    force : bool
-        Whether to force the node to stop
-    system_folders : bool
-        Whether to use system folders or not
+    node_name : str
+        Name of the node to stop
+    namespace : str
+        Kubernetes namespace to use
+    context : str
+        Kubernetes context to use
     """
-    container = client.containers.get(container_name)
-    # Stop the container. Using stop() gives the container 10s to exit
-    # itself, if not then it will be killed
-    stop_container(container, force)
-
-    # Sleep for 1 second. Not doing so often causes errors that docker volumes deleted
-    # below are 'still in use' when you try to remove them a few ms after the container
-    # has been removed
-    time.sleep(1)
+    helm_uninstall(release_name=node_name, context=context, namespace=namespace)
 
-    # Delete volumes. This is done here rather than within the node container when
-    # it is stopped, because at that point the volumes are still in use. Here, the node
-    # has already been stopped
-    scope = "system" if system_folders else "user"
-    config_name = get_server_config_name(container_name, scope)
-    ctx = NodeContext(config_name, system_folders, print_log_header=False)
+    stop_port_forward(service_name=f"{node_name}-vantage6-node-service")
 
-    # Do not delete the data volume as this would remove all sessions.
-    for volume in [
-        # ctx.docker_volume_name,
-        ctx.docker_squid_volume_name,
-        ctx.docker_ssh_volume_name,
-        ctx.docker_vpn_volume_name,
-    ]:
-        delete_volume_if_exists(client, volume)
+    info(f"Node {node_name} stopped successfully.")

vantage6/cli/node/version.py

@@ -1,12 +1,13 @@
 import click
-import questionary as q
 import docker
+import questionary as q
 
 from vantage6.common import error
-from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+from vantage6.common.globals import APPNAME
+
 from vantage6.cli import __version__
+from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.node.common import find_running_node_names
 
 
@@ -16,7 +17,7 @@ from vantage6.cli.node.common import find_running_node_names
     "--system",
     "system_folders",
     flag_value=True,
-    help="Search for configuration in system folders rather than " "user folders",
+    help="Search for configuration in system folders rather than user folders",
 )
 @click.option(
     "--user",

vantage6/cli/prometheus/monitoring_manager.py

@@ -1,10 +1,12 @@
-import yaml
-import docker
 from pathlib import Path
 
-from vantage6.common import info, error
+import docker
+import yaml
+
+from vantage6.common import error, info
 from vantage6.common.docker.network_manager import NetworkManager
 from vantage6.common.globals import DEFAULT_PROMETHEUS_EXPORTER_PORT
+
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.globals import (
     DEFAULT_PROMETHEUS_IMAGE,

vantage6/cli/rabbitmq/queue_manager.py

@@ -1,21 +1,21 @@
-import docker
+import base64
+import hashlib
 import json
 import os
 import shutil
-import base64
-import hashlib
 import time
-
 from pathlib import Path
 
-from vantage6.common.globals import APPNAME
-from vantage6.common import debug, info, error
+import docker
+
+from vantage6.common import debug, error, info, split_rabbitmq_uri
 from vantage6.common.docker.addons import get_container
 from vantage6.common.docker.network_manager import NetworkManager
-from vantage6.common import split_rabbitmq_uri
+from vantage6.common.globals import APPNAME
+
 from vantage6.cli.context.server import ServerContext
-from vantage6.cli.rabbitmq.definitions import RABBITMQ_DEFINITIONS
 from vantage6.cli.globals import RABBIT_TIMEOUT
+from vantage6.cli.rabbitmq.definitions import RABBITMQ_DEFINITIONS
 
 DEFAULT_RABBIT_IMAGE = "harbor2.vantage6.ai/infrastructure/rabbitmq"
 RABBIT_CONFIG = "rabbitmq.config"
@@ -75,7 +75,7 @@ class RabbitMQManager:
         # check if a RabbitMQ container is already running
         self.rabbit_container = get_container(docker_client=self.docker, name=self.host)
         if self.rabbit_container:
-            info("RabbitMQ is already running! Linking the server to that " "queue")
+            info("RabbitMQ is already running! Linking the server to that queue")
             if not self.network_mgr.contains(self.rabbit_container):
                 self.network_mgr.connect(self.rabbit_container)
             return
@@ -161,8 +161,10 @@ class RabbitMQManager:
                 "bind": "/etc/rabbitmq/definitions.json",
                 "mode": "ro",
             },
-            self.ctx.data_dir
-            / RABBIT_CONFIG: {"bind": "/etc/rabbitmq/rabbitmq.config", "mode": "ro"},
+            self.ctx.data_dir / RABBIT_CONFIG: {
+                "bind": "/etc/rabbitmq/rabbitmq.config",
+                "mode": "ro",
+            },
             rabbit_data_dir: {"bind": "/var/lib/rabbitmq", "mode": "rw"},
         }
 

vantage6/cli/server/attach.py

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

vantage6/cli/server/common/__init__.py

@@ -1,13 +1,8 @@
-from docker.client import DockerClient
 from colorama import Fore, Style
 
-from vantage6.common import error, info
-from vantage6.common.globals import APPNAME
-from vantage6.common.docker.addons import remove_container, get_container
+from vantage6.common import error
 from vantage6.common.context import AppContext
 
-from vantage6.cli.context.server import ServerContext
-
 
 def get_server_context(
     name: str, system_folders: bool, ctx_class: AppContext
@@ -45,24 +40,3 @@ def get_server_context(
     ctx = ctx_class(name, system_folders=system_folders)
 
     return ctx
-
-
-def stop_ui(client: DockerClient, ctx: ServerContext) -> None:
-    """
-    Check if the UI container is running, and if so, stop and remove it.
-
-    Parameters
-    ----------
-    client : DockerClient
-        Docker client
-    ctx : ServerContext
-        Server context object
-    """
-    ui_container_name = f"{APPNAME}-{ctx.name}-{ctx.scope}-ui"
-    ui_container = get_container(client, name=ui_container_name)
-    if ui_container:
-        remove_container(ui_container, kill=True)
-        info(
-            f"Stopped the {Fore.GREEN}{ui_container_name}"
-            f"{Style.RESET_ALL} User Interface container."
-        )

vantage6/cli/server/import_.py

@@ -102,7 +102,7 @@ def cli_server_import(
             # We're dealing with a relative path here -> make it absolute
             db_path = ctx.data_dir / url.database
 
-        basename = os.path.basename(db_path)
+        # basename = os.path.basename(db_path)
         dirname = os.path.dirname(db_path)
         os.makedirs(dirname, exist_ok=True)
 

vantage6/cli/server/new.py

@@ -1,8 +1,15 @@
+from typing import Any
+
 import click
+import questionary as q
 
-from vantage6.common.globals import InstanceType
+from vantage6.common.globals import (
+    InstanceType,
+)
 
 from vantage6.cli.common.new import new
+from vantage6.cli.config import CliConfig
+from vantage6.cli.configuration_wizard import add_common_server_config
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 
 
@@ -38,4 +45,78 @@ def cli_server_new(
     """
     Create a new server configuration.
     """
-    new(name, system_folders, namespace, context, InstanceType.SERVER)
+    # info(
+    #     "Vantage6 uses keycloak for authentication. Please configure a keycloak "
+    #     "server here unless you have one running externally."
+    # )
+    # configure_keycloak = q.confirm(
+    #     "Do you want to configure a keycloak server?",
+    #     default=True,
+    # ).unsafe_ask()
+    # if configure_keycloak:
+    #     print("awefawef")
+
+    new(
+        questionnaire_function=server_configuration_questionaire,
+        name=name,
+        system_folders=system_folders,
+        namespace=namespace,
+        context=context,
+        type_=InstanceType.SERVER,
+    )
+
+
+def server_configuration_questionaire(instance_name: str) -> dict[str, Any]:
+    """
+    Kubernetes-specific questionnaire to generate Helm values for server.
+
+    Parameters
+    ----------
+    instance_name : str
+        Name of the server instance.
+
+    Returns
+    -------
+    dict[str, Any]
+        dictionary with Helm values for the server configuration
+    """
+    # Initialize config with basic structure
+    config = {"server": {}, "database": {}, "ui": {}, "rabbitmq": {}}
+
+    config, is_production = add_common_server_config(
+        config, InstanceType.SERVER, instance_name
+    )
+    if not is_production:
+        config["server"]["jwt"] = {
+            "secret": "constant_development_secret`",
+        }
+        config["server"]["dev"] = {
+            "host_uri": "host.docker.internal",
+            "store_in_local_cluster": True,
+        }
+
+    # TODO v5+ these should be removed, latest should usually be used so question is
+    # not needed. However, for now we want to specify alpha/beta images.
+    # === Server settings ===
+    config["server"]["image"] = q.text(
+        "Server Docker image:",
+        default="harbor2.vantage6.ai/infrastructure/server:latest",
+    ).unsafe_ask()
+
+    # === UI settings ===
+    config["ui"]["image"] = q.text(
+        "UI Docker image:",
+        default="harbor2.vantage6.ai/infrastructure/ui:latest",
+    ).unsafe_ask()
+
+    # TODO v5+ we need to add a question to ask which algorithm stores are allowed, to
+    # set the CSP headers in the UI. This is not done now because it becomes easier when
+    # store and keycloak service can also be setup in the `v6 server new` command.
+
+    # === Keycloak settings ===
+    cli_config = CliConfig()
+    kube_namespace = cli_config.get_last_namespace()
+    keycloak_url = f"http://vantage6-auth-keycloak.{kube_namespace}.svc.cluster.local"
+    config["server"]["keycloakUrl"] = keycloak_url
+
+    return config

vantage6/cli/server/remove.py

@@ -1,22 +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 ServerContext
-from vantage6.cli.utils import remove_file
+from vantage6.cli.globals import InfraComponentName
 
 
 @click.command()
-@click_insert_context(type_=InstanceType.SERVER)
+@click_insert_context(
+    type_=InstanceType.SERVER, include_name=True, include_system_folders=True
+)
 @click.option("-f", "--force", "force", flag_value=True)
-def cli_server_remove(ctx: ServerContext, force: bool) -> None:
+def cli_server_remove(
+    ctx: ServerContext, name: str, system_folders: bool, force: bool
+) -> None:
     """
     Function to remove a server.
 
@@ -27,26 +26,6 @@ def cli_server_remove(ctx: ServerContext, 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 server will be deleted permanently including its "
-            "configuration. Are you sure?",
-            default=False,
-        ).ask():
-            info("Server 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)
-    if log_dir.exists():
-        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. This may also still contain other
-        # files like RabbitMQ configuration etc
-        rmtree(log_dir)
+    execute_remove(
+        ctx, InstanceType.SERVER, InfraComponentName.SERVER, name, system_folders, force
+    )

vantage6/cli/server/start.py

@@ -6,12 +6,12 @@ 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,
     create_directory_if_not_exists,
-    select_context_and_namespace,
 )
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.globals import ChartName
@@ -32,9 +32,13 @@ from vantage6.cli.globals import ChartName
     default=False,
     help="Print server logs to the console after start",
 )
-@click_insert_context(type_=InstanceType.SERVER)
+@click_insert_context(
+    type_=InstanceType.SERVER, include_name=True, include_system_folders=True
+)
 def cli_server_start(
     ctx: ServerContext,
+    name: str,
+    system_folders: bool,
     context: str,
     namespace: str,
     ip: str,
@@ -46,10 +50,8 @@ def cli_server_start(
     Start the server.
     """
     info("Starting server...")
-    context, namespace = select_context_and_namespace(
-        context=context,
-        namespace=namespace,
-    )
+
+    prestart_checks(ctx, InstanceType.SERVER, name, system_folders, context, namespace)
 
     create_directory_if_not_exists(ctx.log_dir)
 

vantage6/cli/server/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,39 +36,17 @@ def cli_server_stop(
     """
     Stop an running server.
     """
-    context, namespace = select_context_and_namespace(
-        context=context,
-        namespace=namespace,
-    )
-
-    running_servers = find_running_service_names(
+    execute_stop(
+        stop_function=_stop_server,
         instance_type=InstanceType.SERVER,
-        only_system_folders=system_folders,
-        only_user_folders=not system_folders,
-        context=context,
+        infra_component=InfraComponentName.SERVER,
+        stop_all=all_servers,
+        to_stop=name,
         namespace=namespace,
+        context=context,
+        system_folders=system_folders,
     )
 
-    if not running_servers:
-        error("No running servers found.")
-        return
-
-    if all_servers:
-        for server in running_servers:
-            _stop_server(server["name"], namespace, context)
-    else:
-        if not name:
-            server_name = select_running_service(running_servers, InstanceType.SERVER)
-        else:
-            ctx = get_context(InstanceType.SERVER, name, system_folders)
-            server_name = ctx.helm_release_name
-
-        if server_name in running_servers:
-            _stop_server(server_name, namespace, context)
-            info(f"Stopped the {Fore.GREEN}{server_name}{Style.RESET_ALL} server.")
-        else:
-            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
-
 
 def _stop_server(server_name: str, namespace: str, context: str) -> None:
     info(f"Stopping server {server_name}...")

vantage6/cli/template/algo_store_config.j2

@@ -19,7 +19,7 @@ store:
 
   vantage6ServerUri: {{ store.vantage6ServerUri | default('http://localhost:7601/server') }}
 
-  image: {{ store.image | default('harbor2.vantage6.ai/infrastructure/store:latest') }}
+  image: {{ store.image | default('harbor2.vantage6.ai/infrastructure/algorithm-store:latest') }}
 
   replications: {{ store.replications | default(1) }}