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

vantage6/cli/context/auth.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+from vantage6.common.context import AppContext
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli import __version__
+from vantage6.cli.configuration_manager import AuthConfigurationManager
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS as S_FOL
+
+
+class AuthContext(AppContext):
+    """
+    Context class for the keycloak authentication server.
+
+    Parameters
+    ----------
+    instance_name : str
+        Name of the configuration instance, corresponds to the filename
+        of the configuration file.
+    system_folders : bool, optional
+        System wide or user configuration, by default S_FOL
+    """
+
+    # The auth configuration manager is aware of the structure of the auth
+    # configuration file and makes sure only valid configuration can be loaded.
+    INST_CONFIG_MANAGER = AuthConfigurationManager
+
+    def __init__(
+        self,
+        instance_name: str,
+        system_folders: bool = S_FOL,
+    ):
+        super().__init__(
+            InstanceType.AUTH,
+            instance_name,
+            system_folders=system_folders,
+        )
+        self.log.info("vantage6 version '%s'", __version__)
+
+    @classmethod
+    def from_external_config_file(
+        cls, path: str, system_folders: bool = S_FOL
+    ) -> AuthContext:
+        """
+        Create a server context from an external configuration file. External
+        means that the configuration file is not located in the default folders
+        but its location is specified by the user.
+
+        Parameters
+        ----------
+        path : str
+            Path of the configuration file
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+
+        Returns
+        -------
+        ServerContext
+            Server context object
+        """
+        return super().from_external_config_file(
+            path,
+            InstanceType.AUTH,
+            system_folders,
+        )
+
+    @classmethod
+    def config_exists(cls, instance_name: str, system_folders: bool = S_FOL) -> bool:
+        """
+        Check if a configuration file exists.
+
+        Parameters
+        ----------
+        instance_name : str
+            Name of the configuration instance, corresponds to the filename
+            of the configuration file.
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+
+        Returns
+        -------
+        bool
+            Whether the configuration file exists or not
+        """
+        return super().config_exists(
+            InstanceType.AUTH, instance_name, system_folders=system_folders
+        )
+
+    @classmethod
+    def available_configurations(
+        cls, system_folders: bool = S_FOL
+    ) -> tuple[list, list]:
+        """
+        Find all available auth configurations in the default folders.
+
+        Parameters
+        ----------
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+
+        Returns
+        -------
+        tuple[list, list]
+            The first list contains validated configuration files, the second
+            list contains invalid configuration files.
+        """
+        return super().available_configurations(InstanceType.AUTH, system_folders)

vantage6/cli/context/base_server.py

@@ -1,9 +1,5 @@
 from __future__ import annotations
 
