octopize.deploy_tool 2.3.0__tar.gz → 2.4.0__tar.gz

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: octopize.deploy_tool
-Version: 2.3.0
+Version: 2.4.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
@@ -56,7 +56,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 Then run any command directly:
 
 ```bash
-uvx octopize-deploy-tool deploy --output-dir /app/avatar
+uvx octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 ### Option 2 — virtual environment
@@ -68,7 +68,7 @@ Modern Linux distributions and macOS prevent installing packages into the system
 python -m venv .venv
 source .venv/bin/activate   # Windows: .venv\Scripts\activate
 pip install octopize-deploy-tool
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 ### Option 3 — global pip
@@ -121,13 +121,13 @@ docker run --rm \
 Generate a Docker deployment configuration interactively:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 Then start the deployment:
 
 ```bash
-cd /app/avatar
+cd ./app/avatar
 docker compose down --volumes --remove-orphans
 docker compose up -d
 ```
@@ -155,7 +155,7 @@ Use `deploy` to generate a full Docker Compose deployment.
 Example:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 Common `deploy` options:
@@ -217,7 +217,7 @@ Then run:
 
 ```bash
 octopize-deploy-tool deploy \
-  --output-dir /app/avatar \
+  --output-dir ./app/avatar \
   --config config.yaml \
   --non-interactive
 ```
@@ -227,7 +227,7 @@ octopize-deploy-tool deploy \
 The `deploy` command typically writes:
 
 ```text
-/app/avatar/
+./app/avatar/
 ├── .env
 ├── docker-compose.yml
 ├── nginx/nginx.conf
@@ -252,13 +252,13 @@ for example:
 1. Generate configuration:
 
    ```bash
-   octopize-deploy-tool deploy --output-dir /app/avatar
+   octopize-deploy-tool deploy --output-dir ./app/avatar
    ```
 
 2. Review the generated files:
 
    ```bash
-   cd /app/avatar
+   cd ./app/avatar
    cat .env
    ls -la .secrets/
    ```
@@ -285,7 +285,7 @@ for example:
 Retry with verbose output:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar --verbose
+octopize-deploy-tool deploy --output-dir ./app/avatar --verbose
 ```
 
 ### Existing containers cause bind-mount or startup issues

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/README.md

@@ -25,7 +25,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 Then run any command directly:
 
 ```bash
-uvx octopize-deploy-tool deploy --output-dir /app/avatar
+uvx octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 ### Option 2 — virtual environment
@@ -37,7 +37,7 @@ Modern Linux distributions and macOS prevent installing packages into the system
 python -m venv .venv
 source .venv/bin/activate   # Windows: .venv\Scripts\activate
 pip install octopize-deploy-tool
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 ### Option 3 — global pip
@@ -90,13 +90,13 @@ docker run --rm \
 Generate a Docker deployment configuration interactively:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 Then start the deployment:
 
 ```bash
-cd /app/avatar
+cd ./app/avatar
 docker compose down --volumes --remove-orphans
 docker compose up -d
 ```
@@ -124,7 +124,7 @@ Use `deploy` to generate a full Docker Compose deployment.
 Example:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar
+octopize-deploy-tool deploy --output-dir ./app/avatar
 ```
 
 Common `deploy` options:
@@ -186,7 +186,7 @@ Then run:
 
 ```bash
 octopize-deploy-tool deploy \
-  --output-dir /app/avatar \
+  --output-dir ./app/avatar \
   --config config.yaml \
   --non-interactive
 ```
@@ -196,7 +196,7 @@ octopize-deploy-tool deploy \
 The `deploy` command typically writes:
 
 ```text
-/app/avatar/
+./app/avatar/
 ├── .env
 ├── docker-compose.yml
 ├── nginx/nginx.conf
