Skip to content

feat: prevent changes to GCP load balancer subnet annotations #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wpjunior wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: prevent changes to GCP load balancer subnet annotations #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions controllers/nginx_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@
)

const (
gcpNetworkTierAnnotationKey = "cloud.google.com/network-tier"
ociLoadBalancerTLSSecret = "service.beta.kubernetes.io/oci-load-balancer-tls-secret"
ociLoadBalancerSSLPorts = "service.beta.kubernetes.io/oci-load-balancer-ssl-ports"
gcpNetworkTierAnnotationKey = "cloud.google.com/network-tier"

Check failure on line 36 in controllers/nginx_controller.go

View workflow job for this annotation

GitHub Actions / lint 

File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(github.com/tsuru/nginx-operator) -s blank -s dot (gci)

Check failure on line 36 in controllers/nginx_controller.go

View workflow job for this annotation

GitHub Actions / lint 

File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(github.com/tsuru/nginx-operator) -s blank -s dot (gci)
gcpInternalLBSubnetAnnotationKey = "networking.gke.io/internal-load-balancer-subnet"
gcpLBSubnetAnnotationKey = "networking.gke.io/load-balancer-subnet"
ociLoadBalancerTLSSecret = "service.beta.kubernetes.io/oci-load-balancer-tls-secret"
ociLoadBalancerSSLPorts = "service.beta.kubernetes.io/oci-load-balancer-ssl-ports"
useHTTPSOverHTTPAnnotation = "nginx.tsuru.io/https-over-http"
nginxIpv6GcpAnnotation = "nginx.tsuru.io/allocate-gcp-ipv6"
ingressStaticIPAnnotation = "kubernetes.io/ingress.global-static-ip-name"
Expand Down Expand Up @@ -194,6 +196,16 @@
newService.Annotations[gcpNetworkTierAnnotationKey] = currentService.Annotations[gcpNetworkTierAnnotationKey]
}

if newService.Annotations[gcpInternalLBSubnetAnnotationKey] != currentService.Annotations[gcpInternalLBSubnetAnnotationKey] {
r.Log.Info("the GCP internal load balancer subnet of this service cannot be changed, because IP address may change and cause downtime", "nginx", nginx.Name, "namespace", nginx.Namespace)
newService.Annotations[gcpInternalLBSubnetAnnotationKey] = currentService.Annotations[gcpInternalLBSubnetAnnotationKey]
}

if newService.Annotations[gcpLBSubnetAnnotationKey] != currentService.Annotations[gcpLBSubnetAnnotationKey] {
r.Log.Info("the GCP load balancer subnet of this service cannot be changed, because IP address may change and cause downtime", "nginx", nginx.Name, "namespace", nginx.Namespace)
newService.Annotations[gcpLBSubnetAnnotationKey] = currentService.Annotations[gcpLBSubnetAnnotationKey]
}

newService.ResourceVersion = currentService.ResourceVersion
newService.Spec.ClusterIP = currentService.Spec.ClusterIP
newService.Spec.HealthCheckNodePort = currentService.Spec.HealthCheckNodePort
Expand Down
130 changes: 130 additions & 0 deletions controllers/nginx_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,136 @@ func TestNginxReconciler_reconcileService(t *testing.T) {
"Normal ServiceUpdated service updated successfully",
},
},
{
name: "when updating the nginx service, must not change the GCP internal-load-balancer-subnet annotation",
nginx: &v1alpha1.Nginx{
TypeMeta: metav1.TypeMeta{
APIVersion: "extensions.tsuru.io/v1alpha1",
Kind: "Nginx",
},
ObjectMeta: metav1.ObjectMeta{
Name: "my-nginx",
Namespace: "default",
},
Spec: v1alpha1.NginxSpec{
Service: &v1alpha1.NginxService{
Type: corev1.ServiceTypeClusterIP,
Annotations: map[string]string{
"networking.gke.io/internal-load-balancer-subnet": "subnet-new",
},
},
},
},
service: &corev1.Service{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Service",
},
ObjectMeta: metav1.ObjectMeta{
Name: "my-nginx-service",
Namespace: "default",
Annotations: map[string]string{
"networking.gke.io/internal-load-balancer-subnet": "subnet-original",
},
Labels: map[string]string{},
},
Spec: corev1.ServiceSpec{
Type: corev1.ServiceTypeLoadBalancer,
ExternalTrafficPolicy: corev1.ServiceExternalTrafficPolicyTypeCluster,
ClusterIP: "10.1.1.10",
HealthCheckNodePort: int32(43123),
Ports: []corev1.ServicePort{
{
Name: "https",
TargetPort: intstr.FromString("https"),
Protocol: corev1.ProtocolTCP,
Port: int32(443),
NodePort: int32(30667),
},
{
Name: "http",
Protocol: corev1.ProtocolTCP,
TargetPort: intstr.FromString("http"),
Port: int32(80),
NodePort: int32(30666),
},
},
},
},
assertion: func(t *testing.T, err error, got *corev1.Service) {
assert.NoError(t, err)
assert.NotNil(t, got)
assert.Equal(t, "subnet-original", got.Annotations["networking.gke.io/internal-load-balancer-subnet"])
},
expectedEvents: []string{
"Normal ServiceUpdated service updated successfully",
},
},
{
name: "when updating the nginx service, must not change the GCP load-balancer-subnet annotation",
nginx: &v1alpha1.Nginx{
TypeMeta: metav1.TypeMeta{
APIVersion: "extensions.tsuru.io/v1alpha1",
Kind: "Nginx",
},
ObjectMeta: metav1.ObjectMeta{
Name: "my-nginx",
Namespace: "default",
},
Spec: v1alpha1.NginxSpec{
Service: &v1alpha1.NginxService{
Type: corev1.ServiceTypeClusterIP,
Annotations: map[string]string{
"networking.gke.io/load-balancer-subnet": "subnet-new",
},
},
},
},
service: &corev1.Service{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Service",
},
ObjectMeta: metav1.ObjectMeta{
Name: "my-nginx-service",
Namespace: "default",
Annotations: map[string]string{
"networking.gke.io/load-balancer-subnet": "subnet-original",
},
Labels: map[string]string{},
},
Spec: corev1.ServiceSpec{
Type: corev1.ServiceTypeLoadBalancer,
ExternalTrafficPolicy: corev1.ServiceExternalTrafficPolicyTypeCluster,
ClusterIP: "10.1.1.10",
HealthCheckNodePort: int32(43123),
Ports: []corev1.ServicePort{
{
Name: "https",
TargetPort: intstr.FromString("https"),
Protocol: corev1.ProtocolTCP,
Port: int32(443),
NodePort: int32(30667),
},
{
Name: "http",
Protocol: corev1.ProtocolTCP,
TargetPort: intstr.FromString("http"),
Port: int32(80),
NodePort: int32(30666),
},
},
},
},
assertion: func(t *testing.T, err error, got *corev1.Service) {
assert.NoError(t, err)
assert.NotNil(t, got)
assert.Equal(t, "subnet-original", got.Annotations["networking.gke.io/load-balancer-subnet"])
},
expectedEvents: []string{
"Normal ServiceUpdated service updated successfully",
},
},
{
name: "when setting OCI load balancer type with TLS annotations, should set the OCI load balancer with proper secret annotation",
nginx: &v1alpha1.Nginx{
Expand Down
Loading