Skip to content

Add missing "overrides" to realm-override config examples & tests #1511

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Add missing "overrides" to realm-override config examples & tests #1511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
680baa3
add missing overrides
RichardLiu2001 May 2, 2025
ed55358
use feature
RichardLiu2001 May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion helm/polaris/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ data:
{{- end -}}
{{- range $realm, $overrides := .Values.features.realmOverrides -}}
{{- range $k, $v := $overrides -}}
{{- $_ = set $map (printf "polaris.config.realm-overrides.\"%s\".\"%s\"" $realm $k) (toJson $v) -}}
{{- $_ = set $map (printf "polaris.features.realm-overrides.\"%s\".overrides.\"%s\"" $realm $k) (toJson $v) -}}
{{- end -}}
{{- end -}}

Expand Down
4 changes: 2 additions & 2 deletions helm/polaris/tests/configmap_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ tests:
asserts:
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.features.defaults.\"feature1\"=true" }
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.features.defaults.\"feature2\"=42" }
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.config.realm-overrides.\"realm1\".\"feature1\"=false" }
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.config.realm-overrides.\"realm2\".\"feature2\"=43" }
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.features.realm-overrides.\"realm1\".overrides.\"feature1\"=false" }
- matchRegex: { path: 'data["application.properties"]', pattern: "polaris.features.realm-overrides.\"realm2\".overrides.\"feature2\"=43" }

- it: should configure persistence
set:
Expand Down
4 changes: 2 additions & 2 deletions quarkus/defaults/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ polaris.features.defaults."SUPPORTED_CATALOG_STORAGE_TYPES"=["S3","GCS","AZURE",
# polaris.features.defaults."ENABLE_CATALOG_FEDERATION"=true

# realm overrides
# polaris.features.realm-overrides."my-realm"."INITIALIZE_DEFAULT_CATALOG_FILEIO_FOR_TEST"=true
# polaris.features.realm-overrides."my-realm"."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"=true
# polaris.features.realm-overrides."my-realm".overrides."INITIALIZE_DEFAULT_CATALOG_FILEIO_FOR_TEST"=true
Copy link
Contributor

@gh-yzou gh-yzou May 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

actually, never mind, this seems adding another key at the nest level, do we wan to add another key (which kind of changes how the config of overrides look like before), or revert the change before? cc @adutra @eric-maynard

Copy link
Contributor

@eric-maynard eric-maynard May 12, 2025

Choose a reason for hiding this comment

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

If it works with @WithParentName, I think we should take that approach. From a behavior perspective, IMO we should try to revert back to the existing behavior. Ideally before 1.0.

Copy link
Contributor

@gh-yzou gh-yzou May 12, 2025

Choose a reason for hiding this comment

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

If we want to fix to keep the old behavior, then the only doc update is "config" -> "features" change

# polaris.features.realm-overrides."my-realm".overrides."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"=true

# polaris.persistence.type=eclipse-link
# polaris.persistence.type=in-memory-atomic
Expand Down
4 changes: 2 additions & 2 deletions site/content/in-dev/unreleased/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ read-only mode, as Polaris only reads the configuration file once, at startup.
| `polaris.realm-context.header-name` | `Polaris-Realm` | Define the header name defining the realm context. |
| `polaris.features.defaults."ENFORCE_PRINCIPAL_CREDENTIAL_ROTATION_REQUIRED_CHECKING"` | `false` | Flag to enforce check if credential rotation. |
| `polaris.features.defaults."SUPPORTED_CATALOG_STORAGE_TYPES"` | `FILE` | Define the catalog supported storage. Supported values are `S3`, `GCS`, `AZURE`, `FILE`. |
| `polaris.features.realm-overrides."my-realm"."INITIALIZE_DEFAULT_CATALOG_FILEIO_FOR_TEST"` | `true` | "Override" realm features, here the catalog init default flag. |
| `polaris.features.realm-overrides."my-realm"."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"` | `true` | "Override" realm features, here the skip credential subscoping indirection flag. |
| `polaris.features.realm-overrides."my-realm".overrides."INITIALIZE_DEFAULT_CATALOG_FILEIO_FOR_TEST"` | `true` | "Override" realm features, here the catalog init default flag. |
| `polaris.features.realm-overrides."my-realm".overrides."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"` | `true` | "Override" realm features, here the skip credential subscoping indirection flag. |
| `polaris.authentication.authenticator.type` | `default` | Define the Polaris authenticator type. |
| `polaris.authentication.token-service.type` | `default` | Define the Polaris token service type. |
| `polaris.authentication.token-broker.type` | `rsa-key-pair` | Define the Polaris token broker type. |
Expand Down
Loading