onboard keycloak auth provider plugin as dynamic #3258
There are no files selected for viewing
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
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
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Auth provider metadata exists for publish, but E2E keeps the standard OIDC path | ||
| # (e2e-test-utils keycloak auth profile) until RHIDP-11651. An empty list here | ||
| # prevents metadata auto-generation from enabling the auth provider plugin. | ||
| plugins: [] |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| apiVersion: extensions.backstage.io/v1alpha1 | ||
| kind: Package | ||
| metadata: | ||
| name: backstage-community-plugin-auth-backend-module-keycloak-provider | ||
| namespace: rhdh | ||
| title: "Auth Backend Module Keycloak Provider" | ||
| links: | ||
| - url: https://red.ht/rhdh | ||
| title: Homepage | ||
| - url: https://github.com/backstage/community-plugins/issues | ||
| title: Bugs | ||
| - title: Source Code | ||
| url: https://github.com/backstage/community-plugins/tree/main/workspaces/keycloak/plugins/auth-backend-module-keycloak | ||
| annotations: | ||
| backstage.io/source-location: url:https://github.com/backstage/community-plugins/tree/main/workspaces/keycloak/plugins/auth-backend-module-keycloak | ||
| tags: | ||
| - authentication | ||
| spec: | ||
| packageName: "@backstage-community/plugin-auth-backend-module-keycloak-provider" | ||
| dynamicArtifact: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-auth-backend-module-keycloak-provider:bs_1.52.0__0.4.0 | ||
| version: 0.4.0 | ||
| backstage: | ||
| role: backend-plugin-module | ||
| supportedVersions: 1.52.0 | ||
| author: Red Hat | ||
| support: generally-available | ||
| lifecycle: active | ||
| partOf: | ||
| - backstage-community-plugin-auth-backend-module-keycloak-provider | ||
|
There was a problem hiding this comment. [low] metadata partOf references the entity itself (backstage-community-plugin-auth-backend-module-keycloak-provider) rather than a Plugin entity name. No matching kind: Plugin entity exists in catalog-entities/extensions/plugins/, so the Extensions UI link will not resolve. Other packages reference meaningful group names (e.g., keycloak-catalog-integration, jenkins). Suggested fix: Create a Plugin entity for the keycloak auth provider in catalog-entities/extensions/plugins/ and update partOf to reference it, or add this package to the existing keycloak-catalog-integration Plugin entity spec.packages list if appropriate. |
||
| appConfigExamples: | ||
|
There was a problem hiding this comment. [low] conventions partOf references the entity own name (backstage-community-plugin-auth-backend-module-keycloak-provider) rather than a logical group. Other packages use short group names (e.g. keycloak-catalog-integration, jenkins, adoption-insights). Suggested fix: Use a logical group name such as keycloak-auth or align with the existing keycloak-catalog-integration group. |
||
| - title: Default configuration | ||
| content: | ||
| auth: | ||
| providers: | ||
| keycloak: | ||
| development: | ||
| clientId: ${KEYCLOAK_CLIENT_ID} | ||
| clientSecret: ${KEYCLOAK_CLIENT_SECRET} | ||
| baseUrl: ${KEYCLOAK_BASE_URL} | ||
| realm: ${KEYCLOAK_REALM} | ||
| signIn: | ||
| resolvers: | ||
| - resolver: emailMatchingUserEntityProfileEmail | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| plugins/auth-backend-module-keycloak: | ||
| plugins/catalog-backend-module-keycloak: | ||
|
There was a problem hiding this comment. [low] style File lacks a trailing newline (pre-existing issue, not introduced by this PR). Suggested fix: Add a trailing newline to the file. |
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"repo":"https://github.com/backstage/community-plugins","repo-ref":"cc95112a8c4ff638a299f5f5fb818e6491f36577","repo-flat":false,"repo-backstage-version":"1.52.0"} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[low] completeness
The
partOffield self-references the Package entity name (backstage-community-plugin-auth-backend-module-keycloak-provider) instead of referencing akind: Pluginentity incatalog-entities/extensions/plugins/. No corresponding Plugin entity exists for the keycloak auth provider, so this package will not appear in the RHDH Extensions UI until one is created. The existing keycloak catalog module correctly referenceskeycloak-catalog-integrationwhich has a matching Plugin entity.Suggested fix: Create a
kind: Pluginentity incatalog-entities/extensions/plugins/for the keycloak auth provider (or add this package to the existingkeycloak-catalog-integrationPlugin entity'spackageslist), and update thepartOfreference accordingly. This can be done in a follow-up PR.