From 85149086ae70cb85a1718715747985a3da2a7b64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thorsten=20Ro=C3=9Fner?= Date: Mon, 1 Jul 2024 13:24:19 +0200 Subject: [PATCH] fix(docs): Correction regarding the currently supported ingress controller. --- docs/getting-started.md | 2 ++ docs/requirements.md | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 167ee3fa..1b213a77 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -208,6 +208,8 @@ ingress: ingressClassName: "cilium" ``` +**Note:** Please check the [requirements.md](./requirements.md) for the supported Ingress controllers. + ### Container runtime Some apps require specific configuration for the container runtime. You can set your container runtime like `cri-o`, diff --git a/docs/requirements.md b/docs/requirements.md index 01affb37..de9f74fe 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -22,7 +22,7 @@ openDesk is a Kubernetes only solution and requires an existing Kubernetes (K8s) - K8s cluster >= 1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/) - Domain and DNS Service -- Ingress controller (nginx-ingress) +- Ingress controller (Ingress NGINX) - [Helm](https://helm.sh/) >= v3.9.0 - [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v0.157.0** - [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0 @@ -54,7 +54,7 @@ The deployment is intended to use only over HTTPS via a configured FQDN, therefo configured ingress controller deployed. **Supported controllers:** -- [NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress) +- [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx) Note: The platform development team is evaluating the use of [Gateway API](https://gateway-api.sigs.k8s.io/). If you have feedback on that topic, please share it with us.