octopize.deploy_tool 2.7.3__tar.gz → 2.9.0__tar.gz

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: octopize.deploy_tool
-Version: 2.7.3
+Version: 2.9.0
 Summary: Deployment configuration tool for Octopize Avatar platform
 Project-URL: Homepage, https://octopize.io
 Project-URL: Documentation, https://docs.octopize.io/docs/deploying/self-hosted
@@ -18,9 +18,13 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: System :: Systems Administration
 Requires-Python: >=3.13
+Requires-Dist: certifi>=2024.0.0
+Requires-Dist: cryptography>=49.0.0
+Requires-Dist: httpx2>=2.4.0
 Requires-Dist: httpx>=0.28.0
 Requires-Dist: jinja2>=3.1.0
 Requires-Dist: pandas>=3.0.0
+Requires-Dist: python-dotenv>=1.2.2
 Requires-Dist: python-on-whales>=0.76.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: rich-argparse>=1.8.0
@@ -309,6 +313,23 @@ docker run --rm \
 > For example, if your TLS certificate lives at `/etc/ssl/avatar/server.crt` on the host,
 > enter `/etc/ssl/avatar/server.crt` at the prompt. Docker Compose will mount those paths from
 > the host when it starts the Avatar services.
+>
+> **If your TLS certificate is not mounted into the deploy tool container** — that is, you
+> are running the deploy tool itself inside Docker and you enter a host-side certificate path
+> that does not exist inside the deploy tool container — add `--skip-tls-path-validation` to
+> bypass the existence check:
+>
+> ```bash
+> docker run --rm \
+>   --user "$(id -u):$(id -g)" \
+>   -v "$(pwd)/avatar:/app-root" \
+>   -v "$(pwd)/config:/input:ro" \
+>   quay.io/octopize/deploy-tool:latest install \
+>     --app-root /app-root \
+>     --from-config /input/config.yaml \
+>     --non-interactive \
+>     --skip-tls-path-validation
+> ```
 
 ### `update`
 
@@ -446,10 +467,13 @@ The `generate-env` command writes component `.env` files directly to their resol
 5. Verify the deployment:
 
    ```bash
-   docker compose -f ./app/avatar/generated_files/docker-compose.yml ps
-   docker compose -f ./app/avatar/generated_files/docker-compose.yml logs -f
+   octopize-deploy-tool verify --app-root ./app/avatar --test-email your@email.com
    ```
 
+   This checks the Avatar API health (`/health/config-full-check`) and runs an
+   Authentik email delivery test. Pass `--test-email` with an address you can
+   receive mail at to confirm SMTP is working.
+
 ## `generate-env`
 
 Use `generate-env` to create per-component `.env` files for local development without generating

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/README.md

@@ -280,6 +280,23 @@ docker run --rm \
 > For example, if your TLS certificate lives at `/etc/ssl/avatar/server.crt` on the host,
 > enter `/etc/ssl/avatar/server.crt` at the prompt. Docker Compose will mount those paths from
 > the host when it starts the Avatar services.
+>
+> **If your TLS certificate is not mounted into the deploy tool container** — that is, you
+> are running the deploy tool itself inside Docker and you enter a host-side certificate path
+> that does not exist inside the deploy tool container — add `--skip-tls-path-validation` to
+> bypass the existence check:
+>
+> ```bash
+> docker run --rm \
+>   --user "$(id -u):$(id -g)" \
+>   -v "$(pwd)/avatar:/app-root" \
+>   -v "$(pwd)/config:/input:ro" \
+>   quay.io/octopize/deploy-tool:latest install \
+>     --app-root /app-root \
+>     --from-config /input/config.yaml \
+>     --non-interactive \
+>     --skip-tls-path-validation
+> ```
 
 ### `update`
 
