linode-api4 5.45.0__tar.gz → 5.46.1__tar.gz

{linode_api4-5.45.0/linode_api4.egg-info → linode_api4-5.46.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linode_api4
-Version: 5.45.0
+Version: 5.46.1
 Summary: The official Python SDK for Linode API v4
 Author-email: Linode <devs@linode.com>
 License: BSD-3-Clause

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/groups/monitor.py

@@ -225,6 +225,7 @@ class MonitorGroup(Group):
         description: Optional[str] = None,
         scope: Optional[Union[AlertScope, str]] = None,
         regions: Optional[list[str]] = None,
+        group_by: Optional[list[str]] = None,
     ) -> AlertDefinition:
         """
         Create a new alert definition for a given service type.
@@ -258,6 +259,8 @@ class MonitorGroup(Group):
         :type scope: Optional[Union[AlertScope, str]]
         :param regions: (Optional) Regions to monitor.
         :type regions: Optional[list[str]]
+        :param group_by: (Optional) Aggregates metric data by dimension so that alert conditions are evaluated independently for each dimension value.
+        :type group_by: Optional[list[str]]
 
         :returns: The newly created :class:`AlertDefinition`.
         :rtype: AlertDefinition
@@ -282,6 +285,8 @@ class MonitorGroup(Group):
             params["scope"] = scope
         if regions is not None:
             params["regions"] = regions
+        if group_by is not None:
+            params["group_by"] = group_by
 
         # API will validate service_type and return an error if missing
         result = self.client.post(
@@ -296,6 +301,95 @@ class MonitorGroup(Group):
 
         return AlertDefinition(self.client, result["id"], service_type, result)
 
+    def clone_alert_definition(
+        self,
+        service_type: str,
+        id: int,
+        label: str,
+        description: Optional[str] = None,
+        scope: Optional[Union[AlertScope, str]] = None,
+        regions: Optional[list[str]] = None,
+        entity_ids: Optional[list[str]] = None,
+        severity: Optional[int] = None,
+        rule_criteria: Optional[dict] = None,
+        trigger_conditions: Optional[dict] = None,
+        channel_ids: Optional[list[int]] = None,
+        group_by: Optional[list[str]] = None,
+    ) -> AlertDefinition:
+        """
+        Clone an existing alert definition for a given service type.
+        The clone request creates a new alert definition based on the source
+        definition identified by ``id``.
+
+        API Documentation: TODO
+
+        :param service_type: Service type for the source alert definition
+                             (e.g. ``"dbaas"``).
+        :type service_type: str
+        :param id: Source alert definition identifier.
+        :type id: int (Alert identifier)
+        :param label: Human-readable label for the cloned alert definition.
+                      This value is mandatory and must be unique.
+        :type label: str
+        :param description: (Optional) Longer description for the cloned alert definition.
+        :type description: Optional[str]
+        :param scope: (Optional) Alert scope provided in the clone request.
+                      Scope is inherited from the source alert and is immutable.
+        :type scope: Optional[Union[AlertScope, str]]
+        :param regions: (Optional) Regions to monitor.
+        :type regions: Optional[list[str]]
+        :param entity_ids: (Optional) Restrict the alert to a subset of entity IDs.
+        :type entity_ids: Optional[list[str]]
+        :param severity: (Optional) Severity level for the alert.
+        :type severity: Optional[int]
+        :param rule_criteria: (Optional) Rule criteria used to evaluate the alert.
+        :type rule_criteria: Optional[dict]
+        :param trigger_conditions: (Optional) Trigger conditions for alert state transitions.
+        :type trigger_conditions: Optional[dict]
+        :param channel_ids: (Optional) List of alert channel IDs to notify.
+        :type channel_ids: Optional[list[int]]
+        :param group_by: (Optional) Aggregates metric data by dimension so that alert conditions are evaluated independently for each dimension value.
+        :type group_by: Optional[list[str]]
+
+        :returns: The newly created cloned :class:`AlertDefinition`.
+        :rtype: AlertDefinition
+        """
+        params = {
+            "label": label,
+        }
+
+        if description is not None:
+            params["description"] = description
+        if scope is not None:
+            params["scope"] = scope
+        if regions is not None:
+            params["regions"] = regions
+        if entity_ids is not None:
+            params["entity_ids"] = entity_ids
+        if severity is not None:
+            params["severity"] = severity
+        if rule_criteria is not None:
+            params["rule_criteria"] = rule_criteria
+        if trigger_conditions is not None:
+            params["trigger_conditions"] = trigger_conditions
+        if channel_ids is not None:
+            params["channel_ids"] = channel_ids
+        if group_by is not None:
+            params["group_by"] = group_by
+
+        result = self.client.post(
+            f"/monitor/services/{service_type}/alert-definitions/{id}/clone",
+            data=params,
+        )
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when cloning alert definition!",
+                json=result,
+            )
+
+        return AlertDefinition(self.client, result["id"], service_type, result)
+
     def alert_definition_entities(
         self,
         service_type: str,

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/groups/object_storage.py

@@ -429,8 +429,8 @@ class ObjectStorageGroup(Group):
                 json=result,
             )
 
-        return ObjectStorageBucket(
-            self.client, result["label"], result["cluster"], result
+        return ObjectStorageBucket.make_instance(
+            result["label"], self.client, json=result
         )
 
     def object_acl_config(self, cluster_or_region_id: str, bucket, name=None):

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/groups/vpc.py

@@ -2,7 +2,14 @@ from typing import Any, Dict, List, Optional, Union
 
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
-from linode_api4.objects import VPC, Region, VPCIPAddress, VPCIPv6RangeOptions
+from linode_api4.objects import (
+    VPC,
+    Region,
+    VPCIPAddress,
+    VPCIPv4DefaultRange,
+    VPCIPv4RangeOptions,
+    VPCIPv6RangeOptions,
+)
 from linode_api4.objects.base import _flatten_request_body_recursive
 from linode_api4.paginated_list import PaginatedList
 from linode_api4.util import drop_null_keys
@@ -36,6 +43,7 @@ class VPCGroup(Group):
         description: Optional[str] = None,
         subnets: Optional[List[Dict[str, Any]]] = None,
         ipv6: Optional[List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]] = None,
+        ipv4: Optional[List[Union[VPCIPv4RangeOptions, Dict[str, Any]]]] = None,
         **kwargs,
     ) -> VPC:
         """
