new: Add support for Placement Groups by lgarber-akamai · Pull Request #396 · linode/linode_api4-python

lgarber-akamai · 2024-04-16T18:29:31Z

📝 Description

This pull request adds support for the upcoming Placement Groups feature, including the following changes:

New Endpoints:
- POST placement/groups
- GET placement/groups
- GET placement/groups/{pg_id}
- PUT placement/groups/{pg_id}
- POST placement/groups/{pg_id}/assign
- POST placement/groups/{pg_id}/unassign
- DELETE placement/groups/{pg_id}
Updated Endpoints:
- GET /linode/instances & /linode/instances/{linode_id} - Updated to include PG info
- POST /linode/instances - Updated to accept a PG to assign the Linode to on creation
- POST /linode/instances/{linode_id}/migrate - Updated to accept a PG to assign the Linode to on creation
- POST /linode/instances/{linode_id}/clone - Updated to accept a PG to assign the Linode to on creation
- GET /regions & /regions/{region_id} - Updated to include PG limits

This pull request also contains the corresponding unit and integration tests.

✔️ How to Test

The following test steps assume you have pulled down this PR locally and run make install.

Additionally, these tests will not currently run against production so the target API URL will need to be overridden.
e.g.

export LINODE_API_URL=https://.../v4beta
export LINODE_API_CA=$PWD/cacert.pem
export LINODE_TOKEN=...

Unit Testing

make testunit

Integration Testing

make INTEGRATION_TEST_PATH=models/test_placement.py testint

Manual Testing

In a linode_api4 sandbox environment (e.g. dx-devenv), run the following:

import os

from linode_api4 import LinodeClient, PlacementGroupAffinityType

client = LinodeClient(
    os.getenv("LINODE_TOKEN"),
    base_url="https://.../v4beta",
    ca_path="cacert.pem"
)

placement_group = client.placement.group_create(
    "test-pg",
    "eu-west",
    PlacementGroupAffinityType.anti_affinity_local
)

instance = client.linode.instance_create(
    "g6-nanode-1",
    placement_group.region,
    label="test-instance",
    placement_group=placement_group,
)

# Invalidate the placement group to refresh the members
placement_group.invalidate()

print(instance)
print(placement_group)
print("Instance.placement_group:", instance.placement_group)
print("PG.members:", placement_group.members)

Ensure the output looks similar to the following:

Instance: 25137082
PlacementGroup: 597
Instance.placement_group: PlacementGroup: 597
PG.members: [PlacementGroupMember(linode_id=25137082, is_compliant=True)]

Navigate to the PG & Instance in Cloud Manager and ensure everything is configured as expected.
Alter the script to test other features added in this PR.

lgarber-akamai · 2024-04-16T18:57:52Z

+from linode_api4.objects.region import Region
+
+
+class PlacementAPIGroup(Group):


I'm not quite sure what to name this class given the convention here would be {route_name}Group, but that conflicts with PlacementGroup

Otherwise I can think of PlacementsGroup, but I think the current naming PlacementAPIGroup is less confusing and probably the best way to go 👍

lgarber-akamai · 2024-04-16T18:58:31Z

        return self._transfer

+    @property
+    def placement_group(self) -> Optional[PlacementGroup]:


Surely there's a way better way to do this, but for the time being we don't have a way to transform an arbitrary ID into an object like we can with derived classes & slugs.

lgarber-akamai · 2024-04-17T16:25:47Z

+
+
+@dataclass
+class PlacementGroupMember(JSONObject):


In the future it'd be nice to have a property method to access the underlying Linode object from here.

lgarber-akamai · 2024-04-17T18:48:03Z

        return len(vars(self))
+
+
+class StrEnum(str, Enum):


Like the comment says, we can remove this in favor of the official StrEnum class once Python 3.11 is our minimum supported version 👍

lgarber-akamai · 2024-04-17T20:05:51Z

Docs preview: https://linode-api4--396.org.readthedocs.build/en/396/

yec-akamai

LGTM! Just small comments.

I'm getting 500: Internal server error currently when running the integration tests. It's probably an api issue ongoing? Will try again later.

yec-akamai · 2024-04-24T15:04:25Z

+from linode_api4.objects.region import Region
+
+
+class PlacementAPIGroup(Group):


Otherwise I can think of PlacementsGroup, but I think the current naming PlacementAPIGroup is less confusing and probably the best way to go 👍

lgarber-akamai · 2024-04-24T16:11:39Z

LGTM! Just small comments.

I'm getting 500: Internal server error currently when running the integration tests. It's probably an api issue ongoing? Will try again later.

@yec-akamai Assuming you're running against Alpha it's probably an API issue. I'll look into it and let you know once it's been fixed 👍