@@ -417,10 +434,13 @@ The `generate-env` command writes component `.env` files directly to their resol
 5. Verify the deployment:
 
    ```bash
-   docker compose -f ./app/avatar/generated_files/docker-compose.yml ps
-   docker compose -f ./app/avatar/generated_files/docker-compose.yml logs -f
+   octopize-deploy-tool verify --app-root ./app/avatar --test-email your@email.com
    ```
 
+   This checks the Avatar API health (`/health/config-full-check`) and runs an
+   Authentik email delivery test. Pass `--test-email` with an address you can
+   receive mail at to confirm SMTP is working.
+
 ## `generate-env`
 
 Use `generate-env` to create per-component `.env` files for local development without generating

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0/infra/deployment/deployment-tool}/tests/fixtures/generate_env_output_dir_error/output.txt

@@ -1,3 +1,3 @@
 Usage: octopize-deploy-tool [-h]
-                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate} ...
+                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate,verify} ...
 octopize-deploy-tool: error: unrecognized arguments: --output-dir ./out

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0/infra/deployment/deployment-tool}/tests/fixtures/help/output.txt

@@ -1,5 +1,5 @@
 Usage: octopize-deploy-tool [-h]
-                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate} ...
+                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate,verify} ...
 
 Avatar Deployment Configuration Tool
 
@@ -10,6 +10,8 @@ Commands:
   stop               Stop the Avatar stack (containers and volumes preserved)
   migrate            Import an existing deployment into the versioned
                      deploy-tool format
+  verify             Verify the running deployment stack (API health + email
+                     test)
 
 Expert Commands:
   configure          Answer the deployment questionnaire and save a versioned

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0/infra/deployment/deployment-tool}/tests/fixtures/missing_subcommand/output.txt

@@ -1,3 +1,3 @@
 Usage: octopize-deploy-tool [-h]
-                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate} ...
+                            {deploy,generate-env,configure,render,apply,install,update,start,stop,migrate,diff,authentik-migrate,verify} ...
 octopize-deploy-tool: error: the following arguments are required: command

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "octopize.deploy_tool"
-version = "2.7.3"
+version = "2.9.0"
 description = "Deployment configuration tool for Octopize Avatar platform"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -30,6 +30,10 @@ dependencies = [
     "pandas>=3.0.0",
     "python-on-whales>=0.76.0",
     "rich-argparse>=1.8.0",
+    "python-dotenv>=1.2.2",
+    "httpx2>=2.4.0",
+    "cryptography>=49.0.0",
+    "certifi>=2024.0.0",
 ]
 
 [dependency-groups]

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/src/octopize_avatar_deploy/__init__.py

@@ -10,7 +10,7 @@ from .version_compat import (
     validate_template_version,
 )
 
