fix: make service type None actually create an headless service

Author: teoincontatto

stackgres-k8s/install/operator-sdk/stackgres-operator/config/manifests/bases/stackgres.clusterserviceversion.template.yaml

@@ -100,9 +100,7 @@ EOF
     operatorframework.io/os.linux: supported
   relatedImages:
   - image: quay.io/ongres/kubectl:v1.31.3-build-6.38
-    name: kubectl_1_30_0
-  - image: gcr.io/kubebuilder/kube-rbac-proxy:v0.13.0
-    name: kube-rbac-proxy_0_13_0
+    name: kubectl_1_31_3
   - image: quay.io/stackgres/operator:${VERSION}
     name: stackgres-operator
   - image: quay.io/stackgres/restapi:${VERSION}

stackgres-k8s/src/common/src/main/java/io/stackgres/common/crd/postgres/service/StackGresPostgresService.java

@@ -9,6 +9,7 @@
 import java.util.Map;
 import java.util.Objects;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import io.fabric8.kubernetes.api.model.ServicePort;
 import io.fabric8.kubernetes.api.model.SessionAffinityConfig;
@@ -83,6 +84,14 @@ public void setEnabled(Boolean enabled) {
     this.enabled = enabled;
   }
 
+  @JsonIgnore
+  public String getServiceType() {
+    if (Objects.equals(getType(), StackGresPostgresServiceType.NONE.toString())) {
+      return "ClusterIP";
+    }
+    return getType();
+  }
+
   @Override
   public String getType() {
     return type;
@@ -103,6 +112,14 @@ public void setAllocateLoadBalancerNodePorts(Boolean allocateLoadBalancerNodePor
     super.setAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts);
   }
 
