twc-cli 2.10.1__tar.gz → 2.11.0__tar.gz

{twc_cli-2.10.1 → twc_cli-2.11.0}/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 В этом файле описаны все значимые изменения в Timeweb Cloud CLI. В выпусках мы придерживается правил [семантического версионирования](https://semver.org/lang/ru/).
 
+# Версия 2.11.0 (2025.04.01)
+
+## Добавлено
+
+- Добавлены новые опции к команде `twc balancer create`:
+    - для настройки сети: `--network-id`, `--public-ip`, `--no-public-ip`, `--private-ip`;
+    - для установки TLS: `--cert-type`, `--cert-domain`, `--cert-data`, `--cert-key`;
+    - выбор локации и пресета: `--region`, `--availability-zone`, `--preset-id`;
+    - дополнительные: `--desc` (описание балансировщика нагрузки).
+- Добавлена новая команда для просмотра списка доступных пресетов балансировщиков нагрузки — `twc balancer list-presets`.
+
+## Изменено
+
+- Опция `--network` команды `twc balancer create` объявлена устаревшей и скрыта. Вместо неё используйте `--network-id`.
+
+## Исправлено
+
+- Исправлена ошибка в команде `twc server create` возникавшая при передаче парамера `--project-id`.
+
 # Версия 2.10.1 (2025.03.25)
 
 ## Исправлено

{twc_cli-2.10.1 → twc_cli-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twc-cli
-Version: 2.10.1
+Version: 2.11.0
 Summary: Timeweb Cloud Command Line Interface.
 Home-page: https://github.com/timeweb-cloud/twc
 License: MIT

{twc_cli-2.10.1 → twc_cli-2.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "twc-cli"
-version = "2.10.1"
+version = "2.11.0"
 description = "Timeweb Cloud Command Line Interface."
 authors = ["ge <dev@timeweb.cloud>"]
 homepage = "https://github.com/timeweb-cloud/twc"

{twc_cli-2.10.1 → twc_cli-2.11.0}/twc/__version__.py

@@ -12,5 +12,5 @@
 import sys
 
 
-__version__ = "2.10.1"
+__version__ = "2.11.0"
 __pyversion__ = sys.version.replace("\n", "")

{twc_cli-2.10.1 → twc_cli-2.11.0}/twc/api/client.py

@@ -78,6 +78,7 @@ class TimewebCloud(TimewebCloudBase):
         network: Optional[dict] = None,
         availability_zone: Optional[ServiceAvailabilityZone] = None,
         is_root_password_required: Optional[bool] = None,
+        project_id: Optional[int] = None,
     ):
         """Create new Cloud Server. Note:
 
@@ -120,6 +121,7 @@ class TimewebCloud(TimewebCloudBase):
                 if is_root_password_required is not None
                 else {}
             ),
+            **({"project_id": project_id} if project_id else {}),
         }
 
         return self._request("POST", f"{self.api_url}/servers", json=payload)
@@ -1157,6 +1159,9 @@ class TimewebCloud(TimewebCloudBase):
         force_https: bool = False,
         backend_keepalive: bool = False,
         network: Optional[dict] = None,
+        comment: Optional[str] = None,
+        project_id: Optional[int] = None,
+        certificates: Optional[dict] = None,
     ):
         """Create load balancer."""
         payload = {
@@ -1175,6 +1180,9 @@ class TimewebCloud(TimewebCloudBase):
             "is_ssl": force_https,
             "is_keepalive": backend_keepalive,
             **({"network": network} if network else {}),
+            **({"comment": comment} if comment else {}),
+            **({"project_id": project_id} if project_id else {}),
+            **({"certificates": certificates} if certificates else {}),
         }
         return self._request("POST", f"{self.api_url}/balancers", json=payload)
 

{twc_cli-2.10.1 → twc_cli-2.11.0}/twc/api/exceptions.py

@@ -15,11 +15,13 @@ class ErrResponse:
         error_code: str = None,
         message: Union[str, List[str]] = None,
         response_id: UUID = None,
+        **kwargs,
     ):
         self.status_code = status_code
         self.error_code = error_code
         self.message = message
         self.response_id = response_id
+        self.kwargs = kwargs
 
 
 class TimewebCloudException(HTTPError):

{twc_cli-2.10.1 → twc_cli-2.11.0}/twc/commands/balancer.py

@@ -2,9 +2,11 @@
 
 import re
 import sys
+from enum import Enum
 from typing import Optional, List
 from pathlib import Path
 from logging import debug
+from ipaddress import IPv4Address, IPv4Network
 
 import typer
 from requests import Response
@@ -13,20 +15,23 @@ from twc import fmt
 from twc.typerx import TyperAlias
 from twc.apiwrap import create_client
 from twc.api import TimewebCloud
-from twc.api.types import LoadBalancerAlgo, LoadBalancerProto
+from twc.vars import REGION_ZONE_MAP
+from twc.api.types import LoadBalancerAlgo, LoadBalancerProto, ServiceRegion
 from .common import (
     verbose_option,
     config_option,
     profile_option,
     filter_option,
     yes_option,
+    region_option,
+    zone_option,
     output_format_option,
     load_from_config_callback,
 )
 
 
 balancer = TyperAlias(help=__doc__)
-balancer_backend = TyperAlias(help="Manage load balancer backends.")
+balancer_backend = TyperAlias(help="Manage load balancer backend servers.")
 balancer_rule = TyperAlias(help="Manage load balancer rules.")
 balancer.add_typer(balancer_backend, name="backend", aliases=["backends"])
 balancer.add_typer(balancer_rule, name="rule", aliases=["rules"])
@@ -144,6 +149,13 @@ def balancer_get(
 # ------------------------------------------------------------- #
 
 
+class CertType(str, Enum):
+    """..."""
+
+    CUSTOM = "custom"
+    LETS_ENCRYPT = "lets_encrypt"
+
+
 @balancer.command("create")
 def balancer_create(
     verbose: Optional[bool] = verbose_option,
@@ -151,11 +163,17 @@ def balancer_create(
     profile: Optional[str] = profile_option,
     output_format: Optional[str] = output_format_option,
     name: str = typer.Option(..., help="Load balancer display name."),
+    desc: Optional[str] = typer.Option(
+        None, help="Load balancer description."
+    ),
+    preset_id: Optional[int] = typer.Option(
+        None, help="Load balancer preset ID."
+    ),
     replicas: int = typer.Option(
         1,
         min=1,
         max=2,
-        help="Load balancer replica count.",
+        help="Load balancer replica count. Ignored if --preset-id set.",
     ),
     algo: LoadBalancerAlgo = typer.Option(
         LoadBalancerAlgo.ROUND_ROBIN.value,
@@ -187,28 +205,44 @@ def balancer_create(
         callback=load_from_config_callback,
         help="Add load balancer to specific project.",
     ),
-    network: Optional[str] = typer.Option(None, help="Private network ID."),
+    network: Optional[str] = typer.Option(
+        None, hidden=True, help="Private network ID."
+    ),
+    network_id: Optional[str] = typer.Option(None, help="Private network ID."),
+    private_ip: Optional[str] = typer.Option(
+        None, help="Private IPv4 address."
+    ),
+    public_ip: Optional[str] = typer.Option(
+        None, help="Public IPv4 address. New address by default."
+    ),
+    no_public_ip: Optional[bool] = typer.Option(
+        False, "--no-public-ip", help="Do not add public IPv4 address."
+    ),
+    region: Optional[str] = region_option,
+    availability_zone: Optional[str] = zone_option,
+    cert_type: Optional[CertType] = typer.Option(
+        None,
+        help="SSL certificate type. Falls to 'custom' "
+        "if --cert-data and --cert-key set.",
+    ),
+    cert_domain: Optional[str] = typer.Option(
+        None,
+        help="Domain name for which the certificate was issued. "
+        "Note: domain name A-record will set to load balancer's public IP.",
+    ),
+    cert_data: Optional[typer.FileText] = typer.Option(
+        None, help="Fullchain certificate file."
+    ),
+    cert_key: Optional[typer.FileText] = typer.Option(
+        None, help="Certificate key file."
+    ),
 ):
     """Create load balancer."""
     client = create_client(config, profile)
 
-    preset_id = None
-    for preset in client.get_load_balancer_presets().json()[
-        "balancers_presets"
-    ]:
-        if preset["replica_count"] == replicas:
-            preset_id = preset["id"]
-    if not preset_id:
-        sys.exit(f"Error: Cannot set {replicas} load balancer replicas.")
-
-    if project_id:
-        if not project_id in [
-            prj["id"] for prj in client.get_projects().json()["projects"]
-        ]:
-            sys.exit(f"Wrong project ID: Project '{project_id}' not found.")
-
     payload = {
         "name": name,
+        "comment": desc,
         "preset_id": preset_id,
         "algo": algo,
         "proto": proto,
@@ -222,21 +256,108 @@ def balancer_create(
         "proxy_protocol": proxy_protocol,
         "force_https": force_https,
         "backend_keepalive": backend_keepalive,
+        "network": {},
+        "project_id": project_id,
+        "certificates": {},
     }
 
+    if cert_type == CertType.CUSTOM:
+        if not cert_data or not cert_key:
+            sys.exit(
+                "Error: --cert-data and --cert-key is required if --cert-type is 'custom'"
+            )
+    elif cert_type == CertType.LETS_ENCRYPT:
+        if cert_data or cert_key:
+            sys.exit(
+                "Error: --cert-data and --cert-key is not allowed with --cert-type 'lets_encrypt'"
+            )
+    if not cert_type:
+        if cert_data and not cert_key:
+            sys.exit("Error: --cert-key is required.")
+        if cert_key and not cert_data:
+            sys.exit("Error: --cert-data is required.")
+        if cert_data and cert_key:
+            cert_type = CertType.CUSTOM
+    if cert_type and not cert_domain:
+        sys.exit(
+            "Error: --cert-domain is required if --cert-type and/or --cert-data, --cert-key is set."
+        )
+    if cert_type:
+        payload["certificates"] = {
+            "type": cert_type.value,
+            "fqdn": cert_domain,
+            **({"cert_data": cert_data.read()} if cert_data else {}),
+            **({"key_data": cert_key.read()} if cert_key else {}),
+        }
+
+    if not preset_id:
+        for preset in client.get_load_balancer_presets().json()[
+            "balancers_presets"
+        ]:
+            if (
+                preset["replica_count"] == replicas
+                and preset["location"] == region
+            ):
+                preset_id = preset["id"]
+        if not preset_id:
+            sys.exit(f"Error: Cannot set {replicas} load balancer replicas.")
+
     if network:
-        payload["network"] = {"id": network}
+        print(
+            "Option --network is deprecated and will be removed soon, "
+            "use --network-id instead",
+            file=sys.stderr,
+        )
+        network_id = network
+
+    if network_id:
+        payload["network"]["id"] = network_id
+        if private_ip:
+            net = IPv4Network(
+                client.get_vpc(network_id).json()["vpc"]["subnet_v4"]
+            )
+            if IPv4Address(private_ip) >= net.network_address + 4:
+                payload["network"]["ip"] = private_ip
+            else:
+                # First 3 addresses is reserved by Timeweb Cloud for gateway and future use.
+                sys.exit(
+                    f"Error: Private address '{private_ip}' is not allowed. "
+                    "IP must be at least the fourth in order in the network."
+                )
+    if public_ip:
+        try:
+            _ = IPv4Address(public_ip)
+            payload["network"]["floating_ip"] = public_ip
+        except ValueError:
+            sys.exit(f"Error: '{public_ip}' is not valid IPv4 address.")
+    else:
+        # Get new public IPv4 address.
+        if no_public_ip is False:
+            zone = None
+            if not preset_id and not availability_zone and not region:
+                sys.exit(
+                    "Error: Unable to get IPv4 address, at least one of "
+                    "[--preset-id, --region, --availability-zone] "
+                    "must be set to determine correct location."
+                )
+            if region:
+                zone = REGION_ZONE_MAP[region]
+            if preset_id and not availability_zone:
+                for preset in client.get_database_presets().json()[
+                    "databases_presets"
+                ]:
+                    if preset["id"] == preset_id:
+                        zone = REGION_ZONE_MAP[preset["location"]]
+            if availability_zone:
+                zone = availability_zone
+            ip = client.create_floating_ip(availability_zone=zone).json()[
+                "ip"
+            ]["ip"]
+            payload["network"]["floating_ip"] = ip
 
     # Create LB
     response = client.create_load_balancer(**payload)
 
-    # Add created LB to project if set
-    if project_id:
-        client.add_balancer_to_project(
-            response.json()["balancer"]["id"],
-            project_id,
-        )
-
     fmt.printer(
         response,
         output_format=output_format,
@@ -384,6 +505,64 @@ def blancer_backend_list(
     )
 
 
+# ------------------------------------------------------------- #
+# $ twc balancer list-presets                                     #
+# ------------------------------------------------------------- #
+
+
+def _print_presets(response: Response, filters: Optional[str] = None):
+    presets = response.json()["balancers_presets"]
+    if filters:
+        presets = fmt.filter_list(presets, filters)
+    table = fmt.Table()
+    table.header(
+        [
+            "ID",
+            "REGION",
+            "PRICE",
+            "REPLICAS",
+            "BANDW",
+            "RPS",
+        ]
+    )
+    for preset in presets:
+        table.row(
+            [
+                preset["id"],
+                preset["location"],
+                preset["price"],
+                preset["replica_count"],
+                preset["bandwidth"],
+                preset["request_per_second"],
+            ]
+        )
+    table.print()
+
+
+@balancer.command("list-presets", "lp")
+def balancer_list_presets(
+    verbose: Optional[bool] = verbose_option,
+    config: Optional[Path] = config_option,
+    profile: Optional[str] = profile_option,
+    output_format: Optional[str] = output_format_option,
+    filters: Optional[str] = filter_option,
+    region: Optional[ServiceRegion] = typer.Option(
+        None, help="Use region (location)."
+    ),
+):
+    """List configuration presets."""
+    if region:
+        filters = f"{filters},location:{region}"
+    client = create_client(config, profile)
+    response = client.get_load_balancer_presets()
+    fmt.printer(
+        response,
+        output_format=output_format,
+        filters=filters,
+        func=_print_presets,
+    )
+
+
 # ------------------------------------------------------------- #
 # $ twc balancer backend add                                    #
 # ------------------------------------------------------------- #
@@ -392,7 +571,7 @@ def blancer_backend_list(
 @balancer_backend.command("add")
 def blancer_backend_add(
     balancer_id: int = typer.Argument(...),
-    backends: List[str] = typer.Argument(..., metavar="BACKEND..."),
+    backends: List[str] = typer.Argument(..., metavar="BACKEND_IP..."),
     verbose: Optional[bool] = verbose_option,
     config: Optional[Path] = config_option,
     profile: Optional[str] = profile_option,