Giters

emissary-ingress / emissary

open source Kubernetes-native API gateway for microservices built on the Envoy Proxy

Home Page:https://www.getambassador.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs for Ingress resource object is stale, documents deprecated APIs

darkn3rd opened this issue · comments

commented

Describe the bug

The current documentation for the Ingress resource object only documents the networking.k8s.io/v1beta1 API from Kubernetes 1.18 in 2020. It has not been updated since then, and links reference a blog on Medium that is equally stale. The source code seems to support the current API. Also, other deprecated APIs that are not supported with emissary-ingress are documented.

To Reproduce

Steps to reproduce the behavior:

  1. Navigate to Ingress documentation and find this https://www.getambassador.io/docs/emissary/latest/topics/running/ingress-controller#when-and-how-to-use-the-ingress-resource
  2. As a part of the instructions, an external blog is referenced, which also covers deprecated API: https://blog.getambassador.io/new-kubernetes-1-18-extends-ingress-c34abdc2f064

Expected behavior

I expected that the documentation would document the current supported API in regards to Ingress, i.e. networking.k8s.io/v1. I also expected that the documentation would be complete with examples, and not defer to external blogs with more deprecated APIs.

Versions (please complete the following information):

  • Ambassador: 3.9.1
  • Kubernetes environment: GKE (v1.27.3-gke.100)

Additional context

Docs need love too.

commented

I hope someone can look at this.