@@ -53,6 +61,8 @@ class VPCGroup(Group):
         :type subnets: List[Dict[str, Any]]
         :param ipv6: The IPv6 address ranges for this VPC.
         :type ipv6: List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]
+        :param ipv4: The IPv4 address ranges for this VPC. Note that IPv4 VPCs may not currently be available to all users.
+        :type ipv4: List[Union[VPCIPv4RangeOptions, Dict[str, Any]]]
 
         :returns: The new VPC object.
         :rtype: VPC
@@ -61,6 +71,7 @@ class VPCGroup(Group):
             "label": label,
             "region": region.id if isinstance(region, Region) else region,
             "description": description,
+            "ipv4": ipv4,
             "ipv6": ipv6,
             "subnets": subnets,
         }
@@ -108,3 +119,15 @@ class VPCGroup(Group):
         return self.client._get_and_filter(
             VPCIPAddress, *filters, endpoint="/vpcs/ips"
         )
+
+    def default_ranges(self) -> VPCIPv4DefaultRange:
+        """
+        Retrieve the default settings for the internal and forbidden IPv4 address ranges in VPCs.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpcs-default-ranges
+
+        :returns: The default IPv4 ranges for VPCs.
+        :rtype: VPCIPv4DefaultRange
+        """
+        result = self.client.get("/vpcs/default-ranges")
+        return VPCIPv4DefaultRange.from_json(result)

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/objects/monitor.py

@@ -499,6 +499,7 @@ class AlertDefinition(DerivedBase):
         "regions": Property(mutable=True),
         "entities": Property(json_object=AlertEntities),
         "channel_ids": Property(mutable=True),
