From 163cce5818b07e8cd416fa8171a3ef7bfc3d761d Mon Sep 17 00:00:00 2001 From: Remco Beckers Date: Fri, 21 Mar 2025 09:22:11 +0100 Subject: [PATCH] stac-22430 Update ingress class name --- .../install-stackstate/kubernetes_openshift/ingress.md | 10 ++++++++-- setup/release-notes/v2.3.1.md | 1 + 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/setup/install-stackstate/kubernetes_openshift/ingress.md b/setup/install-stackstate/kubernetes_openshift/ingress.md index 458594f04..a29f1b560 100644 --- a/setup/install-stackstate/kubernetes_openshift/ingress.md +++ b/setup/install-stackstate/kubernetes_openshift/ingress.md @@ -23,6 +23,7 @@ Note that setting up TLS is required for the use of the rancher UI extension. ```text ingress: enabled: true + ingressClassName: nginx annotations: nginx.ingress.kubernetes.io/proxy-body-size: "50m" hosts: @@ -33,7 +34,9 @@ ingress: secretName: tls-secret ``` -The thing that stands out in this file is the Nginx annotation to increase the allowed `proxy-body-size` to `50m` \(larger than any expected request\). By default, Nginx allows body sizes of maximum `1m`. SUSE Observability Agents and other data providers can sometimes send much larger requests. For this reason, you should make sure that the allowed body size is large enough, regardless of whether you are using Nginx or another ingress controller. Make sure to update the `baseUrl` in the values file generated during initial installation, it will be used by SUSE Observability to generate convenient installation instructions for the agent. +What stands out in this file is the Nginx annotation to increase the allowed `proxy-body-size` to `50m` \(larger than any expected request\). By default, Nginx allows body sizes of maximum `1m`. SUSE Observability Agents and other data providers can sometimes send much larger requests. For this reason, you should make sure that the allowed body size is large enough, regardless of whether you are using Nginx or another ingress controller. Make sure to update the `baseUrl` in the values file generated during initial installation, it will be used by SUSE Observability to generate convenient installation instructions for the agent. + +The example uses the `ingressClassName` field to specify the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) instead of the deprecated `kubernetes.io/ingress.class` annotation. If your cluster has a default ingress class defined the ingerss class name field can be omitted. Include the `ingress_values.yaml` file when you run the `helm upgrade` command to deploy SUSE Observability: @@ -62,6 +65,7 @@ To configure the `opentelemetry-collector` ingress for SUSE Observability, creat opentelemetry-collector: ingress: enabled: true + ingressClassName: nginx annotations: nginx.ingress.kubernetes.io/proxy-body-size: "50m" nginx.ingress.kubernetes.io/backend-protocol: GRPC @@ -91,7 +95,9 @@ opentelemetry-collector: secretName: otlp-http-tls-secret ``` -The thing that stands out in this file is the Nginx annotation to increase the allowed `proxy-body-size` to `50m` \(larger than any expected request\). By default, Nginx allows body sizes of maximum `1m`. SUSE Observability Agents and other data providers can sometimes send much larger requests. For this reason, you should make sure that the allowed body size is large enough, regardless of whether you are using Nginx or another ingress controller. Make sure to update the `baseUrl` in the values file generated during initial installation, it will be used by SUSE Observability to generate convenient installation instructions for the agent. +What stands out in this file is the Nginx annotation to increase the allowed `proxy-body-size` to `50m` \(larger than any expected request\). By default, Nginx allows body sizes of maximum `1m`. SUSE Observability Agents and other data providers can sometimes send much larger requests. For this reason, you should make sure that the allowed body size is large enough, regardless of whether you are using Nginx or another ingress controller. Make sure to update the `baseUrl` in the values file generated during initial installation, it will be used by SUSE Observability to generate convenient installation instructions for the agent. + +The example uses the `ingressClassName` field to specify the [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) instead of the deprecated `kubernetes.io/ingress.class` annotation. If your cluster has a default ingress class defined the ingerss class name field can be omitted. Include the `ingress_otel_values.yaml` file when you run the `helm upgrade` command to deploy SUSE Observability: diff --git a/setup/release-notes/v2.3.1.md b/setup/release-notes/v2.3.1.md index be5112941..dffc91553 100644 --- a/setup/release-notes/v2.3.1.md +++ b/setup/release-notes/v2.3.1.md @@ -16,6 +16,7 @@ description: SUSE Observability Self-hosted * An additional warning will be displayed if the license has been expired for 14 days. * **Span Event Inline Display:** Events for Spans are now shown inline, enabling easier trace span analysis. * **ArgoCD Helm Chart Compatibility:** The Helm chart can now be installed using ArgoCD by setting `.Values.deployment.compatibleWithArgoCD` to `true`. +* **Helm Chart configuration:** The `ingressClassName` is now supported in the ingress specification ### Bug Fixes