Documentation Issues

1

Morning,

I setup Kong OSS version only 2 months ago on kubernetes using what I believe was the recommended hybrid approach. I have a yaml file for the control_plane and a yaml for the data_plane. There was plenty of documentation for the Kong Gateway OSS version which appear to have been taken down.

https://docs.konghq.com/latest/configuration
https://docs.konghq.com/gateway-oss/3.0.x/hybrid-mode

I have found some archived docs which look similar to the docs i referenced only a few months ago:
https://legacy-gateway--kongdocs.netlify.app/gateway-oss/2.5.x/hybrid-mode/

The new documentation feels sparse, poorly linked, and no way near as concise as it was only a few months ago. There were clear-ish examples and now, just a list of properties and just long pages of config to scratch through, which is borderline useless (for me anyway)

Is the OSS version no longer supported? If so is there any documentation for it? I get that paid support is the end goal, but as it stands currently, I am days away from dropping Kong from my list and looking at other options. I am in the middle of evaluating several gateway options, and poor documentation is a deal breaker.

Maybe I have missed something but the documentation at the moment appear to be in disarray.

2 Likes
2

Agreed. Until a couple of days ago I was using the docs for developing custom plugins but know they’re all gone. The URLs that I was accessing just redirect to the new docs which are missing a lot of information.

3

Thank you for posting both. The majority of the content still exists, and we’re finding a few issues in the redirects.

@jdchris The hybrid mode config is one that’s currently missing. It’s on my list to rework in to a more structured how-to guide, but I need a few more days to get it finished. I’ll let you know when it’s ready.

@gustavocesario-as What are you looking for specifically when it comes to custom plugins?
Custom plugins | Kong Docs Should link to everything that was on the old site

4

@mheap

I was looking for this section about custom js plugins: Plugins in Other Languages - v2.5.x | Kong Docs

The URL for the documentation in the github repository also redirects to the new documentation which is missing this information about js plugins.

5

Got it, thank you. I’ll let the team know and we’ll get a link to you ASAP

1 Like
6

Hello @mheap

I can see the docs changing from day do day, but i’m still concerned about the documentation overall quality and navigation in this new version. It is now confusing, counter-intuitive and lots of links redirect to completely useless/redundant information or there is no link at all.

Example 1: How to: Install Kong Gateway Operator | Kong Docs : instructions to deploy in on-prem mode still uses Konnect references

Example 2: Gateway Discovery - Kong Ingress Controller | Kong Docs There is no direct link for deployment instructions.

Example 3: Kong Plugin Hub | Kong Docs No way to know/filter what plugins are free and what are enterprise.

Now in possession of an Enterprise license, I must confess I’m quite frustrated while trying to to basic stuff. How much work is still in progress considering documentation improvements?

Is there any way to bring back the old documentation on an alternate page?

7

Thank you for your patience. The non-Lua docs are now available at Custom plugins | Kong Docs

1 Like
8

Example 1: How to: Install Kong Gateway Operator | Kong Docs : instructions to deploy in on-prem mode still uses Konnect references

Thanks for pointing this out. The --set env.ENABLE_CONTROLLER_KONNECT=true line comes from some shared instructions. I’ll get that that removed for on-prem docs (but it doesn’t affect anything unless you have a Konnect API key in your cluster)

Example 2: Gateway Discovery - Kong Ingress Controller | Kong Docs There is no direct link for deployment instructions.

Good call out. We’ll add How to: Install Kong Ingress Controller | Kong Docs as a related link in the sidebar and to the next steps at the bottom of the page

Example 3: Kong Plugin Hub | Kong Docs No way to know/filter what plugins are free and what are enterprise.

I’ll pass this feedback on to our Gateway product team

9

I am new to Kong and also finding it difficult to navigate the documentation.

I am trying to figure out how to use the OSS images for the Kubernetes gateway operator?

I deployed the operator with Helm using basically the default values and during testing I noticed that it has provisioned an Enterprise version (kong/3.9.1.2-enterprise-edition).

k -n kong-gateway exec -it dataplane-kong-kgf5b-dptgs-8bb6f687b-kr47l – kong version
Kong Enterprise 3.9.1.2

Please can you advise how I can go about referencing the OSS images for the gateway operator, control plane and data plane?

I am hoping that the gateway operator is not just an enterprise feature… Although this article seems to mention that it is OSS? Introducing the World’s First OSS Production-Grade Gateway API Operator | Kong Inc.

Any guidance / assistance with the above would be appreciated.

10

You can use podTemplateSpec to customize the images e.g.

echo '
apiVersion: gateway-operator.konghq.com/v1beta1
kind: DataPlane
metadata:
  name: dataplane-example
  namespace: kong
spec:
  deployment:
    podTemplateSpec:
      spec:
        containers:
        - name: proxy
          image: kong:3.9
' | kubectl apply -f -

via How to: Set DataPlane Image | Kong Docs

11

@mheap thank you for the response.

Perfect, where can I find the documentation around which images to use for OSS?

12

https://hub.docker.com/\_/kong contains all of the available images

13

@mheap that’s great, what I am after is a reference to which image tags are for the OSS version so that I can update the podTemplateSpec to deploy the OSS version..

14

All of the tags in that repository are for the OSS version

15

Perfect, thank you for the information, much appreciated.