+        "group_by": Property(mutable=True),
     }
 
 

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/objects/vpc.py

@@ -10,6 +10,36 @@ from linode_api4.paginated_list import PaginatedList
 from linode_api4.util import drop_null_keys
 
 
+@dataclass
+class VPCIPv4DefaultRange(JSONObject):
+    """
+    VPCIPv4DefaultRange represents the default settings for the internal and forbidden IPv4 address ranges in VPCs.
+    """
+
+    default_ipv4_ranges: Optional[List[str]] = None
+    forbidden_ipv4_ranges: Optional[List[str]] = None
+
+
+@dataclass
+class VPCIPv4RangeOptions(JSONObject):
+    """
+    VPCIPv4RangeOptions is used to specify an IPv4 range when creating or updating a VPC.
+    """
+
+    range: Optional[str] = None
+
+
+@dataclass
+class VPCIPv4Range(JSONObject):
+    """
+    VPCIPv4Range represents a single VPC IPv4 range.
+    """
+
+    put_class = VPCIPv4RangeOptions
+
+    range: str = ""
+
+
 @dataclass
 class VPCIPv6RangeOptions(JSONObject):
     """
@@ -108,6 +138,10 @@ class VPC(Base):
         "label": Property(mutable=True),
         "description": Property(mutable=True),
         "region": Property(slug_relationship=Region),
+        # Note that IPv4 VPCs may not currently be available to all users.
+        "ipv4": Property(
+            json_object=VPCIPv4Range, mutable=True, unordered=True
+        ),
         "ipv6": Property(json_object=VPCIPv6Range, unordered=True),
         "subnets": Property(derived_class=VPCSubnet),
         "created": Property(is_datetime=True),

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4/version.py

@@ -2,4 +2,4 @@
 The version of this linode_api4 package.
 """
 
-__version__ = "v5.45.0"
+__version__ = "v5.46.1"

