Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… strategy, avoiding name and custom_id collision risks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Kong Identity reference page to guide users migrating from the legacy Kong Gateway OAuth 2.0 plugin to Kong Identity (client credentials flow), plus a small Vale dictionary update to support the new terminology.
Changes:
- Added a new migration reference doc under
app/kong-identity/describing the end-to-end migration workflow (credential extraction, auth server/client setup, Consumer mapping, OIDC plugin configuration, and verification). - Updated the Vale dictionary to accept the term “unhashed”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| app/kong-identity/migrate-oauth-to-identity.md | New migration reference doc for moving from OAuth 2.0 plugin to Kong Identity + OIDC validation. |
| .github/styles/base/Dictionary.txt | Adds “unhashed” to prevent style/spellcheck false positives in the new doc. |
Suppressed comments (2)
app/kong-identity/migrate-oauth-to-identity.md:317
- This sentence suggests configuring OAuth 2.0 Introspection as an alternative, but the rest of the guide only documents the OIDC plugin; either add Introspection steps or remove the mention here to match the actual workflow.
Your current setup with the OAuth 2.0 plugin still maps the old Consumer. To finish the migration, configure the OIDC or OAuth 2.0 Introspection plugin to start using tokens issued by the {{site.identity}} authorization server.
app/kong-identity/migrate-oauth-to-identity.md:513
- The verification step says to check
X-Consumer-*response headers, but the example pipes the response body tojqand doesn't print headers; use-D -(or-i) so readers can actually see the headers and status code.
curl -sk $KONG_PROXY_URL${ROUTE_PATH} \
-H "Authorization: Bearer $ACCESS_TOKEN" | jq
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR provides instructions for migrating from the legacy OAuth 2.0 plugin to Kong Identity + OIDC plugin on an Enterprise setup.
closes #3462
Preview Links
https://deploy-preview-6483--kongdeveloper.netlify.app/identity/migrate-oauth-to-identity
Testing Instructions
The following scripts set up a stack that a user following this guide is expected to have.
You need a valid Kong license saved as
KONG_LICENSE_DATA. Then run the following scripts (for example:./00-reviewer-bootstrap.sh):Before migrating a single or multiple Consumers to a single or all services:
00-reviewer-bootstrap.sh
Cleanup Identity resources between tests:
01-cleanup-identity.sh
Troubleshooting tests
To test the sanitizing and de-hashing scripts
2. Migrate a hashed credential:
02-add-hashed-consumer.sh
3. Migrate a malformed
client_id:03-add-malformed-client-id.sh
Checklist
descriptionentry in frontmatter.