Ref #29480: Add support for patching ingress

Author: LEDfan

docs/deployment/overlays/1-namespaced/resources/shinyproxy.shinyproxy.yaml

@@ -78,6 +78,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

docs/deployment/overlays/2-clustered/shinyproxy-dept2/resources/shinyproxy.shinyproxy.yaml

@@ -77,6 +77,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo2.local

docs/deployment/overlays/2-clustered/shinyproxy/resources/shinyproxy.shinyproxy.yaml

@@ -77,6 +77,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

docs/deployment/overlays/3-namespaced-app-ns/shinyproxy/resources/shinyproxy.shinyproxy.yaml

@@ -82,6 +82,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

docs/deployment/overlays/4-namespaced-multi/resources/shinyproxy1.shinyproxy.yaml

@@ -80,6 +80,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

docs/deployment/overlays/4-namespaced-multi/resources/shinyproxy2.shinyproxy.yaml

@@ -83,6 +83,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

docs/deployment/overlays/4-namespaced-multi/resources/shinyproxy3.shinyproxy.yaml

@@ -83,6 +83,16 @@ spec:
     - op: add
       path: /spec/serviceAccountName
       value: shinyproxy-sa
+  kubernetesIngressPatches: |
+    - op: add
+      path: /metadata/annotations
+      value:
+        nginx.ingress.kubernetes.io/proxy-buffer-size: "128k"
+        nginx.ingress.kubernetes.io/ssl-redirect: "true"
+        nginx.ingress.kubernetes.io/proxy-body-size: 300m
+    - op: add
+      path: /spec/ingressClassName
+      value: nginx
   image: openanalytics/shinyproxy:3.0.0
   imagePullPolicy: Always
   fqdn: shinyproxy-demo.local

src/main/kotlin/eu/openanalytics/shinyproxyoperator/components/IngressFactory.kt

@@ -35,6 +35,8 @@ class IngressFactory(private val kubeClient: MixedOperation<Ingress, IngressList
 
     private val logger = KotlinLogging.logger {}
 
+    private val ingressPatcher = IngressPatcher()
+
     fun createOrReplaceIngress(shinyProxy: ShinyProxy, latestInstance: ShinyProxyInstance) {
         val labels = LabelFactory.labelsForShinyProxy(shinyProxy).toMutableMap()
         labels[LabelFactory.LATEST_INSTANCE_LABEL] = latestInstance.hashOfSpec
@@ -65,7 +67,8 @@ class IngressFactory(private val kubeClient: MixedOperation<Ingress, IngressList
                 .build()
             //@formatter:on
 
-        val createdIngress = kubeClient.inNamespace(shinyProxy.metadata.namespace).resource(ingressDefinition).createOrReplace()
+        val patchedIngress = ingressPatcher.patch(ingressDefinition, shinyProxy.parsedIngressPatches)
+        val createdIngress = kubeClient.inNamespace(shinyProxy.metadata.namespace).resource(patchedIngress).createOrReplace()
         logger.debug { "${shinyProxy.logPrefix()} [Component/Ingress] Created ${createdIngress.metadata.name}" }
     }
 

src/main/kotlin/eu/openanalytics/shinyproxyoperator/crd/ShinyProxy.kt

@@ -121,6 +121,23 @@ class ShinyProxy : CustomResource<JsonNode, ShinyProxyStatus>(), Namespaced {
         return@lazy null
     }
 
+    @get:JsonIgnore
+    val parsedIngressPatches: JsonPatch? by lazy {
+        if (spec.get("kubernetesIngressPatches")?.isTextual == true) {
+            try {
+                // convert the raw YAML string into a JsonPatch
+                val yamlReader = ObjectMapper(YAMLFactory())
+                yamlReader.registerModule(JSR353Module())
+                return@lazy yamlReader.readValue(spec.get("kubernetesIngressPatches").textValue(), JsonPatch::class.java)
+            } catch (exception: Exception) {
+                exception.printStackTrace() // log the exception for easier debugging
+                throw exception
+            }
+
+        }
+        return@lazy null
+    }
+
     @get:JsonIgnore
     val subPath: String by lazy {
         if (spec.get("server")?.get("servlet")?.get("context-path")?.isTextual == true) {