Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for externalized consumers #7657

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jschmid1
Copy link
Contributor

Description

Testing instructions

Preview link:

Checklist

Copy link

netlify bot commented Jul 18, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit ac821af
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/66c6418e4d65f400086af23e
😎 Deploy Preview https://deploy-preview-7657--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 91 (🟢 up 1 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@jschmid1 jschmid1 added the do not merge Issues/ PRs whose changes should not be merged at this time label Jul 18, 2024
@Guaris Guaris added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Jul 22, 2024
@lena-larionova lena-larionova added this to the Gateway 3.8 milestone Jul 23, 2024
@Guaris Guaris self-assigned this Aug 19, 2024
@Guaris Guaris marked this pull request as ready for review August 19, 2024 16:29
@Guaris Guaris requested a review from a team as a code owner August 19, 2024 16:29
Comment on lines 366 to 367
- geo: null
id: null
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

geo and id should be optional (default null) imo


-- Dummy/Link that points to Konnect Docs when ready.

With the `pool_id` you obtained from the previous step, you can configure the key-auth plugin to validate API keys against the Identity Service.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jschmid1 where does the pool_id come from? Konnect?

Copy link
Contributor

@smritikjaggi smritikjaggi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to change all references of pools to realms, and update the field terminology

@@ -0,0 +1,71 @@
---
nav_title:
title: How to configure pools
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to Realms

---


With `pool_id` you can configure the key-auth plugin to validate API keys against the Identity Service.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to "realm_id"


With `pool_id` you can configure the key-auth plugin to validate API keys against the Identity Service.

### Configuring Multiple Pools
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to "Realms"


### Configuring Multiple Pools

In the key-auth plugin configuration, add the `pools` option as shown below:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to "realms"

In the key-auth plugin configuration, add the `pools` option as shown below:

```yaml
pools:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to "identity_realms"

type: remote
```

In this configuration, the dataplane will initially check the local pool (LMDB) before querying the remote Identity Service.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cp-scoped consumers first


In this configuration, the dataplane will initially check the local pool (LMDB) before querying the remote Identity Service.

If a matching key is found in any of these pools, the request will be authenticated. If the key is not found in any of the configured pools, the request will be blocked.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"realms"


If a matching key is found in any of these pools, the request will be authenticated. If the key is not found in any of the configured pools, the request will be blocked.

### Configuring Single Pools
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Single Realm


### Configuring Single Pools

It is also possible to configure only a single pool, either local or remote. However, only one of each type can be configured.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change pool to realm
change "either local or remote" to "consumers can be scoped to the geo or cp".


It is also possible to configure only a single pool, either local or remote. However, only one of each type can be configured.

To configure only a remote pool:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change "remote pool" to "realm"

@lena-larionova lena-larionova removed this from the Gateway 3.8 milestone Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge Issues/ PRs whose changes should not be merged at this time review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants