Merge pull request #1475 from RnkeZ/predefined-internal-ip

Add support for creating an internal load balancer with predefined IP address

Author: k8s-ci-robot

api/v1beta1/types.go

@@ -395,4 +395,10 @@ type LoadBalancer struct {
 	// +kubebuilder:default=Regional
 	// +optional
 	InternalAccess InternalAccess `json:"internalAccess,omitempty"`
+
+	// IPAddress is the static IP address to use for the Load Balancer.
+	// If not set, a new static IP address will be allocated.
+	// If set, it must be a valid free IP address from the LoadBalancer Subnet.
+	// +optional
+	IPAddress *string `json:"ipAddress,omitempty"`
 }

api/v1beta1/zz_generated.deepcopy.go

@@ -525,6 +525,11 @@ func (s *Service) createOrGetInternalAddress(ctx context.Context, lbname string)
 		log.Error(err, "Error getting subnet for Internal Load Balancer")
 		return nil, err
 	}
+	lbSpec := s.scope.LoadBalancer()
+	if lbSpec.InternalLoadBalancer != nil && lbSpec.InternalLoadBalancer.IPAddress != nil {
+		// If an IP address is configured, use it instead of creating a new one.
+		addrSpec.Address = *lbSpec.InternalLoadBalancer.IPAddress
+	}
 	addrSpec.Subnetwork = subnet.SelfLink
 	addrSpec.Purpose = "GCE_ENDPOINT"
 	log.V(2).Info("Looking for internal address", "name", addrSpec.Name)

cloud/services/compute/loadbalancers/reconcile.go

