backend.ai-install 23.9.6__tar.gz

backend.ai-install-23.9.6/MANIFEST.in

@@ -0,0 +1 @@
+include *.py

backend.ai-install-23.9.6/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: backend.ai-install
+Version: 23.9.6
+Summary: Backend.AI Installer
+Home-page: https://github.com/lablup/backend.ai
+Author: Lablup Inc. and contributors
+License: MIT
+Project-URL: Documentation, https://docs.backend.ai/
+Project-URL: Source, https://github.com/lablup/backend.ai
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.11,<3.12
+Description-Content-Type: text/markdown
+
+Backend.AI Installer
+====================
+
+Package Structure
+-----------------
+
+* `ai.backend.install`: The installer package
+
+Development
+-----------
+
+### Using the textual debug mode
+
+First, install the textual-dev package in the `python-default` venv.
+```shell
+./py -m pip install textual-dev
+```
+
+Open two terminal sessions.
+In the first one, run:
+```shell
+dist/export/python/virtualenvs/python-default/3.11.6/bin/textual console
+```
+
+> **Warning**
+> You should use the `textual` executable created *inside the venv's `bin` directory*.
+> `./py -m textual` only shows the demo instead of executing the devtool command.
+
+In the second one, run:
+```shell
+TEXTUAL=devtools,debug ./backend.ai install
+```

backend.ai-install-23.9.6/ai/backend/install/VERSION

@@ -0,0 +1 @@
+23.09.6

backend.ai-install-23.9.6/ai/backend/install/__init__.py

@@ -0,0 +1,3 @@
+from pathlib import Path
+
+__version__ = (Path(__file__).parent / "VERSION").read_text().strip()

backend.ai-install-23.9.6/ai/backend/install/app.tcss

@@ -0,0 +1,115 @@
+Screen {
+    align: center middle;
+}
+Header {
+    text-style: bold;
+}
+#logo {
+    width: 1fr;
+    text-align: center;
+}
+
+ContentSwitcher {
+    background: $panel;
+    width: 1fr;
+    height: 1fr;
+}
+
+ModeMenu {
+    width: 1fr;
+    margin: 2 2;
+    align-horizontal: center;
+}
+ModeMenu ListView {
+    layout: horizontal;
+    width: auto;
+    height: auto;
+}
+ModeMenu ListView > ListItem {
+    width: 35;
+    margin: 1 2;
+    height: 14;
+    border: wide $panel;
+}
+ModeMenu ListView > ListItem .mode-item-title {
+    width: 1fr;
+    text-style: bold;
+}
+ModeMenu ListView > ListItem .mode-item-desc {
+    width: 1fr;
+    color: $text-muted;
+}
+ModeMenu ListView > ListItem.--highlight {
+    border: wide $foreground;
+}
+ModeMenu ListView > ListItem.disabled .mode-item-title {
+    color: $panel-lighten-2;
+}
+ModeMenu ListView > ListItem.disabled .mode-item-desc {
+    color: $error;
+}
+ModeMenu ListView > ListItem.--highlight.disabled {
+    background: $panel;
+    border: wide $panel-lighten-2;
+}
+ModeMenu Label {
+    padding: 1 2;
+}
+
+.mode-title {
+    width: 1fr;
+    padding: 1 2;
+    background: $panel-darken-1;
+    text-style: bold;
+}
+
+.log {
+    height: 1fr;
+    width: 1fr;
+    padding: 1 2;
+    background: $panel-darken-3;
+    align: center middle;
+}
+
+#download-status {
+    dock: bottom;
+    padding: 1 2;
+    background: $panel;
+    width: 75;
+    height: auto;
+}
+#download-status ProgressBar Bar {
+    width: 1fr;
+}
+
+Button {
+    width: auto;
+    min-width: 16;
+    height: 5;
+    margin: 0 1;
+    padding: 0 2;
+    background: $panel-lighten-2;
+    border: wide $panel-lighten-1;
+    color: $text;
+    text-style: bold;
+}
+Button.primary {
+    background: $accent;
+}
+Button.primary:hover {
+    background: $accent-lighten-1;
+}
+Button.primary.-active:hover {
+    border: wide $foreground;
+}
+Button:hover,
+Button.-active:hover {
+    background: $panel-lighten-3;
+    border: wide $foreground;
+}
+Button:focus,
+Button.-active:focus {
+    border: wide $foreground;
+    color: $text;
+    text-style: bold;
+}

backend.ai-install-23.9.6/ai/backend/install/cli.py

