Gateway entities: services, consumers, plugins, consumer groups #172

lena-larionova · 2024-12-12T05:00:19Z

Preview Links

Updating entities that already have pages:

Services
Consumers
Plugins

And adding a new page for Consumer Groups.

To do:

Migrate consumer groups how-to guides
Look for how-to guides for the other entities
Improve offshoot plugin pages
FAQs for services, consumer groups, plugins
improve the examples

https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/consumer-group/
https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/consumer/
https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/service/
https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/plugin/

Notes and questions

~~{{ variable.name}} doesn't seem to work in yaml consistently~~
plugins page: does it still make sense to add a generic plugin config?
~~Notes styling: it's fine that it doesn't exist yet, but is there a format that we should follow that'll eventually get styled?~~
~~Something weird going on with arrows in mermaid: https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/consumer-group/~~
How far does the "Gateway Service" term extend? Should we use it in page titles like https://deploy-preview-172--kongdeveloper.netlify.app/gateway/entities/service/?
~~Is it possible to generate https://deploy-preview-172--kongdeveloper.netlify.app/plugins/scopes/ now, and can we (authors) write these generators, if possible?~~

Checklist

Every page is page one
Tested how-to docs. If not, note why here.
All pages contain metadata
Updated sources.yaml. For more info review track docs changes
Any new docs link to existing docs.

netlify · 2024-12-12T05:02:11Z

✅ Deploy Preview for kongdeveloper ready!

Name	Link
🔨 Latest commit	`357dace`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdeveloper/deploys/67629a197a8eec000999409d
😎 Deploy Preview	https://deploy-preview-172--kongdeveloper.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

fabianrbz · 2024-12-16T07:48:27Z

{{ variable.name}} doesn't seem to work in yaml consistently

where is this happening? we need to apply the liquify filter to it, i.e. {{ variable | liquify }}

Notes styling

We have the following styles for admonitions

Something weird going on with arrows in mermaid

I fixed it on your branch :)

lena-larionova · 2024-12-17T20:35:23Z

app/_gateway_entities/plugin.md

+To start creating your own plugins, review the Getting Started documentation, or see the following references:
+
+* Plugin Development Kit reference
+* Other Language Support
+


Links TBA, we don't have these pages yet, and the first one is meant to be generated.

cloudjumpercat · 2024-12-17T20:43:41Z

app/_gateway_entities/consumer-group.md

+
+## What is a Consumer Group?
+
+Consumer Groups enable the organization and categorization of [Consumers](/gateway/entities/consumer/) (users or applications) within an API ecosystem. By grouping Consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.


I liked the call out you had on Consumers about them not always being "human", could we add some wording like that to here as well?

app/_gateway_entities/consumer.md

cloudjumpercat · 2024-12-17T20:51:30Z

app/_gateway_entities/consumer.md

+  - q: What is the difference between Consumers and Applications?
    a: |
-      Applications provide developers the ability to get access to APIs managed by {{site.base_gateway}} or Konnect
-      with no interaction from the Kong admin team to generate credentials required.
+      Applications provide developers the ability to get access to APIs managed by {{site.base_gateway}} or {{site.konnect_short_name}}
+      with no interaction from the Kong admin team to generate the required credentials.
      <br><br>
-      With consumers, the Kong team creates consumers, generates credentials and needs to share them with the developers that need access to the APIs.
-      You can think as applications as a type of consumer in Kong that allows developers to automatically obtain credentials for and subscribe to the required APIs.
+      With Consumers, the Kong team creates Consumers, generates credentials, and shares them with the developers that need access to the APIs.
+      You can think of Applications as a type of Consumer in Kong that allows developers to automatically obtain credentials for, and subscribe to the required APIs.

-  - q: What is the difference between consumers and developers?
+  - q: What is the difference between Consumers and Developers?
    a: |
-      Developers are real users of the Dev Portal, whereas consumers are abstractions.
+      Developers are real users of the Dev Portal, whereas Consumers are abstractions.

-  - q: What is the difference between consumers and RBAC users?
+  - q: What is the difference between Consumers and RBAC Users?


Application, Developers, and RBAC Users capitalization threw me here a bit. I guess they are entities, but they feel less like a core entity.

Yeah, I think we have to leave them like this for consistency. Otherwise we'll start arbitrarily drawing the line between what is "core" and what isn't, which isn't actually a set definition.

