twc-cli 2.3.0__tar.gz → 2.4.1__tar.gz

{twc_cli-2.3.0 → twc_cli-2.4.1}/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 В этом файле описаны все значимые изменения в Timeweb Cloud CLI. В выпусках мы придерживается правил [семантического версионирования](https://semver.org/lang/ru/).
 
+# Версия 2.4.0 (2023.08.21)
+
+## Добавлено
+
+- Добавлена команда `twc vpc` (`twc network`) для работы с сервисом VPC. Доступны все предоставляемые API операции с приватными сетями.
+- В команды для создания облачных серверов и балансировщиков нагрузки добавлена опция `--network`, с помощью которой можно задать ID приватной сети.
+- Добавлена команда `twc domain` для управления доменными именами (добавление, удаление) и DNS-записями. Спасибо @ranmasootome за вклад!
+- Добавлена команда `twc firewall` для управления облачным файрволом.
+- Добавлена команда `twc config profiles` для вывода списка профилей из конфигурационного файла.
+
+## Изменено
+
+- Удалена опция `--with-deleted` у команды `twc image list`.
+- Изменён вывод команд `twc image list` и `twc image get`.
+- Опция `--local-network` (`twc server create`) объявлена устаревшей и скрыта. Используйте `--network` вместо неё.
+- Вызов команды без аргументов приведёт к показу текста справки вместо ошибки.
+- В дополнение к `--help` добавлена опция `-h` для вызова справки.
+- Мелкие улучшения кода.
+
+## Исправлено
+
+- Исправлена ошибка в API-клиенте в методе удаления балансировщиков нагрузки.
+- Другие мелкие исправления.
+
 # Версия 2.3.0 (2023.06.28)
 
 ## Добавлено

{twc_cli-2.3.0 → twc_cli-2.4.1}/PKG-INFO

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

{twc_cli-2.3.0 → twc_cli-2.4.1}/pyproject.toml

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

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/__main__.py

@@ -17,11 +17,18 @@ from .commands import (
     storage,
     balancer,
     cluster,
+    domain,
+    vpc,
+    firewall,
 )
 from .commands.common import version_callback, version_option, verbose_option
 
 
-cli = TyperAlias(help=__doc__)
+cli = TyperAlias(
+    help=__doc__,
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
 cli.add_typer(config, name="config")
 cli.add_typer(account, name="account")
 cli.add_typer(server, name="server", aliases=["servers", "s"])
@@ -34,6 +41,9 @@ cli.add_typer(balancer, name="balancer", aliases=["balancers", "lb"])
 cli.add_typer(
     cluster, name="cluster", aliases=["clusters", "kubernetes", "k8s"]
 )
+cli.add_typer(domain, name="domain", aliases=["domains", "d"])
+cli.add_typer(vpc, name="vpc", aliases=["vpcs", "network", "networks"])
+cli.add_typer(firewall, name="firewall", aliases=["fw"])
 
 
 @cli.command("version")

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/__version__.py

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

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/api/base.py

@@ -17,7 +17,6 @@ class TimewebCloudBase:
     # pylint: disable=invalid-name
 
     API_BASE_URL = "https://api.timeweb.cloud"
-    API_PATH = "/api/v1"
     TIMEOUT = 100
     USER_AGENT = f"TWC-CLI/{__version__} Python {__pyversion__}"
 
@@ -25,7 +24,7 @@ class TimewebCloudBase:
         self,
         api_token: str,
         api_base_url: Optional[str] = API_BASE_URL,
-        api_path: Optional[str] = API_PATH,
+        api_path: Optional[str] = "/api/v1",
         headers: Optional[dict] = None,
         user_agent: Optional[str] = USER_AGENT,
         timeout: Optional[int] = TIMEOUT,
@@ -37,6 +36,8 @@ class TimewebCloudBase:
         self.api_base_url = api_base_url
         self.api_path = api_path
         self.api_url = self.api_base_url + self.api_path
+        self.api_url_v1 = self.api_base_url + "/api/v1"
+        self.api_url_v2 = self.api_base_url + "/api/v2"
         self.timeout = timeout
         self.headers = requests.utils.default_headers()
         self.headers["User-Agent"] = user_agent

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/api/client.py

@@ -3,10 +3,11 @@
 from typing import Optional, Union, List
 from uuid import UUID
 from pathlib import Path
-from ipaddress import IPv4Address, IPv6Address
+from ipaddress import IPv4Address, IPv6Address, IPv4Network, IPv6Network
 
 from .base import TimewebCloudBase
 from .types import (
+    DNSRecordType,
     ServerConfiguration,
     ServerAction,
     ServerLogOrder,
@@ -17,11 +18,13 @@ from .types import (
     BackupInterval,
     IPVersion,
     ServiceRegion,
-    ProjectResource,
+    ResourceType,
     DBMS,
     MySQLAuthPlugin,
     LoadBalancerProto,
     LoadBalancerAlgo,
+    FirewallProto,
+    FirewallDirection,
 )
 
 
@@ -67,8 +70,9 @@ class TimewebCloud(TimewebCloudBase):
         avatar_id: Optional[str] = None,
         software_id: Optional[int] = None,
         ssh_keys_ids: Optional[List[int]] = None,
-        is_local_network: bool = False,
+        is_local_network: Optional[bool] = None,
         is_ddos_guard: bool = False,
+        network: Optional[dict] = None,
     ):
         """Create new Cloud Server. Note:
 
@@ -91,7 +95,12 @@ class TimewebCloud(TimewebCloudBase):
             **({"software_id": software_id} if software_id else {}),
             **({"ssh_keys_ids": ssh_keys_ids} if ssh_keys_ids else {}),
             "is_ddos_guard": is_ddos_guard,
-            "is_local_network": is_local_network,
+            **(
+                {"is_local_network": is_local_network}
+                if is_local_network is not None
+                else {}
+            ),
+            **({"network": network} if network else {}),
             **({"configuration": configuration} if configuration else {}),
             **({"preset_id": preset_id} if preset_id else {}),
             **({"os_id": os_id} if os_id else {}),
@@ -574,7 +583,7 @@ class TimewebCloud(TimewebCloudBase):
         from_project: int,
         to_project: int,
         resource_id: int,
-        resource_type: ProjectResource,
+        resource_type: ResourceType,
     ):
         """Move resource to project."""
         payload = {
@@ -983,6 +992,7 @@ class TimewebCloud(TimewebCloudBase):
         proxy_protocol: bool = False,
         force_https: bool = False,
         backend_keepalive: bool = False,
+        network: Optional[dict] = None,
     ):
         """Create load balancer."""
         payload = {
@@ -1000,6 +1010,7 @@ class TimewebCloud(TimewebCloudBase):
             "is_use_proxy": proxy_protocol,
             "is_ssl": force_https,
             "is_keepalive": backend_keepalive,
+            **({"network": network} if network else {}),
         }
         return self._request("POST", f"{self.api_url}/balancers", json=payload)
 
@@ -1063,7 +1074,7 @@ class TimewebCloud(TimewebCloudBase):
         }
         return self._request(
             "DELETE",
-            f"{self.api_url}/balancers{balancer_id}",
+            f"{self.api_url}/balancers/{balancer_id}",
             params=params,
         )
 
@@ -1347,3 +1358,335 @@ class TimewebCloud(TimewebCloudBase):
     def get_k8s_presets(self):
         """List available Kubernetes nodes presets."""
         return self._request("GET", f"{self.api_url}/presets/k8s")
+
+    # -----------------------------------------------------------------------
+    # Domains
+
+    def get_domains(self, limit: int = 100, offset: int = 0):
+        """Get domains list."""
+        params = {"limit": limit, "offset": offset}
+        return self._request("GET", f"{self.api_url}/domains", params=params)
+
+    def get_domain(self, fqdn: str):
+        """Get domain."""
+        return self._request("GET", f"{self.api_url}/domains/{fqdn}")
+
+    def domain_turn_on_autoprolong(
+        self,
+        fqdn: str,
+        is_autoprolong_enabled: bool = False,
+    ):
+        """Turn off/on autoprolong domain."""
+        payload = {
+            "is_autoprolong_enabled": is_autoprolong_enabled,
+        }
+        return self._request(
+            "PATCH", f"{self.api_url}/domains/{fqdn}", json=payload
+        )
+
+    def delete_domain(self, fqdn: str):
+        """Delete Domain."""
+        return self._request("DELETE", f"{self.api_url}/domains/{fqdn}")
+
+    def add_domain(self, fqdn: str):
+        """Add Domain."""
+        return self._request("POST", f"{self.api_url}/add-domain/{fqdn}")
+
+    def get_domain_dns_records(
+        self, fqdn: str, limit: int = 100, offset: int = 0
+    ):
+        """Get domain DNS records."""
+        params = {"limit": limit, "offset": offset}
+        return self._request(
+            "GET", f"{self.api_url}/domains/{fqdn}/dns-records", params=params
+        )
+
+    def add_domain_dns_record(
+        self,
+        fqdn: str,
+        dns_record_type: DNSRecordType,
+        value: str,
+        subdomain: Optional[str] = None,
+        priority: Optional[int] = None,
+    ):
+        """Add DNS record to domain."""
+        payload = {
+            "type": dns_record_type,
+            "value": value,
+            **({"subdomain": subdomain} if subdomain else {}),
+            **({"priority": priority} if priority else {}),
+        }
+        return self._request(
+            "POST",
+            f"{self.api_url}/domains/{fqdn}/dns-records",
+            json=payload,
+        )
+
+    def update_domain_dns_record(
+        self,
+        fqdn: str,
+        record_id: int,
+        dns_record_type: DNSRecordType,
+        value: str,
+        subdomain: Optional[str] = None,
+        priority: Optional[int] = None,
+    ):
+        """Update DNS record on domain."""
+        payload = {
+            "type": dns_record_type,
+            "value": value,
+            **({"subdomain": subdomain} if subdomain else {}),
+            **({"priority": priority} if priority else {}),
+        }
+        return self._request(
+            "PATCH",
+            f"{self.api_url}/domains/{fqdn}/dns-records/{record_id}",
+            json=payload,
+        )
+
+    def delete_domain_dns_record(self, fqdn: str, record_id: int):
+        """Delete DNS record on domain."""
+        return self._request(
+            "DELETE",
+            f"{self.api_url}/domains/{fqdn}/dns-records/{record_id}",
+        )
+
+    def add_subdomain(self, fqdn: str, subdomain_fqdn: str):
+        """Add subdomian tp domain."""
+        return self._request(
+            "POST",
+            f"{self.api_url}/domains/{fqdn}/subdomains/{subdomain_fqdn}",
+        )
+
+    def delete_subdomain(self, fqdn: str, subdomain_fqdn: str):
+        """Add subdomian tp domain."""
+        return self._request(
+            "DELETE",
+            f"{self.api_url}/domains/{fqdn}/subdomains/{subdomain_fqdn}",
+        )
+
+    # -----------------------------------------------------------------------
+    # VPC
+
+    # API issue: Why some VPC methods belong to /api/v1 and others to /api/v2??
+
+    def get_vpcs(self):
+        """Return list of private networks."""
+        return self._request("GET", f"{self.api_url_v2}/vpcs")
+
+    def get_vpc(self, vpc_id: str):
+        """Return network information."""
+        return self._request("GET", f"{self.api_url_v2}/vpcs/{vpc_id}")
+
+    def create_vpc(
+        self,
+        name: str,
+        subnet: IPv4Network,
+        location: ServiceRegion,
+        description: Optional[str] = None,
+    ):
+        """Create new virtual private network."""
+        payload = {
+            "name": name,
+            "subnet_v4": subnet,
+            "location": location,
+            **({"description": description} if description else {}),
+        }
+        return self._request("POST", f"{self.api_url_v2}/vpcs", json=payload)
+
+    def update_vpc(
+        self,
+        vpc_id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+    ):
+        """Update network information."""
+        payload = {
+            **({"name": name} if name else {}),
+            **({"description": description} if description else {}),
+        }
+        return self._request(
+            "PATCH",
+            f"{self.api_url_v2}/vpcs/{vpc_id}",
+            json=payload,
+        )
+
+    def delete_vpc(self, vpc_id: str):
+        """Delete network."""
+        return self._request("DELETE", f"{self.api_url_v1}/vpcs/{vpc_id}")
+
+    def get_services_in_vpc(self, vpc_id: str):
+        """Return network information."""
+        return self._request(
+            "GET", f"{self.api_url_v2}/vpcs/{vpc_id}/services"
+        )
+
+    def get_vpc_ports(self, vpc_id: str):
+        """Return network information."""
+        return self._request("GET", f"{self.api_url_v1}/vpcs/{vpc_id}/ports")
+
+    # -----------------------------------------------------------------------
+    # Firewall
+
+    def get_firewall_groups(self, limit: int = 100, offset: int = 0):
+        """Get list of firewall groups."""
+        params = {"limit": limit, "offset": offset}
+        return self._request(
+            "GET", f"{self.api_url}/firewall/groups", params=params
+        )
+
+    def create_firewall_group(
+        self, name: str, description: Optional[str] = None
+    ):
+        payload = {
+            "name": name,
+            **({"description": description} if description else {}),
+        }
+        return self._request(
+            "POST", f"{self.api_url}/firewall/groups", json=payload
+        )
+
+    def get_firewall_group(self, group_id: UUID):
+        return self._request(
+            "GET", f"{self.api_url}/firewall/groups/{group_id}"
+        )
+
+    def delete_firewall_group(self, group_id: UUID):
+        return self._request(
+            "DELETE", f"{self.api_url}/firewall/groups/{group_id}"
+        )
+
+    def update_firewall_group(
+        self,
+        group_id: UUID,
+        name: str,
+        description: Optional[str] = None,
+    ):
+        payload = {
+            "name": name,
+            **({"description": description} if description else {}),
+        }
+        return self._request(
+            "PATCH", f"{self.api_url}/firewall/groups/{group_id}", json=payload
+        )
+
+    def get_firewall_group_resources(
+        self, group_id: UUID, limit: int = 100, offset: int = 0
+    ):
+        params = {"limit": limit, "offset": offset}
+        return self._request(
+            "GET",
+            f"{self.api_url}/firewall/groups/{group_id}/resources",
+            params=params,
+        )
+
+    def link_resource_to_firewall(
+        self,
+        group_id: UUID,
+        resource_id: Union[str, int],
+        resource_type: str,
+    ):
+        if resource_type not in ["server", "dbaas", "balancer"]:
+            raise ValueError("Invalid resource type")
+        return self._request(
+            "POST",
+            f"{self.api_url}/firewall/groups/{group_id}/resources/{resource_id}",
+            params={"resource_type": resource_type},
+        )
+
+    def unlink_resource_from_firewall(
+        self,
+        group_id: UUID,
+        resource_id: Union[str, int],
+        resource_type: str,
+    ):
+        if resource_type not in ["server", "dbaas", "balancer"]:
+            raise ValueError("Invalid resource type")
+        return self._request(
+            "DELETE",
+            f"{self.api_url}/firewall/groups/{group_id}/resources/{resource_id}",
+            params={"resource_type": resource_type},
+        )
+
+    def get_firewall_rules(
+        self, group_id: UUID, limit: int = 100, offset: int = 0
+    ):
+        """Get list of firewall rules."""
+        params = {"limit": limit, "offset": offset}
+        return self._request(
+            "GET",
+            f"{self.api_url}/firewall/groups/{group_id}/rules",
+            params=params,
+        )
+
+    def create_firewall_rule(
+        self,
+        group_id: UUID,
+        direction: FirewallDirection,
+        proto: FirewallProto,
+        cidr: Union[IPv4Network, IPv6Network],
+        port: Optional[str] = None,
+        description: Optional[str] = None,
+    ):
+        payload = {
+            **({"description": description} if description else {}),
+            **({} if proto == FirewallProto.ICMP.value else {"port": port}),
+            "direction": direction,
+            "protocol": proto,
+            "cidr": cidr,
+        }
+        return self._request(
+            "POST",
+            f"{self.api_url}/firewall/groups/{group_id}/rules",
+            json=payload,
+        )
+
+    def get_firewall_rule(self, group_id: UUID, rule_id: UUID):
+        return self._request(
+            "GET", f"{self.api_url}/firewall/groups/{group_id}/rules/{rule_id}"
+        )
+
+    def delete_firewall_rule(self, group_id: UUID, rule_id: UUID):
+        return self._request(
+            "DELETE",
+            f"{self.api_url}/firewall/groups/{group_id}/rules/{rule_id}",
+        )
+
+    def update_firewall_rule(
+        self,
+        group_id: UUID,
+        rule_id: UUID,
+        direction: FirewallDirection,
+        proto: FirewallProto,
+        cidr: Union[IPv4Network, IPv6Network],
+        port: Optional[str] = None,
+        description: Optional[str] = None,
+    ):
+        payload = {
+            **({"description": description} if description else {}),
+            **({} if proto == FirewallProto.ICMP.value else {"port": port}),
+            "direction": direction,
+            "protocol": proto,
+            "cidr": cidr,
+        }
+        return self._request(
+            "PATCH",
+            f"{self.api_url}/firewall/groups/{group_id}/rules/{rule_id}",
+            json=payload,
+        )
+
+    def get_resource_firewall_groups(
+        self,
+        resource_id: Union[int, str],
+        resource_type: str,
+        limit: int = 100,
+        offset: int = 0,
+    ):
+        params = {"limit": limit, "offset": offset}
+        if resource_type not in ["server", "dbaas", "balancer"]:
+            raise ValueError("Invalid resource type")
+        return self._request(
+            "GET",
+            f"{self.api_url}/firewall/service/{resource_type}/{resource_id}",
+            params=params,
+        )

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/api/types.py

@@ -111,8 +111,8 @@ class BackupInterval(str, Enum):
     MONTH = "month"
 
 
-class ProjectResource(str, Enum):
-    """Project resource types."""
+class ResourceType(str, Enum):
+    """Resource types."""
 
     SERVER = "server"
     BALANCER = "balancer"
@@ -162,3 +162,29 @@ class LoadBalancerAlgo(str, Enum):
 
     ROUND_ROBIN = "roundrobin"
     LEAST_CONNECTIONS = "leastconn"
+
+
+class DNSRecordType(str, Enum):
+    """Type DNS record"""
+
+    TXT = "TXT"
+    SRV = "SRV"
+    CNAME = "CNAME"
+    AAAA = "AAAA"
+    MX = "MX"
+    A = "A"
+
+
+class FirewallProto(str, Enum):
+    """Protocols supported by Firewall service."""
+
+    TCP = "tcp"
+    UDP = "udp"
+    ICMP = "icmp"
+
+
+class FirewallDirection(str, Enum):
+    """Traffic directions for Firewall service."""
+
+    INGRESS = "ingress"
+    EGRESS = "egress"

{twc_cli-2.3.0 → twc_cli-2.4.1}/twc/commands/__init__.py

@@ -10,3 +10,6 @@ from .database import database
 from .storage import storage
 from .balancer import balancer
 from .kubernetes import cluster
+from .domain import domain
+from .vpc import vpc
+from .firewall import firewall