{linode_api4-5.45.0 → linode_api4-5.46.1/linode_api4.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linode_api4
-Version: 5.45.0
+Version: 5.46.1
 Summary: The official Python SDK for Linode API v4
 Author-email: Linode <devs@linode.com>
 License: BSD-3-Clause

{linode_api4-5.45.0 → linode_api4-5.46.1}/linode_api4.egg-info/SOURCES.txt

@@ -196,6 +196,7 @@ test/fixtures/monitor_services.json
 test/fixtures/monitor_services_dbaas.json
 test/fixtures/monitor_services_dbaas_alert-definitions.json
 test/fixtures/monitor_services_dbaas_alert-definitions_12345.json
+test/fixtures/monitor_services_dbaas_alert-definitions_12345_clone.json
 test/fixtures/monitor_services_dbaas_alert-definitions_12345_entities.json
 test/fixtures/monitor_services_dbaas_dashboards.json
 test/fixtures/monitor_services_dbaas_metric-definitions.json
@@ -282,6 +283,7 @@ test/fixtures/vpcs_123456.json
 test/fixtures/vpcs_123456_ips.json
 test/fixtures/vpcs_123456_subnets.json
 test/fixtures/vpcs_123456_subnets_789.json
+test/fixtures/vpcs_default-ranges.json
 test/fixtures/vpcs_ips.json
 test/integration/__init__.py
 test/integration/conftest.py

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/fixtures/monitor_alert-definitions.json

@@ -9,6 +9,9 @@
       "description": "A test alert for dbaas service",
       "scope": "entity",
       "regions": [],
+      "group_by": [
+        "entity_id"
+      ],
       "entities": {
         "url": "/monitor/services/dbaas/alert-definitions/12345/entities",
         "count": 1,

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/fixtures/monitor_services_dbaas_alert-definitions.json

@@ -9,6 +9,9 @@
       "description": "A test alert for dbaas service",
       "scope": "entity",
       "regions": [],
+      "group_by": [
+        "entity_id"
+      ],
       "entities": {
         "url": "/monitor/services/dbaas/alert-definitions/12345/entities",
         "count": 1,
@@ -48,8 +51,8 @@
         "polling_interval_seconds": 60,
         "trigger_occurrences": 3
       },
-      "class": "alert",
-      "status": "active",
+      "class": "",
+      "status": "enabled",
       "created": "2024-01-01T00:00:00",
       "updated": "2024-01-01T00:00:00",
       "updated_by": "tester"

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/fixtures/monitor_services_dbaas_alert-definitions_12345.json

@@ -7,6 +7,9 @@
   "description": "A test alert for dbaas service",
   "scope": "entity",
   "regions": [],
+  "group_by": [
+    "entity_id"
+  ],
   "entities": {
     "url": "/monitor/services/dbaas/alert-definitions/12345/entities",
     "count": 1,
@@ -46,8 +49,8 @@
     "polling_interval_seconds": 60,
     "trigger_occurrences": 3
   },
-  "class": "alert",
-  "status": "active",
+  "class": "",
+  "status": "enabled",
   "created": "2024-01-01T00:00:00",
   "updated": "2024-01-01T00:00:00",
   "updated_by": "tester"

linode_api4-5.46.1/test/fixtures/monitor_services_dbaas_alert-definitions_12345_clone.json

@@ -0,0 +1,57 @@
+{
+  "id": 67891,
+  "label": "Cloned Alert",
+  "service_type": "dbaas",
+  "severity": 1,
+  "type": "user",
+  "description": "Cloned from source alert",
+  "scope": "entity",
+  "regions": [],
+  "group_by": [
+    "entity_id"
+  ],
+  "entities": {
+    "url": "/monitor/services/dbaas/alert-definitions/67891/entities",
+    "count": 1,
+    "has_more_resources": false
+  },
+  "alert_channels": [
+    {
+      "id": 10000,
+      "label": "Read-Write Channel",
+      "type": "email",
+      "url": "/monitor/alert-channels/10000"
+    }
+  ],
+  "rule_criteria": {
+    "rules": [
+      {
+        "aggregate_function": "avg",
+        "dimension_filters": [
+          {
+            "dimension_label": "node_type",
+            "label": "Node Type",
+            "operator": "eq",
+            "value": "primary"
+          }
+        ],
+        "label": "High CPU Usage",
+        "metric": "cpu_usage",
+        "operator": "gt",
+        "threshold": 90,
+        "unit": "percent"
+      }
+    ]
+  },
+  "trigger_conditions": {
+    "criteria_condition": "ALL",
+    "evaluation_period_seconds": 300,
+    "polling_interval_seconds": 60,
+    "trigger_occurrences": 3
+  },
+  "class": "",
+  "status": "enabled",
+  "created": "2024-01-01T00:00:00",
+  "updated": "2024-01-01T00:00:00",
+  "updated_by": "tester"
+}

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/fixtures/vpcs.json

@@ -5,6 +5,11 @@
       "id": 123456,
       "description": "A very real VPC.",
       "region": "us-southeast",
+      "ipv4": [
+        {
+          "range": "10.0.0.0/8"
+        }
+      ],
       "ipv6": [
         {
           "range": "fd71:1140:a9d0::/52"

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/fixtures/vpcs_123456.json

@@ -3,6 +3,11 @@
   "id": 123456,
   "description": "A very real VPC.",
   "region": "us-southeast",
+  "ipv4": [
+    {
+      "range": "10.0.0.0/8"
+    }
+  ],
   "ipv6": [
     {
       "range": "fd71:1140:a9d0::/52"

linode_api4-5.46.1/test/fixtures/vpcs_default-ranges.json

@@ -0,0 +1,10 @@
+{
+  "default_ipv4_ranges": [
+    "10.0.0.0/8",
+    "192.168.0.0/17"
+  ],
+  "forbidden_ipv4_ranges": [
+    "172.17.0.0/16"
+  ]
+}
+

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/integration/conftest.py

@@ -286,6 +286,7 @@ def test_linode_client():
         token,
         base_url=api_url,
         ca_path=api_ca_file,
+        retry_statuses=[504],
     )
     return client
 
@@ -473,7 +474,13 @@ def create_vpc(test_linode_client):
     vpc = client.vpcs.create(
         label=label,
         region=get_region(
-            test_linode_client, {"VPCs", "VPC IPv6 Stack", "Linode Interfaces"}
+            test_linode_client,
+            {
+                "VPCs",
+                "VPC IPv6 Stack",
+                "Linode Interfaces",
+                "Custom VPC IPv4 Ranges",
+            },
         ),
         description="test description",
         ipv6=[{"range": "auto"}],
@@ -518,6 +525,22 @@ def create_vpc_with_subnet_and_linode(
     instance.delete()
 
 
+@pytest.fixture
+def create_vpc_with_ipv4(test_linode_client):
+    client = test_linode_client
+
+    vpc = client.vpcs.create(
+        label=get_test_label(length=10),
+        region=get_region(client, {"VPCs", "Custom VPC IPv4 Ranges"}),
+        description="integration test vpc with ipv4",
+        ipv4=[{"range": "10.0.0.0/8"}],
+    )
+
+    yield vpc
+
+    vpc.delete()
+
+
 @pytest.fixture(scope="session")
 def create_multiple_vpcs(test_linode_client):
     client = test_linode_client

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/integration/models/linode/test_linode.py

@@ -23,6 +23,7 @@ from linode_api4.objects import (
     Type,
 )
 from linode_api4.objects.linode import InstanceDiskEncryptionType, MigrationType
+from linode_api4.objects.region import RegionAvailabilityEntry
 
 
 @pytest.fixture(scope="session")
@@ -119,12 +120,23 @@ def linode_and_vpc_for_legacy_interface_tests_offline(
 @pytest.fixture(scope="session")
 def linode_for_vpu_tests(test_linode_client, e2e_test_firewall):
     client = test_linode_client
-    region = "us-lax"
+    vpu_type = "g1-accelerated-netint-vpu-t1u1-s"
+
+    availability = client.regions.availability(
+        RegionAvailabilityEntry.filters.plan == vpu_type
+    )
+
+    region = next(
+        (entry.region for entry in availability if entry.available), None
+    )
+
+    if region is None:
+        pytest.skip("No VPU capacity is currently available")
 
     label = get_test_label(length=8)
 
     linode_instance = client.linode.instance_create(
-        "g1-accelerated-netint-vpu-t1u1-s",
+        vpu_type,
         region,
         image="linode/debian12",
         label=label,
@@ -848,21 +860,14 @@ def test_get_linode_types(test_linode_client):
     for linode_type in types:
         assert hasattr(linode_type, "accelerated_devices")
 
-
-def test_get_linode_types_overrides(test_linode_client):
-    types = test_linode_client.linode.types()
-
-    target_types = [
+    regional_priced_types = [
         v
         for v in types
         if len(v.region_prices) > 0 and v.region_prices[0].hourly > 0
     ]
 
-    assert len(target_types) > 0
-
-    for linode_type in target_types:
-        assert linode_type.region_prices[0].hourly >= 0
-        assert linode_type.region_prices[0].monthly >= 0
+    assert any(v.region_prices[0].hourly > 0 for v in regional_priced_types)
+    assert any(v.region_prices[0].monthly > 0 for v in regional_priced_types)
 
 
 @pytest.mark.flaky(reruns=3, reruns_delay=2)

{linode_api4-5.45.0 → linode_api4-5.46.1}/test/integration/models/lke/test_lke.py

@@ -1,5 +1,4 @@
 import base64
-import re
 from test.integration.conftest import get_region
 from test.integration.helpers import (
     get_test_label,
@@ -226,16 +225,6 @@ def test_node_pool_create_with_disk_encryption(test_linode_client, lke_cluster):
         pool.delete()
 
 
-def test_cluster_dashboard_url_view(lke_cluster):
-    cluster = lke_cluster
-
-    url = send_request_when_resource_available(
-        300, cluster.cluster_dashboard_url_view
-    )
-
-    assert re.search("https://+", url)
-
-
 def test_get_and_delete_kubeconfig(lke_cluster):
     cluster = lke_cluster