Plane-EE: route /static to API service for Swagger UI sidecar assets

charts/plane-enterprise/Chart.yaml

@@ -5,7 +5,7 @@ description: Meet Plane. An Enterprise software development tool to manage issue
 
 type: application
 
-version: 2.4.3
+version: 2.4.4
 appVersion: "2.6.0"
 home: https://plane.so/
 icon: https://plane.so/favicon/favicon-32x32.png

charts/plane-enterprise/README.md

@@ -89,7 +89,7 @@ The default value is `"traefik"`. If you are switching to a standard ingress con
 | `ingress.enabled`                     | `true`     | Master switch — set to `false` to render neither template.                                |
 | `ingress.ingressClass`                | `traefik`  | Selects which template is active (see table above).                                       |
 | `ingress.traefik.maxRequestBodyBytes` | `20971520` | Max request body size for Traefik's buffering middleware. Ignored when not using Traefik. |
-| `ingress.ingress_annotations`         | `{}`       | Standard `Ingress` annotations. Ignored when `ingressClass` starts with `traefik`.       |
+| `ingress.ingress_annotations`         | `{ "nginx.ingress.kubernetes.io/proxy-buffer-size": "8k" }` | Standard `Ingress` annotations. Defaults to a `proxy-buffer-size` of `8k` so large upstream response headers (e.g. the Swagger UI / OpenAPI schema endpoints) are not truncated. Ignored when `ingressClass` starts with `traefik`. |
 
 ## Installing Plane
 
@@ -704,7 +704,7 @@ Note: When the email service is enabled, the cert-issuer will be automatically c
 | ingress.minioHost           |                                                           |          | Based on above configuration, if you want to expose the `minio` web console to set of users, use this key to set the `host` mapping or leave it as `EMPTY` to not expose interface.                                                                                                                                                                                                                                       |
 | ingress.rabbitmqHost        |                                                           |          | Based on above configuration, if you want to expose the `rabbitmq` web console to set of users, use this key to set the `host` mapping or leave it as `EMPTY` to not expose interface.                                                                                                                                                                                                                                    |
 | ingress.ingressClass        |                           nginx                           |   Yes    | Kubernetes cluster setup comes with various options of `ingressClass`. Based on your setup, set this value to the right one (eg. nginx, traefik, etc). Leave it to default in case you are using external ingress provider.                                                                                                                                                                                               |
-| ingress.ingress_annotations | `{ "nginx.ingress.kubernetes.io/proxy-body-size": "5m" }` |          | Ingress controllers comes with various configuration options which can be passed as annotations. Setting this value lets you change the default value to user required.                                                                                                                                                                                                                                                   |
+| ingress.ingress_annotations | `{ "nginx.ingress.kubernetes.io/proxy-buffer-size": "8k" }` |          | Ingress controllers comes with various configuration options which can be passed as annotations. Defaults to a `proxy-buffer-size` of `8k` so large upstream response headers (e.g. the Swagger UI / OpenAPI schema endpoints) are not truncated. Setting this value lets you change the default value to user required.                                                                                                                                                                                                                                                   |
 | ssl.createIssuer            |                           false                           |          | Kubernets cluster setup supports creating `issuer` type resource. After deployment, this is step towards creating secure access to the ingress url. Issuer is required for you generate SSL certifiate. Kubernetes can be configured to use any of the certificate authority to generate SSL (depending on CertManager configuration). Set it to `true` to create the issuer. Applicable only when `ingress.enabled=true` |
 | ssl.issuer                  |                           http                            |          | CertManager configuration allows user to create issuers using `http` or any of the other DNS Providers like `cloudflare`, `digitalocean`, etc. As of now Plane supports `http`, `cloudflare`, `digitalocean`                                                                                                                                                                                                              |
 | ssl.token                   |                                                           |          | To create issuers using DNS challenge, set the issuer api token of dns provider like cloudflare`or`digitalocean`(not required for http)                                                                                                                                                                                                                                                                                   |

charts/plane-enterprise/templates/ingress-traefik.yaml

@@ -45,6 +45,14 @@ spec:
       - name: {{ .Release.Name }}-api
         port: 8000
 
+  - match: Host(`{{ .Values.license.licenseDomain }}`) && PathPrefix(`/static/`)
+    kind: Rule
+    middlewares:
+      - name: {{ .Release.Name }}-body-limit
+    services:
+      - name: {{ .Release.Name }}-api
+        port: 8000
+
   - match: Host(`{{ .Values.license.licenseDomain }}`) && PathPrefix(`/graphql/`)
     kind: Rule
     middlewares:

charts/plane-enterprise/templates/ingress.yaml

@@ -52,6 +52,13 @@ spec:
                 name: {{ .Release.Name }}-api
             path: /auth/
             pathType: Prefix
+          - backend:
+              service:
+                port:
+                  number: 8000
+                name: {{ .Release.Name }}-api
+            path: /static/
+            pathType: Prefix
           - backend:
               service:
                 port:

charts/plane-enterprise/values.yaml

@@ -41,7 +41,11 @@ ingress:
   ingressClass: 'traefik'
   # If using nginx ingress controller, set this to 'nginx' and add the appropriate annotations to set the proxy body size limit.
   # For nginx ingress controller, you can set the proxy body size limit using annotations. Example:
-  # ingress_annotations: { "nginx.ingress.kubernetes.io/proxy-body-size": "5m" }
+  #   ingress_annotations: { "nginx.ingress.kubernetes.io/proxy-body-size": "5m" }
+  # proxy-buffer-size is set to 8k by default so large upstream response headers (e.g. the Swagger
+  # UI / OpenAPI schema endpoints) are not truncated. Override or extend with your own annotations.
+  ingress_annotations:
+    nginx.ingress.kubernetes.io/proxy-buffer-size: '8k'
   traefik:
     maxRequestBodyBytes: 20971520 # in bytes (default: 20 MiB)