@@ -0,0 +1,507 @@
+from __future__ import annotations
+
+import asyncio
+import json
+import os
+import sys
+import textwrap
+from pathlib import Path
+from typing import cast
+from weakref import WeakSet
+
+import click
+from rich.console import Console
+from rich.text import Text
+from rich.traceback import Traceback
+from textual import on
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.containers import Vertical
+from textual.widgets import (
+    ContentSwitcher,
+    Footer,
+    Header,
+    Label,
+    ListItem,
+    ListView,
+    Markdown,
+    Static,
+    TabbedContent,
+    TabPane,
+)
+
+from ai.backend.install.utils import shorten_path
+from ai.backend.install.widgets import InputDialog, SetupLog
+from ai.backend.plugin.entrypoint import find_build_root
+
+from . import __version__
+from .common import detect_os
+from .context import DevContext, PackageContext, current_log
+from .types import CliArgs, DistInfo, InstallInfo, InstallModes, PrerequisiteError
+
+top_tasks: WeakSet[asyncio.Task] = WeakSet()
+
+
+class DevSetup(Static):
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._task = None
+
+    def compose(self) -> ComposeResult:
+        yield Label("Development Setup", classes="mode-title")
+        with TabbedContent():
+            with TabPane("Install Log", id="tab-dev-log"):
+                yield SetupLog(wrap=True, classes="log")
+            with TabPane("Install Report", id="tab-dev-report"):
+                yield Label("Installation is not complete.")
+
+    def begin_install(self, dist_info: DistInfo) -> None:
+        self.query_one("SetupLog.log").focus()
+        top_tasks.add(asyncio.create_task(self.install(dist_info)))
+
+    async def install(self, dist_info: DistInfo) -> None:
+        _log: SetupLog = cast(SetupLog, self.query_one(".log"))
+        _log_token = current_log.set(_log)
+        ctx = DevContext(dist_info, self.app)
+        try:
+            # prerequisites
+            await ctx.check_prerequisites()
+            # install
+            await ctx.install()
+            # configure
+            await ctx.configure()
+            # post-setup
+            await ctx.populate_images()
+            await ctx.dump_install_info()
+            install_report = InstallReport(ctx.install_info, id="install-report")
+            self.query_one("TabPane#tab-dev-report Label").remove()
+            self.query_one("TabPane#tab-dev-report").mount(install_report)
+            cast(TabbedContent, self.query_one("TabbedContent")).active = "tab-dev-report"
+        except asyncio.CancelledError:
+            _log.write(Text.from_markup("[red]Interrupted!"))
+            await asyncio.sleep(1)
+            raise
+        except PrerequisiteError as e:
+            _log.write(Text.from_markup("[red]:warning: A prerequisite check has failed."))
+            _log.write(e)
+        except Exception as e:
+            _log.write(Text.from_markup("[red]:warning: Unexpected error!"))
+            _log.write(e)
+            _log.write(Traceback())
+        finally:
+            _log.write("")
+            _log.write(Text.from_markup("[bright_cyan]All tasks finished. Press q/Q to exit."))
+            current_log.reset(_log_token)
+
+
+class PackageSetup(Static):
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._task = None
+
+    def compose(self) -> ComposeResult:
+        yield Label("Package Setup", classes="mode-title")
+        with TabbedContent():
+            with TabPane("Install Log", id="tab-pkg-log"):
+                yield SetupLog(wrap=True, classes="log")
+            with TabPane("Install Report", id="tab-pkg-report"):
+                yield Label("Installation is not complete.")
+
+    def begin_install(self, dist_info: DistInfo) -> None:
+        self.query_one("SetupLog.log").focus()
+        top_tasks.add(asyncio.create_task(self.install(dist_info)))
+
+    async def install(self, dist_info: DistInfo) -> None:
+        _log: SetupLog = cast(SetupLog, self.query_one(".log"))
+        _log_token = current_log.set(_log)
+        ctx = PackageContext(dist_info, self.app)
+        try:
+            # prerequisites
+            if dist_info.target_path.exists():
+                input_box = InputDialog(
+                    f"The target path {dist_info.target_path} already exists. "
+                    "Overwrite it or set a different target path.",
+                    str(dist_info.target_path),
+                    allow_cancel=False,
+                )
+                _log.mount(input_box)
+                value = await input_box.wait()
+                assert value is not None
+                dist_info.target_path = Path(value)
+            await ctx.check_prerequisites()
+            # install
+            await ctx.install()
+            # configure
+            await ctx.configure()
+            # post-setup
+            await ctx.populate_images()
+            await ctx.dump_install_info()
+            install_report = InstallReport(ctx.install_info, id="install-report")
+            self.query_one("TabPane#tab-pkg-report Label").remove()
+            self.query_one("TabPane#tab-pkg-report").mount(install_report)
+            cast(TabbedContent, self.query_one("TabbedContent")).active = "tab-pkg-report"
+        except asyncio.CancelledError:
+            _log.write(Text.from_markup("[red]Interrupted!"))
+            await asyncio.sleep(1)
+            raise
+        except PrerequisiteError as e:
+            _log.write(Text.from_markup("[red]:warning: A prerequisite check has failed."))
+            _log.write(e)
+        except Exception as e:
+            _log.write(Text.from_markup("[red]:warning: Unexpected error!"))
+            _log.write(e)
+            _log.write(Traceback())
+        finally:
+            _log.write("")
+            _log.write(Text.from_markup("[bright_cyan]All tasks finished. Press q/Q to exit."))
+            current_log.reset(_log_token)
+
+
+class InstallReport(Static):
+    def __init__(self, install_info: InstallInfo, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.install_info = install_info
+
+    def compose(self) -> ComposeResult:
+        service = self.install_info.service_config
+        yield Markdown(textwrap.dedent(f"""
+        Follow each tab's instructions.  Once all 5 service daemons are ready, you may connect to
+        `http://{service.webserver_addr.face.host}:{service.webserver_addr.face.port}`.
+
+        Use the following credentials for the admin access:
+        - Username: `admin@lablup.com`
+        - Password: `wJalrXUt`
+
+        To see this guide again, run './backendai-install-<platform> install --show-guide'.
+        """))
+        with TabbedContent():
+            with TabPane("Web Server", id="webserver"):
+                yield Markdown(textwrap.dedent(f"""
+                Run the following commands in a separate shell:
+                ```console
+                $ cd {self.install_info.base_path.resolve()}
+                $ ./backendai-webserver web start-server
+                ```
+
+                It works if the console output ends with something like:
+                ```
+                ...
+                INFO ai.backend.web.server [2215731] serving at {service.webserver_addr.bind.host}:{service.webserver_addr.bind.port}
+                INFO ai.backend.web.server [2215731] Using uvloop as the event loop backend
+                ```
+
+                To terminate, send SIGINT or press Ctrl+C in the console.
+                """))
+            with TabPane("Manager", id="manager"):
+                yield Markdown(textwrap.dedent(f"""
+                Run the following commands in a separate shell:
+                ```console
+                $ cd {self.install_info.base_path.resolve()}
+                $ ./backendai-manager mgr start-server
+                ```
+
+                It works if the console output ends with something like:
+                ```
+                ...
+                INFO ai.backend.manager.server [2213274] started handling API requests at {service.manager_addr.bind.host}:{service.manager_addr.bind.port}
+                INFO ai.backend.manager.server [2213275] started handling API requests at {service.manager_addr.bind.host}:{service.manager_addr.bind.port}
+                INFO ai.backend.manager.server [2213276] started handling API requests at {service.manager_addr.bind.host}:{service.manager_addr.bind.port}
+                ```
+
+                To terminate, send SIGINT or press Ctrl+C in the console.
+                """))
+            with TabPane("Agent", id="agent"):
+                yield Markdown(textwrap.dedent(f"""
+                Run the following commands in a separate shell:
+                ```console
+                $ cd {self.install_info.base_path.resolve()}
+                $ ./backendai-agent ag start-server
+                ```
+
+                It works if the console output ends with something like:
+                ```
+                ...
+                INFO ai.backend.agent.server [2214424] started handling RPC requests at {service.agent_rpc_addr.bind.host}:{service.agent_rpc_addr.bind.port}
+                ```
+
+                To terminate, send SIGINT or press Ctrl+C in the console.
+                """))
+            with TabPane("Storage Proxy", id="storage-proxy"):
+                yield Markdown(textwrap.dedent(f"""
+                Run the following commands in a separate shell:
+                ```console
+                $ cd {self.install_info.base_path.resolve()}
+                $ ./backendai-storage-proxy storage start-server
+                ```
+
+                It works if the console output ends with something like:
+                ```
+                ...
+                INFO ai.backend.storage.server [2216229] Node ID: i-storage-proxy-local
+                INFO ai.backend.storage.server [2216229] Using uvloop as the event loop backend
+                ```
+
+                To terminate, send SIGINT or press Ctrl+C in the console.
+                """))
+            with TabPane("Local Proxy", id="local-proxy"):
+                yield Markdown(textwrap.dedent(f"""
+                Run the following commands in a separate shell:
+                ```console
+                $ cd {self.install_info.base_path.resolve()}
+                $ ./backendai-local-proxy
+                ```
+
+                It works if the console output ends with something like:
+                ```
+                ...
+                info [manager.js]: Listening on port {service.local_proxy_addr.bind.port}!
+                info [local_proxy.js]: Proxy is ready: http://{service.local_proxy_addr.face.host}:{service.local_proxy_addr.face.port}/
+                ```
+
+                To terminate, send SIGINT or press Ctrl+C in the console.
+                """))
+
+
+class ModeMenu(Static):
+    """A ListView to choose InstallModes and a description pane underneath."""
+
+    BINDINGS = [
+        Binding("left", "cursor_up", show=False),
+        Binding("right", "cursor_down", show=False),
+    ]
+
+    _dist_info: DistInfo
+    _dist_info_path: Path | None
+
+    def __init__(
+        self,
+        args: CliArgs,
+        *,
+        id: str | None = None,
+    ) -> None:
+        super().__init__(id=id)
+        self._build_root = None
+        try:
+            self._dist_info_path = Path.cwd() / "DIST-INFO"
+            self._dist_info = DistInfo(**json.loads(self._dist_info_path.read_bytes()))
+        except FileNotFoundError:
+            self._dist_info_path = None
+            self._dist_info = DistInfo()
+        self._enabled_menus = set()
+        self._enabled_menus.add(InstallModes.PACKAGE)
+        mode = args.mode
+        try:
+            self._build_root = find_build_root()
+            self._enabled_menus.add(InstallModes.DEVELOP)
+            if args.mode is None:
+                mode = InstallModes.DEVELOP
+        except ValueError:
+            if args.mode is None:
+                mode = InstallModes.PACKAGE
+        # TODO: implement
+        # if Path("INSTALL-INFO").exists():
+        #     self._enabled_menus.add(InstallModes.MAINTAIN)
+        assert mode is not None
+        self._mode = mode
+
+    def compose(self) -> ComposeResult:
+        yield Label(id="heading")
+        if self._dist_info_path is None:
+            package_desc = "Install using release packages"
+        else:
+            package_desc = f"Install using release packages ({shorten_path(self._dist_info_path)})"
+        if self._build_root is None:
+            develop_desc = "Could not find the source (missing BUILD_ROOT)"
+        else:
+            develop_desc = (
+                f"Install from the current source checkout ({shorten_path(self._build_root)})"
+            )
+        if InstallModes.MAINTAIN in self._enabled_menus:
+            maintain_desc = "Maintain an existing setup"
+        else:
+            # maintain_desc = "Could not find an existing setup (missing INSTALL-INFO)"
+            maintain_desc = "Coming soon!"
+        mode_desc: dict[InstallModes, str] = {
+            InstallModes.DEVELOP: develop_desc,
+            InstallModes.PACKAGE: package_desc,
+            InstallModes.MAINTAIN: maintain_desc,
+        }
+        with ListView(
+            id="mode-list", initial_index=list(InstallModes).index(InstallModes(self._mode))
+        ) as lv:
+            self.lv = lv
+            for mode in InstallModes:
+                disabled = mode not in self._enabled_menus
+                yield ListItem(
+                    Vertical(
+                        Label(mode, classes="mode-item-title"),
+                        Label(mode_desc[mode], classes="mode-item-desc"),
+                    ),
+                    classes="disabled" if disabled else "",
+                    id=f"mode-{mode.value.lower()}",
+                )
+        yield Label(id="mode-desc")
+
+    async def on_mount(self) -> None:
+        os_info = await detect_os()
+        text = Text()
+        text.append("Platform: ")
+        text.append_text(os_info.__rich__())  # type: ignore
+        text.append("\n\n")
+        text.append("Choose the installation mode:\n(arrow keys to change, enter to select)")
+        cast(Static, self.query_one("#heading")).update(text)
+
+    def action_cursor_up(self) -> None:
+        self.lv.action_cursor_up()
+
+    def action_cursor_down(self) -> None:
+        self.lv.action_cursor_down()
+
+    @on(ListView.Selected, "#mode-list", item="#mode-develop")
+    def start_develop_mode(self) -> None:
+        if InstallModes.DEVELOP not in self._enabled_menus:
+            return
+        self.app.sub_title = "Development Setup"
+        switcher: ContentSwitcher = cast(ContentSwitcher, self.app.query_one("#top"))
+        switcher.current = "dev-setup"
+        dev_setup: DevSetup = cast(DevSetup, self.app.query_one("#dev-setup"))
+        switcher.call_later(dev_setup.begin_install, self._dist_info)
+
+    @on(ListView.Selected, "#mode-list", item="#mode-package")
+    def start_package_mode(self) -> None:
+        if InstallModes.PACKAGE not in self._enabled_menus:
+            return
+        self.app.sub_title = "Package Setup"
+        switcher: ContentSwitcher = cast(ContentSwitcher, self.app.query_one("#top"))
+        switcher.current = "pkg-setup"
+        pkg_setup: PackageSetup = cast(PackageSetup, self.app.query_one("#pkg-setup"))
+        switcher.call_later(pkg_setup.begin_install, self._dist_info)
+
+    @on(ListView.Selected, "#mode-list", item="#mode-maintain")
+    def start_maintain_mode(self) -> None:
+        if InstallModes.MAINTAIN not in self._enabled_menus:
+            return
+        pass
+
+
+class InstallerApp(App):
+    BINDINGS = [
+        Binding("q", "shutdown", "Interrupt ongoing tasks / Quit the installer"),
+        Binding(
+            "ctrl+c",
+            "shutdown",
+            "Interrupt ongoing tasks / Quit the installer",
+            show=False,
+            priority=True,
+        ),
+    ]
+    CSS_PATH = "app.tcss"
+
+    _args: CliArgs
+
+    def __init__(self, args: CliArgs | None = None) -> None:
+        super().__init__()
+        if args is None:  # when run as textual dev mode
+            args = CliArgs(
+                mode=None,
+                target_path=str(Path.home() / "backendai"),
+                show_guide=False,
+            )
+        self._args = args
+
+    def compose(self) -> ComposeResult:
+        yield Header(show_clock=True)
+        logo_text = textwrap.dedent(r"""
+        ____             _                  _      _    ___
+        | __ )  __ _  ___| | _____ _ __   __| |    / \  |_ _|
+        |  _ \ / _` |/ __| |/ / _ \ '_ \ / _` |   / _ \  | |
+        | |_) | (_| | (__|   <  __/ | | | (_| |_ / ___ \ | |
+        |____/ \__,_|\___|_|\_\___|_| |_|\__,_(_)_/   \_\___|
+        """)
+        yield Static(logo_text, id="logo")
+        if self._args.show_guide:
+            try:
+                install_info = InstallInfo(**json.loads((Path.cwd() / "INSTALL-INFO").read_bytes()))
+                yield InstallReport(install_info)
+            except IOError as e:
+                log = SetupLog()
+                log.write("Failed to read INSTALL-INFO!")
+                log.write(e)
+                yield log
+        else:
+            with ContentSwitcher(id="top", initial="mode-menu"):
+                yield ModeMenu(self._args, id="mode-menu")
+                yield DevSetup(id="dev-setup")
+                yield PackageSetup(id="pkg-setup")
+        yield Footer()
+
+    async def on_mount(self) -> None:
+        header: Header = cast(Header, self.query_one("Header"))
+        header.tall = True
+        self.title = "Backend.AI Installer"
+
+    async def action_shutdown(self, message: str | None = None, exit_code: int = 0) -> None:
+        had_cancelled_tasks = False
+        for t in {*top_tasks}:
+            if t.done():
+                continue
+            had_cancelled_tasks = True
+            t.cancel()
+            try:
+                await t
+            except asyncio.CancelledError:
+                pass
+        if not had_cancelled_tasks:
+            # Let the user shutdown twice if there were cancelled tasks,
+            # so that the user could inspect what happened.
+            self.exit(return_code=exit_code, message=message)
+
+
+@click.command(
+    context_settings={
+        "help_option_names": ["-h", "--help"],
+    },
+)
+@click.option(
+    "--mode",
+    type=click.Choice([*InstallModes.__members__], case_sensitive=False),
+    default=None,
+    help="Override the installation mode. [default: auto-detect]",
+)
+@click.option(
+    "--target-path",
+    type=str,
+    default=str(Path.home() / "backendai"),
+    help="Explicitly set the target installation path. [default: ~/backendai]",
+)
+@click.option(
+    "--show-guide",
+    is_flag=True,
+    default=False,
+    help="Show the post-install guide using INSTALL-INFO if present.",
+)
+@click.version_option(version=__version__)
+@click.pass_context
+def main(
+    cli_ctx: click.Context,
+    mode: InstallModes | None,
+    target_path: str,
+    show_guide: bool,
+) -> None:
+    """The installer"""
+    # check sudo permission
+    console = Console(stderr=True)
+    if os.geteuid() == 0:
+        console.print(
+            "[bright_red] The script should not be run as root, while it requires"
+            " the passwordless sudo privilege."
+        )
+        sys.exit(1)
+    # start installer
+    args = CliArgs(
+        mode=mode,
+        target_path=target_path,
+        show_guide=show_guide,
+    )
+    app = InstallerApp(args)
+    app.run()