-__version__ = "2.7.3"
+__version__ = "2.9.0"
 __all__ = [
     "DeploymentRunner",
     "DeploymentConfigurator",

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/src/octopize_avatar_deploy/application/commands/install_command.py

@@ -170,7 +170,6 @@ class InstallCommand:
     def _run(self, args: InstallCommandArgs) -> InstallCommandResult:
         """Internal implementation called by :meth:`run`."""
         # 1. Pre-flight checks.
-        self._printer.print_step("Pre-flight checks")
         preflight_result = self._preflight.run(args.app_root)
 
         if preflight_result.aborted():
@@ -178,7 +177,6 @@ class InstallCommand:
             return InstallCommandResult(preflight=preflight_result)
 
         # 2. Configure.
-        self._printer.print_step("Configure")
         configure_args = ConfigureCommandArgs(
             app_root=args.app_root,
             from_config=args.from_config,
@@ -190,7 +188,6 @@ class InstallCommand:
         version_label = configure_result.version.label
 
         # 3. Render.
-        self._printer.print_step("Render")
         render_args = RenderCommandArgs(
             app_root=args.app_root,
             version=version_label,
@@ -198,7 +195,6 @@ class InstallCommand:
         render_result = self._render.run(render_args)
 
         # 4. Apply.
-        self._printer.print_step("Apply")
         apply_args = ApplyCommandArgs(
             app_root=args.app_root,
             version=version_label,

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/src/octopize_avatar_deploy/application/commands/migrate_command.py

@@ -119,13 +119,14 @@ class MigrateCommandArgs:
         app_root: Operator's working directory (the deployment root).
         from_legacy: Directory that contains the existing legacy ``.env`` and
             ``.secrets/`` files.  Both are always co-located, so a single
-            directory argument suffices.
+            directory argument suffices.  May be ``None`` when running
+            interactively — the command will prompt for it.
         interactive: Whether to prompt the operator for missing values during
             configure.  Set to ``False`` for non-interactive / scripted runs.
     """
 
     app_root: Path
-    from_legacy: Path
+    from_legacy: Path | None = None
     interactive: bool = True
 
 
@@ -271,11 +272,29 @@ class MigrateCommand:
         if fresh and self._path_checker.exists(generated_files_dir):
             self._path_checker.remove(generated_files_dir)
 
+        # Resolve from_legacy: prompt interactively if not provided.
+        from_legacy = args.from_legacy
+        if from_legacy is None:
+            if not args.interactive:
+                raise MigrateError(
+                    "--from-legacy is required in non-interactive mode. "
+                    "Provide the path to the directory containing the legacy "
+                    ".env and .secrets/ files."
+                )
+            from_legacy = Path(
+                self._input.prompt(
+                    message=(
+                        "Enter the path to the legacy deployment directory "
+                        "(containing .env and .secrets/):"
+                    ),
+                    key="migrate.from_legacy",
+                )
+            )
+
         # 1. Configure seeded from legacy directory.
-        self._printer.print_step("Configure")
         configure_args = ConfigureCommandArgs(
             app_root=args.app_root,
-            from_legacy=args.from_legacy,
+            from_legacy=from_legacy,
             fresh=fresh,
             interactive=args.interactive,
         )
@@ -283,7 +302,6 @@ class MigrateCommand:
         version_label = configure_result.version.label
 
         # 2. Render.
-        self._printer.print_step("Render")
         render_args = RenderCommandArgs(
             app_root=args.app_root,
             version=version_label,
@@ -301,7 +319,7 @@ class MigrateCommand:
             # previous deployed version. The 'update' command handles v(N-1) → v(N) diffs.
             diff_args = DiffCommandArgs(
                 app_root=args.app_root,
-                from_ref=PathRef(args.from_legacy),
+                from_ref=PathRef(from_legacy),
                 to_ref=VersionRef(configure_result.version),
                 interactive=args.interactive,
             )
@@ -322,7 +340,6 @@ class MigrateCommand:
                 )
 
         # 4. Apply.
-        self._printer.print_step("Apply")
         apply_args = ApplyCommandArgs(
             app_root=args.app_root,
             version=version_label,

octopize_deploy_tool-2.9.0/src/octopize_avatar_deploy/application/commands/tasks/__init__.py

@@ -0,0 +1,17 @@
+"""Commands under the ``tasks`` namespace."""
+
+from __future__ import annotations
+
+from octopize_avatar_deploy.application.commands.tasks.registry import (
+    TaskDescriptor,
+    get_task,
+    get_tasks,
+    register_task,
+)
+
+__all__ = [
+    "TaskDescriptor",
+    "get_task",
+    "get_tasks",
+    "register_task",
+]

octopize_deploy_tool-2.9.0/src/octopize_avatar_deploy/application/commands/tasks/registry.py

@@ -0,0 +1,82 @@
+"""Task registry for the ``tasks`` CLI namespace.
+
+Each task is described by a :class:`TaskDescriptor` instance.  Register tasks
+by calling :func:`register_task` at module level (typically in ``cli.py`` after
+the task's helper functions are defined).
+
+Example::
+
+    from octopize_avatar_deploy.application.commands.tasks.registry import (
+        TaskDescriptor,
+        register_task,
+    )
+
+    def _add_my_task_cli_args(subparser: argparse.ArgumentParser) -> None:
+        subparser.add_argument("--some-flag", ...)
+
+    def _run_my_task(args: argparse.Namespace) -> None:
+        ...
+
+    register_task(TaskDescriptor(
+        name="my-task",
+        help="Short one-line description",
+        description="Long description shown in 'tasks my-task --help'.",
+        add_cli_args=_add_my_task_cli_args,
+        run=_run_my_task,
+    ))
+"""
+
+from __future__ import annotations
+
+import argparse
+from collections.abc import Callable
+from dataclasses import dataclass
+
+
+@dataclass
+class TaskDescriptor:
+    """Describes a registerable task in the ``tasks`` CLI namespace.
+
+    Parameters
+    ----------
+    name:
+        Short CLI name used as the sub-command, e.g. ``"provision-admin"``.
+    help:
+        One-line summary shown in ``tasks --help``.
+    description:
+        Long description shown in ``tasks <name> --help``.
+        May contain ``\\n`` for multi-line formatting.
+    add_cli_args:
+        Callable that adds task-specific arguments to the argparse subparser.
+    run:
+        Callable that executes the task given the parsed :class:`argparse.Namespace`.
+    """
+
+    name: str
+    help: str
+    description: str
+    add_cli_args: Callable[[argparse.ArgumentParser], None]
+    run: Callable[[argparse.Namespace], None]
+
+
+_REGISTRY: dict[str, TaskDescriptor] = {}
+
+
+def register_task(descriptor: TaskDescriptor) -> None:
+    """Add *descriptor* to the global task registry.
+
+    Raises :class:`ValueError` if a task with the same name is already registered.
+    """
+    if descriptor.name in _REGISTRY:
+        raise ValueError(f"Task {descriptor.name!r} is already registered.")
+    _REGISTRY[descriptor.name] = descriptor
+
+
+def get_tasks() -> list[TaskDescriptor]:
+    """Return all registered task descriptors in registration order."""
+    return list(_REGISTRY.values())
+
+
+def get_task(name: str) -> TaskDescriptor | None:
+    """Return the descriptor for *name*, or ``None`` if not found."""
+    return _REGISTRY.get(name)

{octopize_deploy_tool-2.7.3 → octopize_deploy_tool-2.9.0}/src/octopize_avatar_deploy/application/commands/update_command.py

@@ -204,7 +204,6 @@ class UpdateCommand:
             raise UpdateError("No existing deployment found — run 'install' first.")
 
         # 2. Configure seeded from current state.
-        self._printer.print_step("Configure")
         configure_args = ConfigureCommandArgs(
             app_root=args.app_root,
             from_state=current_version.label,
@@ -222,7 +221,6 @@ class UpdateCommand:
         version_label = configure_result.version.label
 
         # 3. Render.
-        self._printer.print_step("Render")
         render_args = RenderCommandArgs(
             app_root=args.app_root,
             version=version_label,
@@ -230,7 +228,6 @@ class UpdateCommand:
         render_result = self._render.run(render_args)
 
         # 4. Diff: compare generated_files/ (deployed) vs new render (vX).
-        self._printer.print_step("Diff")
         diff_args = DiffCommandArgs(
             app_root=args.app_root,
             from_ref=DeployedRef(),
@@ -253,7 +250,6 @@ class UpdateCommand:
             )
 
         # 5. Apply.
-        self._printer.print_step("Apply")
         apply_args = ApplyCommandArgs(
             app_root=args.app_root,
             version=version_label,
@@ -262,7 +258,8 @@ class UpdateCommand:
 
         self._printer.print_success(
             f"Update complete. Version {version_label!r} is now deployed to "
-            f"{apply_result.output_dir}."
+            f"{apply_result.output_dir}. "
+            "Run 'start' to bring up the stack."
         )
 
         return UpdateCommandResult(