+  @JsonIgnore
+  public String getServiceClusterIP() {
+    if (Objects.equals(getType(), StackGresPostgresServiceType.NONE.toString())) {
+      return "None";
+    }
+    return null;
+  }
+
   @Override
   public String getClusterIP() {
     return super.getClusterIP();

stackgres-k8s/src/common/src/main/resources/crds/SGCluster.yaml

@@ -674,15 +674,20 @@ spec:
                         default: true
                       type:
                         type: string
-                        enum: ["ClusterIP", "LoadBalancer", "NodePort"]
+                        enum: ["ClusterIP", "LoadBalancer", "NodePort", "None"]
                         description: |
                           type determines how the Service is exposed. Defaults to ClusterIP. Valid
-                          options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates
+                          options are ClusterIP, NodePort, LoadBalancer and None. "ClusterIP" allocates
                           a cluster-internal IP address for load-balancing to endpoints.
                           "NodePort" builds on ClusterIP and allocates a port on every node.
                           "LoadBalancer" builds on NodePort and creates
                           an external load-balancer (if supported in the current cloud).
-                          More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
+                          "None" creates an headless service that can be use in conjunction with `.spec.pods.disableEnvoy`
+                           set to `true` in order to acces the database using a DNS.
+                          More info:
+                          * https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
+                          * https://kubernetes.io/docs/concepts/services-networking/service/#headless-services
+                          * https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
                         default: ClusterIP
                       customPorts:
                         type: array

stackgres-k8s/src/common/src/main/resources/crds/SGDistributedLogs.yaml

@@ -111,8 +111,21 @@ spec:
                     properties: &service-properties
                       type:
                         type: string
-                        enum: ["ClusterIP", "LoadBalancer", "NodePort"]
-                        description: Specifies the type of Kubernetes service(`ClusterIP`, `LoadBalancer`, `NodePort`)
+                        enum: ["ClusterIP", "LoadBalancer", "NodePort", "None"]
+                        description: |
+                          type determines how the Service is exposed. Defaults to ClusterIP. Valid
+                          options are ClusterIP, NodePort, LoadBalancer and None. "ClusterIP" allocates
+                          a cluster-internal IP address for load-balancing to endpoints.
+                          "NodePort" builds on ClusterIP and allocates a port on every node.
+                          "LoadBalancer" builds on NodePort and creates
+                          an external load-balancer (if supported in the current cloud).
+                          "None" creates an headless service that can be use in conjunction with `.spec.pods.disableEnvoy`
+                           set to `true` in order to acces the database using a DNS.
+                          More info:
+                          * https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
+                          * https://kubernetes.io/docs/concepts/services-networking/service/#headless-services
+                          * https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
+                        default: ClusterIP
                       allocateLoadBalancerNodePorts: #!jq_placeholder .definitions["io.k8s.api.core.v1.ServiceSpec"].properties.allocateLoadBalancerNodePorts
                         {"description":"allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.  Default is \"true\". It may be set to \"false\" if the cluster load-balancer does not rely on NodePorts.  If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.","type":"boolean"}
                       externalIPs: #!jq_placeholder .definitions["io.k8s.api.core.v1.ServiceSpec"].properties.externalIPs #allocateloadbalancernodeports-v1-core

stackgres-k8s/src/common/src/main/resources/crds/SGShardedCluster.yaml

@@ -401,15 +401,20 @@ spec:
                             description: Specify if the service should be created or not.
                           type:
                             type: string
-                            enum: ["ClusterIP", "LoadBalancer", "NodePort"]
+                            enum: ["ClusterIP", "LoadBalancer", "NodePort", "None"]
                             description: |
                               type determines how the Service is exposed. Defaults to ClusterIP. Valid
-                              options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates
+                              options are ClusterIP, NodePort, LoadBalancer and None. "ClusterIP" allocates
                               a cluster-internal IP address for load-balancing to endpoints.
                               "NodePort" builds on ClusterIP and allocates a port on every node.
                               "LoadBalancer" builds on NodePort and creates
                               an external load-balancer (if supported in the current cloud).
-                              More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
+                              "None" creates an headless service that can be use in conjunction with `.spec.pods.disableEnvoy`
+                               set to `true` in order to acces the database using a DNS.
+                              More info:
+                              * https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
+                              * https://kubernetes.io/docs/concepts/services-networking/service/#headless-services
+                              * https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
                           allocateLoadBalancerNodePorts: #!jq_placeholder .definitions["io.k8s.api.core.v1.ServiceSpec"].properties.allocateLoadBalancerNodePorts
                             {"description":"allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.  Default is \"true\". It may be set to \"false\" if the cluster load-balancer does not rely on NodePorts.  If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.","type":"boolean"}
                           externalIPs: #!jq_placeholder .definitions["io.k8s.api.core.v1.ServiceSpec"].properties.externalIPs #allocateloadbalancernodeports-v1-core

stackgres-k8s/src/operator/src/main/java/io/stackgres/operator/conciliation/factory/cluster/patroni/PatroniServices.java

@@ -164,6 +164,8 @@ private Service createPrimaryService(StackGresClusterContext context) {
         .endMetadata()
         .withSpec(cluster.getSpec().getPostgresServices().getPrimary())
         .editSpec()
+        .withType(cluster.getSpec().getPostgresServices().getPrimary().getServiceType())
+        .withClusterIP(cluster.getSpec().getPostgresServices().getPrimary().getServiceClusterIP())
         .withPorts(getPrimaryServicePorts(cluster))
         .endSpec()
         .build();
@@ -298,6 +300,8 @@ private Service createReplicaService(StackGresClusterContext context) {
         .endMetadata()
         .withSpec(cluster.getSpec().getPostgresServices().getReplicas())
         .editSpec()
+        .withType(cluster.getSpec().getPostgresServices().getReplicas().getServiceType())
+        .withClusterIP(cluster.getSpec().getPostgresServices().getReplicas().getServiceClusterIP())
         .withSelector(labelFactory.clusterReplicaLabels(cluster))
         .withPorts(getReplicasPorts(cluster))
         .endSpec()