@@ -536,6 +536,23 @@ func TestService_createOrGetAddress(t *testing.T) {
 }
 
 func TestService_createOrGetInternalAddress(t *testing.T) {
+	address := &compute.Address{
+		IpVersion:   "IPV4",
+		Name:        "my-cluster-api-internal",
+		Region:      "us-central1",
+		SelfLink:    "https://www.googleapis.com/compute/v1/projects/proj-id/regions/us-central1/addresses/my-cluster-api-internal",
+		AddressType: "INTERNAL",
+		Purpose:     "GCE_ENDPOINT",
+	}
+	staticAddress := &compute.Address{
+		Address:     "10.0.0.10",
+		IpVersion:   "IPV4",
+		Name:        "my-cluster-api-internal",
+		Region:      "us-central1",
+		SelfLink:    "https://www.googleapis.com/compute/v1/projects/proj-id/regions/us-central1/addresses/my-cluster-api-internal",
+		AddressType: "INTERNAL",
+		Purpose:     "GCE_ENDPOINT",
+	}
 	tests := []struct {
 		name            string
 		scope           func(s *scope.ClusterScope) Scope
@@ -565,17 +582,10 @@ func TestService_createOrGetInternalAddress(t *testing.T) {
 					*meta.RegionalKey("control-plane", "us-central1"): {},
 				},
 			},
-			want: &compute.Address{
-				IpVersion:   "IPV4",
-				Name:        "my-cluster-api-internal",
-				Region:      "us-central1",
-				SelfLink:    "https://www.googleapis.com/compute/v1/projects/proj-id/regions/us-central1/addresses/my-cluster-api-internal",
-				AddressType: "INTERNAL",
-				Purpose:     "GCE_ENDPOINT",
-			},
+			want: address,
 		},
 		{
-			name: "address does not exist for internal load balancer using SharedVPC subnet (should create address)",
+			name: "address does not exist for internal load balancer using SharedVPC subnet",
 			scope: func(s *scope.ClusterScope) Scope {
 				s.GCPCluster.Spec.LoadBalancer = infrav1.LoadBalancerSpec{
 					LoadBalancerType: &lbTypeInternal,
@@ -593,14 +603,57 @@ func TestService_createOrGetInternalAddress(t *testing.T) {
 					*meta.RegionalKey("control-plane", "us-central1"): {},
 				},
 			},
-			want: &compute.Address{
-				IpVersion:   "IPV4",
-				Name:        "my-cluster-api-internal",
-				Region:      "us-central1",
-				SelfLink:    "https://www.googleapis.com/compute/v1/projects/proj-id/regions/us-central1/addresses/my-cluster-api-internal",
-				AddressType: "INTERNAL",
-				Purpose:     "GCE_ENDPOINT",
+			want:      address,
+			sharedVPC: true,
+		},
+		{
+			name: "static address set for internal load balancer",
+			scope: func(s *scope.ClusterScope) Scope {
+				s.GCPCluster.Spec.LoadBalancer = infrav1.LoadBalancerSpec{
+					LoadBalancerType: &lbTypeInternal,
+					InternalLoadBalancer: &infrav1.LoadBalancer{
+						IPAddress: ptr.To("10.0.0.10"),
+					},
+				}
+				return s
+			},
+			lbName: infrav1.InternalRoleTagValue,
+			mockAddress: &cloud.MockAddresses{
+				ProjectRouter: &cloud.SingleProjectRouter{ID: "proj-id"},
+				Objects:       map[meta.Key]*cloud.MockAddressesObj{},
+			},
+			mockSubnetworks: &cloud.MockSubnetworks{
+				ProjectRouter: &cloud.SingleProjectRouter{ID: "my-proj"},
+				Objects: map[meta.Key]*cloud.MockSubnetworksObj{
+					*meta.RegionalKey("control-plane", "us-central1"): {},
+				},
+			},
+			want: staticAddress,
+		},
+		{
+			name: "static address set for internal load balancer using SharedVPC subnet",
+			scope: func(s *scope.ClusterScope) Scope {
+				s.GCPCluster.Spec.LoadBalancer = infrav1.LoadBalancerSpec{
+					LoadBalancerType: &lbTypeInternal,
+					InternalLoadBalancer: &infrav1.LoadBalancer{
+						IPAddress: ptr.To("10.0.0.10"),
+					},
+				}
+
+				return s
+			},
+			lbName: infrav1.InternalRoleTagValue,
+			mockAddress: &cloud.MockAddresses{
+				ProjectRouter: &cloud.SingleProjectRouter{ID: "proj-id"},
+				Objects:       map[meta.Key]*cloud.MockAddressesObj{},
+			},
+			mockSubnetworks: &cloud.MockSubnetworks{
+				ProjectRouter: &cloud.SingleProjectRouter{ID: "proj-id"},
+				Objects: map[meta.Key]*cloud.MockSubnetworksObj{
+					*meta.RegionalKey("control-plane", "us-central1"): {},
+				},
 			},
+			want:      staticAddress,
 			sharedVPC: true,
 		},
 	}

cloud/services/compute/loadbalancers/reconcile_test.go

@@ -138,6 +138,12 @@ spec:
                         - Regional
                         - Global
                         type: string
+                      ipAddress:
+                        description: |-
+                          IPAddress is the static IP address to use for the Load Balancer.
+                          If not set, a new static IP address will be allocated.
+                          If set, it must be a valid free IP address from the LoadBalancer Subnet.
+                        type: string
                       name:
                         description: |-
                           Name is the name of the Load Balancer. If not set a default name

config/crd/bases/infrastructure.cluster.x-k8s.io_gcpclusters.yaml

@@ -156,6 +156,12 @@ spec:
                                 - Regional
                                 - Global
                                 type: string
+                              ipAddress:
+                                description: |-
+                                  IPAddress is the static IP address to use for the Load Balancer.
+                                  If not set, a new static IP address will be allocated.
+                                  If set, it must be a valid free IP address from the LoadBalancer Subnet.
+                                type: string
                               name:
                                 description: |-
                                   Name is the name of the Load Balancer. If not set a default name

config/crd/bases/infrastructure.cluster.x-k8s.io_gcpclustertemplates.yaml

@@ -133,6 +133,12 @@ spec:
                         - Regional
                         - Global
                         type: string
+                      ipAddress:
+                        description: |-
+                          IPAddress is the static IP address to use for the Load Balancer.
+                          If not set, a new static IP address will be allocated.
+                          If set, it must be a valid free IP address from the LoadBalancer Subnet.
+                        type: string
                       name:
                         description: |-
                           Name is the name of the Load Balancer. If not set a default name