Provider no longer handles pagination in Metal API endpoints

[ctreatma]

What steps did you take and what happened:

N/A; I haven't observed an impact of this bug (depending on how the provider is used--for example, if every cluster has its own project and/or the total number of devices is less than the default page size for the devices API--it doesn't necessarily have an impact.

What did you expect to happen:

For Metal API endpoints that include pagination details (a meta object with current page, total number of pages, etc.), the provider should automatically navigate pagination. Alternatively: auto-page-navigation support could be added as a feature in metal-go and this provider updated to use that new features.

Anything else you would like to add:

The pager module in metal-cli is a good reference for implementing auto-page-navigation in a metal-go-based tool: https://github.com/equinix/metal-cli/blob/main/internal/pagination/pager.go

Environment:

• cluster-api-provider-packet version:
• Kubernetes version: (use kubectl version):
• OS (e.g. from /etc/os-release):

[displague]

Anywhere that we are listing is somewhere that we could miss the desired resource by not paginating. Some examples:

• cluster-api-provider-packet/pkg/cloud/packet/client.go

  Line 246 in 9cb902b

  devices, _, err := p.DevicesApi.FindProjectDevices(ctx, project).Execute() //nolint:bodyclose // see https://github.com/timakin/bodyclose/issues/42

• cluster-api-provider-packet/pkg/cloud/packet/client.go

  Line 363 in 9cb902b

  reservedIPs, _, err := p.IPAddressesApi.FindIPReservations(ctx, projectID).Execute() //nolint:bodyclose // see https://github.com/timakin/bodyclose/issues/42

(These are the only Find* methods that I found in cluster-api-provider-packet/pkg/cloud/packet
/client.go that look to require pagination)

[displague]

@cprivitere points out that the EM API spec for these functions do not explicitly say that the results are paginated, they say that they return "all" of the resources.

[ctreatma]

Does this issue still need to be addressed?

Both metal-go and its replacement equinix-sdk-go include built-in methods for automatic page navigation. For example: https://github.com/equinix/equinix-sdk-go/blob/cbfa94f/services/metalv1/api_projects.go#L1698

Those automatic pagination methods should provide equivalent behavior to what the previous packngo-based provider was doing.

[cprivitere]

As @ctreatma points out, this is no longer necessary.

[ctreatma]

The SDK provides pagination functions now, but I don't think we're using them yet in this project. I only see Execute() calls, nothing using ExecuteWithPagination().