new: [BREAKING] Add support for LKE Control Plane ACL

[lgarber-akamai]

📝 Description

This pull request adds support for the upcoming LKE Control Plane ACL feature, including the following changes:

Updated Endpoints

• GET /lke/clusters - Updated to include ACL under control_plane field
• GET /lke/clusters/{cluster_id} - Updated to include ACL under control_plane field
• POST /lke/clusters - Updated to include ACL under control_plane field
• PUT /lke/clusters/{cluster_id} - Updated to include ACL under control_plane field

New Endpoints

• GET /lke/clusters/{cluster_id}/control_plane_acl
• PUT /lke/clusters/{cluster_id}/control_plane_acl
• DELETE /lke/clusters/{cluster_id}/control_plane_acl

New Event Action Constants

• lke_control_plane_acl_create
• lke_control_plane_acl_update
• lke_control_plane_acl_delete

✔️ How to Test

The following test steps assume you have pulled down this repo locally and have configured your Linode account according to the guidelines commented on TPT-2854.

Integration Testing

make fixtures ARGS="-run TestLKECluster_withACL"

Manual Testing

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

package main

import (
	"context"
	"fmt"
	"github.com/sanity-io/litter"
	"log"
	"os"

	"github.com/linode/linodego"
)

func main() {
	ctx := context.Background()

	client := linodego.NewClient(nil)
	client.SetToken(os.Getenv("LINODE_TOKEN"))

	valueTrue := true

	// Create an LKE cluster with an allowed control plane IP
	cluster, err := client.CreateLKECluster(
		ctx,
		linodego.LKEClusterCreateOptions{
			Label:      "linodego-manual-test",
			Region:     "us-mia",
			K8sVersion: "1.29",
			NodePools: []linodego.LKENodePoolCreateOptions{
				{
					Type:  "g6-standard-1",
					Count: 1,
				},
			},
			ControlPlane: &linodego.LKEClusterControlPlaneOptions{
				ACL: &linodego.LKEClusterControlPlaneACLOptions{
					Enabled: &valueTrue,
					Addresses: &linodego.LKEClusterControlPlaneACLAddressesOptions{
						IPv4: &[]string{"10.0.0.1/32"},
					},
				},
			},
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	// Manually retrieve the ACL since it isn't yet returned
	// from the LKE cluster response endpoint
	acl, err := client.GetLKEClusterControlPlaneACL(ctx, cluster.ID)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println("Cluster ID:", cluster.ID)
	fmt.Println("Cluster ACL Configuration:", litter.Sdump(acl))

	acl, err = client.UpdateLKEClusterControlPlaneACL(
		ctx,
		cluster.ID,
		linodego.LKEClusterControlPlaneACLUpdateOptions{
			ACL: linodego.LKEClusterControlPlaneACLOptions{
				Addresses: &linodego.LKEClusterControlPlaneACLAddressesOptions{
					IPv4: &[]string{"10.0.0.5/32"},
				},
			},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Updated Cluster ACL Configuration:", litter.Sdump(acl))
}

2. Ensure the output looks similar to the following:

Cluster ID: 173797
Cluster ACL Configuration: &linodego.LKEClusterControlPlaneACLResponse{
  ACL: linodego.LKEClusterControlPlaneACL{
    Enabled: &true,
    Addresses: &linodego.LKEClusterControlPlaneACLAddresses{
      IPv4: []string{
        "10.0.0.1/32",
      },
      IPv6: nil,
    },
  },
}
Updated Cluster ACL Configuration: &linodego.LKEClusterControlPlaneACLResponse{
  ACL: linodego.LKEClusterControlPlaneACL{
    Enabled: &true,
    Addresses: &linodego.LKEClusterControlPlaneACLAddresses{
      IPv4: []string{
        "10.0.0.5/32",
      },
      IPv6: nil,
    },
  },
}

[lgarber-akamai]

This was originally added in the parent/child project branch

[lgarber-akamai]

As a team we decided to go ahead with this breaking change 🙂

[lgarber-akamai]

A pointer to a slice might be considered an anti-pattern but in this case we need omitempty to only apply to nil values.

[lgarber-akamai]

I didn't quite know what to name this response struct. For reference, this response body is unique to GetLKEClusterControlPlaneACL(...) and UpdateLKEClusterControlPlaneACL(...).

[lgarber-akamai]

I'm slightly concerned about the UX impact of making all update fields pointers but I don't think there's a better way to do it.

Maybe we could introduce a helper like this to make defining pointers to literals bit cleaner?

func Optional[T any](value T) *T {
	return &value
}

// Usage: linodego.Optional("test-string")

[yec-akamai]

I think adding this helper is a good idea 👍

[lgarber-akamai]

@yec-akamai Sounds good! I'll track adding that helper as a separate ticket/PR just to keep the scope of this PR reasonable 🙂

[yec-akamai]

Great work! Tests passed locally 🎉

[yec-akamai]

I think adding this helper is a good idea 👍

[ykim-1]

LGTM, Tests pass locally. Should we add the required customer tag to all the test account?

[lgarber-akamai]

LGTM, Tests pass locally. Should we add the required customer tag to all the test account?

@ykim-1 Great idea, yeah we should definitely add the customer tag until this reaches GA