edit: Just confirmed this is an API error

yec-akamai

Works well on my end!

For some reason the test region eu-west doesn't work for me. It raised linode_api4.errors.ApiError: 403: The Linode plan you chose is not currently available in the selected region. Please select another region or plan type, or contact Support for assistance. But I switched to use other region, i.e. us-east, can work and pass the tests.

lgarber-akamai · 2024-04-29T16:42:41Z

Works well on my end!

For some reason the test region eu-west doesn't work for me. It raised linode_api4.errors.ApiError: 403: The Linode plan you chose is not currently available in the selected region. Please select another region or plan type, or contact Support for assistance. But I switched to use other region, i.e. us-east, can work and pass the tests.

@yec-akamai Thanks for taking a second look! The eu-west issue is known internally so I switched over to us-east for the time being 👍

ykim-akamai

Apologies for taking long reviewing this, verified test and manual steps locally with changing region to 'us-east'. Excellent work!

lgarber-akamai added 7 commits April 16, 2024 12:46

WIP

7f83c03

progress

c79ef71

Add affinity type enum

926d077

Update region

60717a1

progress

5cc4d6d

various changes

2c33b38

rename obj file

7f0892e

lgarber-akamai commented Apr 16, 2024

View reviewed changes

lgarber-akamai added 7 commits April 16, 2024 15:05

fix pg logic

21ea60a

refactor

dd1234a

fix lint

722d03e

fix circular dep

485fefb

add ignore

1f89944

Add tests; populate on assignment

34f6cf9

fix imports

cce1a74

lgarber-akamai commented Apr 17, 2024

View reviewed changes

lgarber-akamai added 6 commits April 17, 2024 12:31

Add inst POST pg test

5856899

start e2e

7c0166f

Add int tests

9e252bf

Support PG as argument

997b72e

Fix enum compatibility for Python < 3.11

78ff342

Fix minor issues

9155bd1

lgarber-akamai marked this pull request as ready for review April 17, 2024 18:46

lgarber-akamai requested a review from a team as a code owner April 17, 2024 18:46

lgarber-akamai requested review from yec-akamai and ykim-akamai and removed request for a team April 17, 2024 18:46

lgarber-akamai commented Apr 17, 2024

View reviewed changes

jriddle-linode added the new-feature for new features in the changelog. label Apr 17, 2024

yec-akamai reviewed Apr 24, 2024

View reviewed changes

lgarber-akamai added 2 commits April 24, 2024 12:31

Fix error message

49a437d

Update region unit test

6943fec

yec-akamai approved these changes Apr 29, 2024

View reviewed changes

Update PG default region

d1e0ac9

ykim-akamai approved these changes May 1, 2024

View reviewed changes

lgarber-akamai merged commit 0c039d8 into linode:proj/vm-placement May 1, 2024

Navigation Menu

Uh oh!

new: Add support for Placement Groups - #396

new: Add support for Placement Groups#396
lgarber-akamai merged 23 commits into
linode:proj/vm-placementfrom
lgarber-akamai:new/vm-placement

lgarber-akamai commented Apr 16, 2024 •

edited

Loading

Uh oh!

lgarber-akamai Apr 16, 2024

Uh oh!

yec-akamai Apr 24, 2024

Uh oh!

lgarber-akamai Apr 16, 2024

Uh oh!

lgarber-akamai Apr 17, 2024

Uh oh!

lgarber-akamai Apr 17, 2024

Uh oh!

lgarber-akamai commented Apr 17, 2024

Uh oh!

yec-akamai left a comment •

edited

Loading

Uh oh!

yec-akamai Apr 24, 2024

Uh oh!

Uh oh!

lgarber-akamai commented Apr 24, 2024 •

edited

Loading

Uh oh!

yec-akamai left a comment

Uh oh!

lgarber-akamai commented Apr 29, 2024

Uh oh!

ykim-akamai left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		from linode_api4.objects.region import Region


		class PlacementAPIGroup(Group):

Uh oh!

Conversation

lgarber-akamai commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

✔️ How to Test

Unit Testing

Integration Testing

Manual Testing

Uh oh!

lgarber-akamai Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

yec-akamai Apr 24, 2024

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai Apr 17, 2024

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai Apr 17, 2024

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai commented Apr 17, 2024

Uh oh!

yec-akamai left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yec-akamai Apr 24, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lgarber-akamai commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yec-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

lgarber-akamai commented Apr 29, 2024

Uh oh!

ykim-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lgarber-akamai commented Apr 16, 2024 •

edited

Loading

yec-akamai left a comment •

edited

Loading

lgarber-akamai commented Apr 24, 2024 •

edited

Loading