app/_gateway_entities/consumer.md

app/plugins/scopes.md

cloudjumpercat · 2024-12-17T21:07:08Z

app/_gateway_entities/plugin.md

@@ -42,6 +43,73 @@ The set of plugins you have access to depends on your license tier.

 You can also develop custom plugins, adding your own custom functionality to {{site.base_gateway}}.

+## Plugin precedence


I'd move this section to plugin scopes. I had questions about precedence while I was reading it and this is more detailed reference material than the intro/overview content that's on the entity pages.

Oh, i like this idea. I struggled with keeping precedence info as a separate page, but if it goes with scopes, it fits more naturally.

cloudjumpercat · 2024-12-17T21:09:47Z

app/_gateway_entities/plugin.md

@@ -42,6 +43,73 @@ The set of plugins you have access to depends on your license tier.

 You can also develop custom plugins, adding your own custom functionality to {{site.base_gateway}}.


The only thing I can think of that might be nice to add here is a small list of the main plugin "themes" Kong has, just to give an idea what a plugin can do. Like:

Traffic control

Authentication

AI

etc.

Co-authored-by: Diana <[email protected]>

lena-larionova and others added 4 commits December 16, 2024 22:38

update services, consumers, plugins; add a consumer groups page

d6d0343

consumer groups edits

66b9e9b

Fix mermaid styles

ab81e89

faqs; move precedence info; clean up + better API links

d24d1c2

lena-larionova force-pushed the migrate-entities branch from f69a8af to d24d1c2 Compare December 17, 2024 07:36

use variables

12c0be2

lena-larionova commented Dec 17, 2024

View reviewed changes

cloudjumpercat reviewed Dec 17, 2024

View reviewed changes

lmilan and others added 2 commits December 18, 2024 10:22

Apply suggestions from code review

914b55c

Co-authored-by: Diana <[email protected]>

made some updates based on Diana's feedback

357dace

Guaris marked this pull request as ready for review December 18, 2024 21:00

Guaris requested a review from a team as a code owner December 18, 2024 21:00

Guaris merged commit 6039d65 into main Dec 19, 2024
14 checks passed

Guaris deleted the migrate-entities branch December 19, 2024 01:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gateway entities: services, consumers, plugins, consumer groups #172

Gateway entities: services, consumers, plugins, consumer groups #172

lena-larionova commented Dec 12, 2024 •

edited

Loading

netlify bot commented Dec 12, 2024 •

edited

Loading

fabianrbz commented Dec 16, 2024 •

edited

Loading

lena-larionova Dec 17, 2024

cloudjumpercat Dec 17, 2024

cloudjumpercat Dec 17, 2024

lena-larionova Dec 17, 2024

cloudjumpercat Dec 17, 2024

lena-larionova Dec 17, 2024

cloudjumpercat Dec 17, 2024


		## What is a Consumer Group?

		Consumer Groups enable the organization and categorization of [Consumers](/gateway/entities/consumer/) (users or applications) within an API ecosystem. By grouping Consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.

		@@ -42,6 +43,73 @@ The set of plugins you have access to depends on your license tier.

		You can also develop custom plugins, adding your own custom functionality to {{site.base_gateway}}.

		## Plugin precedence

Gateway entities: services, consumers, plugins, consumer groups #172

Gateway entities: services, consumers, plugins, consumer groups #172

Conversation

lena-larionova commented Dec 12, 2024 • edited Loading

Preview Links

Notes and questions

Checklist

netlify bot commented Dec 12, 2024 • edited Loading

✅ Deploy Preview for kongdeveloper ready!

fabianrbz commented Dec 16, 2024 • edited Loading

lena-larionova Dec 17, 2024

Choose a reason for hiding this comment

cloudjumpercat Dec 17, 2024

Choose a reason for hiding this comment

cloudjumpercat Dec 17, 2024

Choose a reason for hiding this comment

lena-larionova Dec 17, 2024

Choose a reason for hiding this comment

cloudjumpercat Dec 17, 2024

Choose a reason for hiding this comment

lena-larionova Dec 17, 2024

Choose a reason for hiding this comment

cloudjumpercat Dec 17, 2024

Choose a reason for hiding this comment

lena-larionova commented Dec 12, 2024 •

edited

Loading

netlify bot commented Dec 12, 2024 •

edited

Loading

fabianrbz commented Dec 16, 2024 •

edited

Loading