handle default value for subnet-names, add docs

Author: Rahul Sharma

cloud/linode/vpc.go

@@ -170,6 +170,8 @@ func getNodeBalancerBackendIPv4SubnetID(client client.Client) (int, error) {
 
 func validateVPCSubnetFlags() error {
 	switch {
+	case len(Options.VPCIDs) > 0 && len(Options.VPCNames) > 0:
+		return fmt.Errorf("cannot have both vpc-ids and vpc-names set")
 	case len(Options.VPCIDs) > 0 && len(Options.SubnetIDs) == 0:
 		return fmt.Errorf("vpc-ids cannot be set without subnet-ids")
 	case len(Options.SubnetIDs) > 0 && len(Options.VPCIDs) == 0:
@@ -178,10 +180,6 @@ func validateVPCSubnetFlags() error {
 	// and if so, we require vpc-names to be set
 	case len(Options.SubnetNames) > 0 && len(Options.VPCNames) == 0 && Options.EnableRouteController:
 		return fmt.Errorf("subnet-names cannot be set without vpc-names")
-	case len(Options.VPCIDs) > 0 && len(Options.VPCNames) > 0:
-		return fmt.Errorf("cannot have both vpc-ids and vpc-names set")
-	case len(Options.SubnetIDs) > 0 && len(Options.SubnetNames) > 0:
-		return fmt.Errorf("cannot have both subnet-ids and subnet-names set")
 	case len(Options.VPCIDs) == 0:
 		return nil
 	}
@@ -204,6 +202,11 @@ func resolveSubnetNames(client client.Client, vpcID int) ([]string, error) {
 }
 
 func validateAndSetVPCSubnetFlags(client client.Client) error {
+	// ignore default subnet-names if subnet-ids are set
+	if len(Options.SubnetIDs) > 0 {
+		Options.SubnetNames = []string{}
+	}
+
 	if err := validateVPCSubnetFlags(); err != nil {
 		return err
 	}
@@ -231,5 +234,7 @@ func validateAndSetVPCSubnetFlags(client client.Client) error {
 	}
 
 	Options.VPCNames = append(Options.VPCNames, vpcNames...)
+	klog.V(3).Infof("VPC IDs: %v, VPC Names: %v, Subnet IDs: %v, Subnet Names: %v",
+		Options.VPCIDs, Options.VPCNames, Options.SubnetIDs, Options.SubnetNames)
 	return nil
 }

cloud/linode/vpc_test.go

@@ -306,14 +306,6 @@ func Test_validateVPCSubnetFlags(t *testing.T) {
 			subnetNames: []string{},
 			wantErr:     true,
 		},
-		{
-			name:        "invalid flags with subnet-names and subnet-ids set",
-			vpcIDs:      []int{},
-			vpcNames:    []string{"vpc1", "vpc2"},
-			subnetIDs:   []int{1, 2},
-			subnetNames: []string{"subnet1", "subnet2"},
-			wantErr:     true,
-		},
 		{
 			name:        "invalid flags with subnet-names and no vpc-names",
 			vpcIDs:      []int{},

deploy/chart/templates/daemonset.yaml

@@ -83,6 +83,20 @@ spec:
             {{- if and .Values.routeController .Values.routeController.subnetNames }}
             {{- $subnetNames = .Values.routeController.subnetNames }}
             {{- end }}
+            {{- $vpcIDs := .Values.vpcIDs }}
+            {{- if and .Values.routeController .Values.routeController.vpcIDs }}
+            {{- $vpcIDs = .Values.routeController.vpcIDs }}
+            {{- end }}
+            {{- $subnetIDs := .Values.subnetIDs }}
+            {{- if and .Values.routeController .Values.routeController.subnetIDs }}
+            {{- $subnetIDs = .Values.routeController.subnetIDs }}
+            {{- end }}
+            {{- if and $vpcIDs $vpcNames }}
+            {{- fail "Both vpcIDs and vpcNames are set. Please use only one." }}
+            {{- end }}
+            {{- if and $subnetIDs $subnetNames }}
+            {{- fail "Both subnetIDs and subnetNames are set. Please use only one." }}
+            {{- end }}
             {{- if .Values.disableNodeBalancerVPCBackends }}
             - --disable-nodebalancer-vpc-backends={{ .Values.disableNodeBalancerVPCBackends }}
             {{- end }}
@@ -99,8 +113,11 @@ spec:
             {{- end }}
             {{- if .Values.routeController }}
             - --enable-route-controller=true
-            {{- if not $vpcNames }}
-            {{- fail "vpcNames not set. Please set it when enabling route_controller for VPCs." }}
+            {{- if not (or $vpcNames $vpcIDs) }}
+            {{- fail "vpcNames or vpcIDs not set. Please set it when enabling route_controller for VPCs." }}
+            {{- end }}
+            {{- if and $vpcIDs (not $subnetIDs) }}
+            {{- fail "subnetIDs must be set when vpcIDs are set for route-controller" }}
             {{- end }}
             {{- if not $clusterCIDR }}
             {{- fail "clusterCIDR is required if route-controller is enabled" }}
@@ -116,6 +133,12 @@ spec:
             {{- with $subnetNames }}
             - --subnet-names={{ . }}
             {{- end }}
+            {{- with $vpcIDs }}
+            - --vpc-ids={{ . }}
+            {{- end }}
+            {{- with $subnetIDs }}
+            - --subnet-ids={{ . }}
+            {{- end }}
             {{- with $clusterCIDR }}
             - --cluster-cidr={{ . }}
             {{- end }}

deploy/chart/values.yaml

@@ -75,8 +75,11 @@ tolerations:
 
 # This section adds ability to enable route-controller for ccm
 # routeController:
+#   Use one of the two: either [vpcNames and subnetNames] or [vpcIDs and subnetIDs]
 #   vpcNames: <comma separated list of vpc names>
 #   subnetNames: <comma separated list of subnet names>
+#   vpcIDs: <comma separated list of vpc ids>
+#   subnetIDs: <comma separated list of subnet ids>
 #   clusterCIDR: 10.192.0.0/10
 #   configureCloudRoutes: true
 
@@ -87,8 +90,11 @@ tolerations:
 # nodeCIDRMaskSizeIPv6: 64
 
 # vpcs and subnets that node internal IPs will be assigned from (not required if already specified in routeController)
+# Use one of the two: either [vpcNames and subnetNames] or [vpcIDs and subnetIDs]
 # vpcNames: <comma separated list of vpc names>
 # subnetNames: <comma separated list of subnet names>
+# vpcIDs: <comma separated list of vpc ids>
+# subnetIDs: <comma separated list of subnet ids>
 
 # Enable Linode token health checker
 # tokenHealthChecker: true

docs/configuration/environment.md

@@ -39,8 +39,10 @@ The CCM supports the following flags:
 | `--linodego-debug` | `false` | Enables debug output for the LinodeAPI wrapper |
 | `--enable-route-controller` | `false` | Enables route_controller for CCM |
 | `--enable-token-health-checker` | `false` | Enables Linode API token health checker |
-| `--vpc-names` | `""` | Comma separated VPC names whose routes will be managed by route-controller |
-| `--subnet-names` | `""` | Comma separated subnet names whose routes will be managed by route-controller (requires vpc-names flag) |
+| `--vpc-names` | `[]` | Comma separated VPC names whose routes will be managed by route-controller |
+| `--subnet-names` | `["default"]` | Comma separated subnet names whose routes will be managed by route-controller (requires vpc-names flag) |
+| `--vpc-ids` | `[]` | Comma separated VPC ids whose routes will be managed by route-controller |
+| `--subnet-ids` | `[]` | Comma separated subnet ids whose routes will be managed by route-controller (requires vpc-ids flag) |
 | `--load-balancer-type` | `nodebalancer` | Configures which type of load-balancing to use (options: nodebalancer, cilium-bgp) |
 | `--bgp-node-selector` | `""` | Node selector to use to perform shared IP fail-over with BGP |
 | `--ip-holder-suffix` | `""` | Suffix to append to the IP holder name when using shared IP fail-over with BGP |