fix: Enforce name consistency (#28)

Co-authored-by: guofei <guofei@microsoft.com>

README.md

@@ -31,3 +31,6 @@ You should have a running controller in `gpu-provisioner` namespace.
 
 ## How to test
 After deploying the controller successfully, one can apply the yaml in `/example` to create a machine CR. A real node will be created and added to the cluster by the controller.
+
+## Important note
+The gpu-provisioner assumes the Machine CR name is **equal** to the agent pool name. Hence, **the machine CR name must be 1-11 characters in length, start with a letter, and the only allowed characters are letters and numbers**.

examples/machine-gpu.yaml

@@ -1,7 +1,7 @@
 apiVersion: karpenter.sh/v1alpha5
 kind: Machine
 metadata:
-  name: machine-gpu-1
+  name: gpuvm
   labels:
     karpenter.sh/provisioner-name: default
 spec:

examples/machine-regular.yaml

@@ -1,7 +1,7 @@
 apiVersion: karpenter.sh/v1alpha5
 kind: Machine
 metadata:
-  name: machine-regular-vms
+  name: regularvms
   labels:
     karpenter.sh/provisioner-name: default
 spec:

pkg/providers/instance/instance.go

@@ -92,10 +92,11 @@ func NewProvider(
 func (p *Provider) Create(ctx context.Context, machine *v1alpha5.Machine, instanceTypes []*corecloudprovider.InstanceType) (*Instance, error) {
 	klog.InfoS("Instance.Create", "machine", klog.KObj(machine))
 
-	apName := strings.ReplaceAll(machine.Name, "-", "")
+	// We made a strong assumption here. The machine name should be a valid agent pool name without "-".
+	apName := machine.Name
 	if len(apName) > 11 {
 		//https://learn.microsoft.com/en-us/troubleshoot/azure/azure-kubernetes/aks-common-issues-faq#what-naming-restrictions-are-enforced-for-aks-resources-and-parameters-
-		return nil, fmt.Errorf("agentpool %q name is too long", apName)
+		return nil, fmt.Errorf("the length agentpool name should be less than 11, got %d (%s)", len(apName), apName)
 	}
 
 	if len(instanceTypes) == 0 {

test/e2e/suites/suite_test.go

@@ -80,7 +80,7 @@ var _ = Describe("GPU", func() {
 
 		machine := test.Machine(v1alpha5.Machine{
 			ObjectMeta: metav1.ObjectMeta{
-				Name:   "test-machine",
+				Name:   "testmachine",
 				Labels: machineLabels,
 			},
 			Spec: v1alpha5.MachineSpec{