-import os.path
-
-from sqlalchemy.engine.url import make_url
-
 from vantage6.common.context import AppContext
 
 from vantage6.cli.globals import (

vantage6/cli/dev/clean.py

@@ -0,0 +1,28 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_clean_dev_env():
+    """
+    Stops and cleans up the development environment.
+
+    Removes the kubernetes resources and local data (e.g. tasks data, database data).
+    This is useful when you want to start from scratch.
+    """
+    check_devspace_installed()
+
+    try:
+        info("🧹 Cleaning development environment with devspace...")
+        cmd = ["devspace", "run", "purge"]
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment cleaned successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error cleaning development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/dev/common.py

@@ -0,0 +1,34 @@
+import shutil
+import subprocess
+import sys
+
+from vantage6.common import error
+
+
+def check_devspace_installed() -> None:
+    """Check if devspace is installed. Exits if not."""
+    # Check if devspace command exists
+    if shutil.which("devspace") is None:
+        _message_devspace_not_installed()
+
+    try:
+        # Try to run devspace --version to verify it's working
+        result = subprocess.run(
+            ["devspace", "--version"], capture_output=True, text=True, timeout=10
+        )
+        if result.returncode != 0:
+            _message_devspace_not_installed()
+    except (
+        subprocess.TimeoutExpired,
+        subprocess.CalledProcessError,
+        FileNotFoundError,
+    ):
+        _message_devspace_not_installed()
+
+
+def _message_devspace_not_installed() -> None:
+    error(
+        "❌ DevSpace command not found. Please ensure devspace is installed and in "
+        "your PATH."
+    )
+    sys.exit(1)

vantage6/cli/dev/rebuild.py

@@ -0,0 +1,39 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+@click.option("--only-server", is_flag=True, help="Rebuild the server image.")
+@click.option("--only-node", is_flag=True, help="Rebuild the node image.")
+@click.option("--only-store", is_flag=True, help="Rebuild the store image.")
+@click.option("--only-ui", is_flag=True, help="Rebuild the ui image.")
+def cli_rebuild_dev_env(
+    only_server: bool, only_node: bool, only_store: bool, only_ui: bool
+):
+    """Rebuild Docker images for your development environment."""
+    check_devspace_installed()
+
+    try:
+        info("🔄 Rebuilding development environment with devspace...")
+        cmd = ["devspace", "run", "rebuild"]
+
+        if only_server:
+            cmd.append("--server")
+        if only_node:
+            cmd.append("--node")
+        if only_store:
+            cmd.append("--store")
+        if only_ui:
+            cmd.append("--ui")
+
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment rebuilt successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error rebuilding development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/dev/start.py

@@ -0,0 +1,36 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_start_dev_env():
+    """Start the development environment using devspace."""
+    check_devspace_installed()
+
+    try:
+        info("🚀 Starting development environment with devspace...")
+
+        # Build the devspace command
+        cmd = ["devspace", "run", "start-dev"]
+
+        # Run the devspace command
+        result = subprocess.run(cmd, check=True, capture_output=False)
+
+        if result.returncode == 0:
+            info("✅ Development environment started successfully!")
+        else:
+            error("❌ Failed to start development environment.")
+            sys.exit(result.returncode)
+
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error running devspace: {e}")
+        sys.exit(e.returncode)
+    except Exception as e:
+        error(f"❌ Unexpected error: {e}")
+        sys.exit(1)

vantage6/cli/dev/stop.py

@@ -0,0 +1,23 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_stop_dev_env():
+    """Stop the development environment."""
+    check_devspace_installed()
+
+    try:
+        info("🛑 Stopping development environment with devspace...")
+        cmd = ["devspace", "run", "stop-dev"]
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment stopped successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error stopping development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/globals.py

@@ -56,11 +56,12 @@ DEFAULT_PROMETHEUS_IMAGE = "prom/prometheus"
 PROMETHEUS_CONFIG = "prometheus.yml"
 PROMETHEUS_DIR = "prometheus"
 
-# template folder
+# template configuration files
 TEMPLATE_FOLDER = PACKAGE_FOLDER / APPNAME / "cli" / "template"
 SERVER_TEMPLATE_FILE = "server_config.j2"
 NODE_TEMPLATE_FILE = "node_config.j2"
 ALGO_STORE_TEMPLATE_FILE = "algo_store_config.j2"
+AUTH_TEMPLATE_FILE = "auth_config.j2"
 
 
 # datasets included in the nodes of the dev network
@@ -97,6 +98,7 @@ class CLICommandName(StrEnumBase):
     TEST = "test"
     DEV = "dev"
     USE = "use"
+    AUTH = "auth"
 
 
 class InfraComponentName(StrEnumBase):
@@ -105,3 +107,4 @@ class InfraComponentName(StrEnumBase):
     SERVER = "server"
     ALGORITHM_STORE = "store"
     NODE = "node"
+    AUTH = "auth"

vantage6/cli/node/list.py

@@ -3,8 +3,9 @@ import docker
 from colorama import Fore, Style
 
 from vantage6.common import warning
-from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import check_docker_running
+from vantage6.common.globals import APPNAME
+
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.node.common import find_running_node_names
 
@@ -39,7 +40,7 @@ def cli_node_list() -> None:
             if f"{APPNAME}-{config.name}-system" in running_node_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25}System ")
+        click.echo(f"{config.name:25}{status:25}System ")
 
     # user folders
     configs, f2 = NodeContext.available_configurations(system_folders=False)
@@ -49,8 +50,8 @@ def cli_node_list() -> None:
             if f"{APPNAME}-{config.name}-user" in running_node_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25}User   ")
+        click.echo(f"{config.name:25}{status:25}User   ")
 
     click.echo("-" * 53)
     if len(f1) + len(f2):
-        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+        warning(f"{Fore.RED}Failed imports: {len(f1) + len(f2)}{Style.RESET_ALL}")

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

@@ -45,6 +45,17 @@ def cli_server_new(
     """
     Create a new server configuration.
     """
+    # 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,
@@ -69,10 +80,6 @@ def server_configuration_questionaire(instance_name: str) -> dict[str, Any]:
     dict[str, Any]
         dictionary with Helm values for the server configuration
     """
-    # Get active kube namespace
-    cli_config = CliConfig()
-    kube_namespace = cli_config.get_last_namespace()
-
     # Initialize config with basic structure
     config = {"server": {}, "database": {}, "ui": {}, "rabbitmq": {}}
 
@@ -102,7 +109,13 @@ def server_configuration_questionaire(instance_name: str) -> dict[str, Any]:
         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