@@ -221,13 +221,13 @@ for example:
 1. Generate configuration:
 
    ```bash
-   octopize-deploy-tool deploy --output-dir /app/avatar
+   octopize-deploy-tool deploy --output-dir ./app/avatar
    ```
 
 2. Review the generated files:
 
    ```bash
-   cd /app/avatar
+   cd ./app/avatar
    cat .env
    ls -la .secrets/
    ```
@@ -254,7 +254,7 @@ for example:
 Retry with verbose output:
 
 ```bash
-octopize-deploy-tool deploy --output-dir /app/avatar --verbose
+octopize-deploy-tool deploy --output-dir ./app/avatar --verbose
 ```
 
 ### Existing containers cause bind-mount or startup issues

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "octopize.deploy_tool"
-version = "2.3.0"
+version = "2.4.0"
 description = "Deployment configuration tool for Octopize Avatar platform"
 readme = "README.md"
 requires-python = ">=3.13"

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/src/octopize_avatar_deploy/__init__.py

@@ -11,7 +11,7 @@ from .version_compat import (
     validate_template_version,
 )
 
-__version__ = "2.3.0"
+__version__ = "2.4.0"
 __all__ = [
     "main",
     "DeploymentRunner",

octopize_deploy_tool-2.4.0/src/octopize_avatar_deploy/steps/email.py

@@ -0,0 +1,264 @@
+"""Email configuration step."""
+
+import ipaddress
+from typing import Any
+
+from .base import (
+    DefaultKey,
+    DeploymentStep,
+    PromptConfig,
+    ValidationError,
+    ValidationSuccess,
+    parse_str,
+)
+
+# AWS SES SMTP preset – connection settings provided by Octopize.
+# Operators only need to supply the SMTP username and password.
+AWS_SMTP_HOST = "email-smtp.eu-west-3.amazonaws.com"
+AWS_SMTP_PORT = "587"
+AWS_SMTP_USE_TLS = "false"
+AWS_SMTP_START_TLS = "true"
+AWS_SMTP_VERIFY = "true"
+AWS_SMTP_SENDER_EMAIL = "noreply@octopize.io"
+
+_AWS_SMTP_HELP = (
+    "Choose 'yes' if Octopize provided you with AWS SES SMTP credentials.\n"
+    "The tool will prefill the standard host, port, and TLS settings automatically;\n"
+    "you will only be asked for the SMTP username and password.\n"
+    "\n"
+    "Choose 'no' to enter all SMTP connection details manually (any provider)."
+)
+
+
+def validate_smtp_host(value: str) -> ValidationSuccess[str] | ValidationError:
+    """
+    Validate that the SMTP host is a hostname or domain name, not a raw IP address.
+
+    An empty value is allowed (it means SMTP is not yet configured).
+
+    Args:
+        value: The SMTP host value to validate
+
+    Returns:
+        ValidationSuccess with the host string, or ValidationError with a message
+    """
+    host = str(value).strip()
+
+    if not host:
+        # Empty is allowed — the operator can leave SMTP unconfigured
+        return ValidationSuccess(host)
+
+    # Reject raw IP addresses (both IPv4 and IPv6)
+    try:
+        ipaddress.ip_address(host)
+        return ValidationError(
+            f"'{host}' is a raw IP address. "
+            "SMTP_HOST must be a hostname or domain name, not an IP address. "
+            "Examples: 'smtp.example.com', 'smtp.sendgrid.net', 'mail.example.com'."
+        )
+    except ValueError:
+        pass
+
+    return ValidationSuccess(host)
+
+
+class EmailStep(DeploymentStep):
+    """Handles email configuration and credentials."""
+
+    name = "email"
+    description = "Configure SMTP email settings and credentials"
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        # Initialised here so generate_secrets() can always reference the attribute
+        # without needing getattr(); updated by collect_config() once the operator answers.
+        self._use_aws_preset: bool = False
+
+    def collect_config(self) -> dict[str, Any]:
+        """Collect email configuration."""
+        config = {}
+
+        print("\n--- Email Configuration ---")
+        self.printer.print(
+            "This section configures how the deployment sends outbound emails, mainly "
+            "for Authentik account and password workflows.\n"
+            "\n"
+            "The deployment needs an SMTP server to send emails such as account setup, "
+            "password reset, and other authentication-related messages.\n"
+            "\n"
+            "You can use:\n"
+            "  - your own SMTP provider or mail server\n"
+            "  - an SMTP service provided by Octopize, based on AWS\n"
+            "\n"
+            "If Octopize provides the SMTP service, we will give you the SMTP "
+            "credentials. In that case, the tool could eventually prefill the standard "
+            "connection settings and only ask you for the username and password we "
+            "provide."
+        )
+
+        use_aws = self._resolve_use_aws_smtp()
+
+        # Store as instance variable so generate_secrets() can check it without
+        # persisting the flag to deployment-config.yaml.
+        self._use_aws_preset = use_aws
+
+        if use_aws:
+            config["SMTP_HOST"] = AWS_SMTP_HOST
+            config["SMTP_PORT"] = AWS_SMTP_PORT
+            config["SMTP_USE_TLS"] = AWS_SMTP_USE_TLS
+            config["SMTP_START_TLS"] = AWS_SMTP_START_TLS
+            config["SMTP_VERIFY"] = AWS_SMTP_VERIFY
+            config["SMTP_SENDER_EMAIL"] = AWS_SMTP_SENDER_EMAIL
+        else:
+            # Manual SMTP configuration
+            config["SMTP_HOST"] = self.get_config_or_prompt_generic(
+                PromptConfig(
+                    config_key="SMTP_HOST",
+                    prompt_message="SMTP host",
+                    default_value=self.get_default_value("email.smtp.host"),
+                    prompt_key="email.smtp_host",
+                    parse_and_validate=validate_smtp_host,
+                    help_text=(
+                        "Hostname of the outbound SMTP server used to send emails from the "
+                        "deployment.\n"
+                        "\n"
+                        "Use a mail server hostname or domain name, for example:\n"
+                        "  - smtp.gmail.com\n"
+                        "  - smtp.sendgrid.net\n"
+                        "  - mail.example.com\n"
+                        "\n"
+                        "Do not use an IP address here.\n"
+                        "\n"
+                        "This SMTP server is used by Authentik to send emails such as account "
+                        "setup and password reset messages."
+                    ),
+                )
+            )
+            config["SMTP_PORT"] = self.get_config_or_prompt_generic(
+                PromptConfig(
+                    config_key="SMTP_PORT",
+                    prompt_message="SMTP port",
+                    default_value=self.get_default_value("email.smtp.port"),
+                    prompt_key="email.smtp_port",
+                    parse_and_validate=parse_str,
+                    help_text=(
+                        "TCP port for the SMTP connection.\n"
+                        "Common values:\n"
+                        "  587  — STARTTLS (recommended)\n"
+                        "  465  — TLS/SSL\n"
+                        "  25   — plain SMTP (often blocked by ISPs)"
+                    ),
+                )
+            )
+            config["SMTP_USE_TLS"] = self.get_config(
+                "SMTP_USE_TLS", DefaultKey("email.smtp.use_tls")
+            )
+            config["SMTP_START_TLS"] = self.get_config(
+                "SMTP_START_TLS", DefaultKey("email.smtp.start_tls")
+            )
+            config["SMTP_VERIFY"] = self.get_config("SMTP_VERIFY", DefaultKey("email.smtp.verify"))
+            config["SMTP_SENDER_EMAIL"] = self.get_config_or_prompt_generic(
+                PromptConfig(
+                    config_key="SMTP_SENDER_EMAIL",
+                    prompt_message="SMTP sender email",
+                    default_value=self.get_default_value("email.smtp.sender_email"),
+                    prompt_key="email.smtp_sender_email",
+                    help_text=(
+                        "The From: address used for all outbound emails sent by the deployment.\n"
+                        "\n"
+                        "This address must be authorized to send through the configured SMTP "
+                        "server.\n"
+                        "\n"
+                        "In most cases, you should keep the default or the value recommended for "
+                        "your SMTP setup. Only change it if you have a specific need, for example "
+                        "if your SMTP provider requires the sender address to be the same as the "
+                        "SMTP username.\n"
+                        "\n"
+                        "Example:\n"
+                        "  - noreply@avatar.example.com"
+                    ),
+                )
+            )
+
+        # Username prompt: required for AWS in interactive mode, optional otherwise.
+        if use_aws and self.interactive:
+            config["SMTP_USERNAME"] = self.prompt(
+                "SMTP username",
+                default=None,  # Required — AWS SES credentials cannot have an empty username.
+                key="email.smtp_username",
+                help_text="Username provided by Octopize for AWS SES SMTP authentication.",
+            )
+        else:
+            config["SMTP_USERNAME"] = self.get_config_or_prompt_generic(
+                PromptConfig(
+                    config_key="SMTP_USERNAME",
+                    prompt_message="SMTP username",
+                    default_value="",
+                    prompt_key="email.smtp_username",
+                    help_text=(
+                        "Username provided by Octopize for AWS SES SMTP authentication."
+                        if use_aws
+                        else (
+                            "Username for SMTP authentication. Leave blank if your server\n"
+                            "does not require authentication."
+                        )
+                    ),
+                )
+            )
+
+        self.config.update(config)
+
+        return config
+
+    def _resolve_use_aws_smtp(self) -> bool:
+        """Determine whether to use the built-in AWS SMTP preset.
+
+        In interactive mode the operator is asked explicitly.
+        In non-interactive mode, the value is read from ``self.config``
+        (key ``USE_AWS_SMTP_PRESET``); it defaults to ``False`` so that
+        existing non-interactive deployments are unaffected.
+        """
+        if self.interactive:
+            return self.prompt_yes_no(
+                "Use built-in AWS SMTP configuration (provided by Octopize)?",
+                default=False,
+                key="email.use_aws_smtp",
+                help_text=_AWS_SMTP_HELP,
+            )
+
+        raw = self.config.get("USE_AWS_SMTP_PRESET", False)
+        if isinstance(raw, bool):
+            return raw
+        return str(raw).lower() in ("true", "yes", "1", "on", "enabled")
+
+    def generate_secrets(self) -> dict[str, str]:
+        """Generate email-related secrets."""
+        secrets_dict = {}
+
+        if self.interactive:
+            if self._use_aws_preset:
+                # Password is required for AWS SES — no skip option.
+                smtp_password = self.prompt(
+                    "SMTP password",
+                    default=None,
+                    key="email.smtp_password",
+                    help_text=(
+                        "Password provided by Octopize for AWS SES SMTP authentication.\n"
+                        "This value is stored as a generated secret, not in the main config file."
+                    ),
+                )
+            else:
+                smtp_password = self.prompt(
+                    "SMTP password (press Enter to skip)",
+                    default="",
+                    key="email.smtp_password",
+                    help_text=(
+                        "Password for SMTP authentication.\n"
+                        "\n"
+                        "Leave blank if your SMTP server does not require a password."
+                    ),
+                )
+            if smtp_password:
+                secrets_dict["smtp_password"] = smtp_password
+
+        return secrets_dict

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/basic_deployment/input.yaml

@@ -6,6 +6,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: admin@example.com
+  email.use_aws_smtp: false
   email.smtp_host: smtp.example.com
   email.smtp_port: '587'
   email.smtp_sender_email: noreply@example.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/cloud_storage/input.yaml

@@ -6,6 +6,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: admin@cloud.example.com
+  email.use_aws_smtp: false
   email.smtp_host: smtp.cloud.com
   email.smtp_port: '587'
   email.smtp_sender_email: noreply@cloud.example.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/dev_mode_deployment/input.yaml

@@ -6,6 +6,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: dev@example.com
+  email.use_aws_smtp: false
   email.smtp_host: smtp.example.com
   email.smtp_port: '587'
   email.smtp_sender_email: dev@example.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/no_telemetry/input.yaml

@@ -6,6 +6,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: admin@internal.com
+  email.use_aws_smtp: false
   email.smtp_host: smtp.internal.com
   email.smtp_port: '587'
   email.smtp_sender_email: noreply@internal.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/prompt_help/input.yaml

@@ -11,6 +11,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: admin@example.com
+  email.use_aws_smtp: false
   email.smtp_host:
     - '?'
     - smtp.example.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/resume_interrupted/input_first_run.yaml

@@ -6,6 +6,7 @@ responses:
   nginx_tls.ssl_certificate_path: smtp
   nginx_tls.ssl_certificate_key_path: smtp.example.com
   authentik.bootstrap_email: '587'
+  email.use_aws_smtp: false
   email.smtp_host: smtp.example.com
   email.smtp_port: '587'
   email.smtp_sender_email: noreply@example.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/fixtures/save_config_with_existing/input.yaml

@@ -3,6 +3,7 @@ responses:
   nginx_tls.ssl_certificate_path: ''
   nginx_tls.ssl_certificate_key_path: ''
   authentik.bootstrap_email: admin@existing.com
+  email.use_aws_smtp: false
   email.smtp_host: smtp.existing.com
   email.smtp_port: '587'
   email.smtp_sender_email: noreply@existing.com

{octopize_deploy_tool-2.3.0 → octopize_deploy_tool-2.4.0}/tests/integration/test_cli_integration.py

@@ -373,6 +373,46 @@ class TestCLIDeploymentScenarios:
         # Verify no Jinja2 placeholders remain
         assert "{{ BLUEPRINT_" not in blueprint_content
 
+    def test_aws_smtp_preset_dialog_values(self, temp_deployment_dir, log_file):
+        """End-to-end test: AWS SMTP preset populates all connection fields from constants."""
+        responses = {
+            **fixture_manager.load_input_fixture("basic_deployment"),
+            # Override email section: select the AWS preset, supply credentials.
+            "email.use_aws_smtp": True,
+            "email.smtp_username": "AKIAIOSFODNN7EXAMPLE",
+            "email.smtp_password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        }
+
+        harness = _create_deploy_harness(
+            responses=responses,
+            output_dir=temp_deployment_dir,
+            log_file=log_file,
+        )
+        exit_code = harness.run()
+
+        assert exit_code == 0
+
+        # Verify generated deployment state reflects AWS preset constants.
+        state_file = temp_deployment_dir / ".deployment-state.yaml"
+        assert state_file.exists()
+        with open(state_file) as f:
+            state = yaml.safe_load(f)
+
+        config = state["config"]
+        assert config["SMTP_HOST"] == "email-smtp.eu-west-3.amazonaws.com"
+        assert config["SMTP_PORT"] == "587"
+        assert config["SMTP_USE_TLS"] == "false"
+        assert config["SMTP_START_TLS"] == "true"
+        assert config["SMTP_VERIFY"] == "true"
+        assert config["SMTP_SENDER_EMAIL"] == "noreply@octopize.io"
+        assert config["SMTP_USERNAME"] == "AKIAIOSFODNN7EXAMPLE"
+
+        # Password should be stored as a secret, not in the main config.
+        assert "SMTP_PASSWORD" not in config
+        smtp_secret = temp_deployment_dir / ".secrets" / "smtp_password"
+        assert smtp_secret.exists()
+        assert smtp_secret.read_text().strip() == "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
+
 
 class TestCLINonInteractiveMode:
     """Test non-interactive mode."""