Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,22 @@ build:
| Property | Default Value | Type | Description |
|----------|---------------|------|-------------|
| `polaris.authentication.type` | `internal` | `enum (INTERNAL, EXTERNAL, MIXED)` | The type of authentication to use. |
| `polaris.authentication.credential-mode` | `internal` | `enum (INTERNAL, EXTERNAL)` | The credential mode to use. Valid values are `INTERNAL` and `EXTERNAL`. <br><br>Internal mode is the default. When internal mode is used, callers must have a corresponding principal in the Polaris metastore, which serves as the authoritative source of truth for principals, roles, and grants. <br><br>When external mode is used, callers are authenticated entirely from the presented credentials and are not required to have a corresponding entity in the Polaris metastore. Note that when the presented credentials were issued by Polaris itself, a backing principal entity is always required, regardless of the credential mode. <br><br>External credential mode is only meaningful when an external IDP is used, that is, when the authentication type (#type()) is (`AuthenticationType#EXTERNAL`) or (`AuthenticationType#MIXED`). Also, this mode is not compatible with the default, built-in Polaris authorizer; an external authorizer (e.g., OPA or Ranger) must be configured. |
| `polaris.authentication.authenticator.type` | `default` | `string` | The type of the identity provider. Must be a registered (`Authenticator`) identifier. |
| `polaris.authentication.token-service.type` | `default` | `string` | The type of the OAuth2 service. Must be a registered (`IcebergRestOAuth2ApiService`) identifier. |
| `polaris.authentication.credential-mode` | `internal` | `enum (INTERNAL, EXTERNAL)` | The credential mode to use. Valid values are `INTERNAL` and `EXTERNAL`. <br><br>Internal mode is the default. When internal mode is used, callers must have a corresponding principal in the Polaris metastore, which serves as the authoritative source of truth for principals, roles, and grants. <br><br>When external mode is used, callers are authenticated entirely from the presented credentials and are not required to have a corresponding entity in the Polaris metastore. Note that when the presented credentials were issued by Polaris itself, a backing principal entity is always required, regardless of the credential mode. <br><br>External credential mode is only meaningful when an external IDP is used, that is, when the authentication type (#type()) is (`AuthenticationType#EXTERNAL`) or (`AuthenticationType#MIXED`). Also, this mode is not compatible with the default, built-in Polaris authorizer; an external authorizer (e.g., OPA or Ranger) must be configured. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Wrapped descriptions now end in . |, but single-line ones like line 28 still end in . |. It doesn't show once rendered. Can we normalize that in a follow-up?

🤖 AI-generated review comment — agents make mistakes, so please verify before acting on it.

| `polaris.authentication.authenticator.type` | `default` | `string` | The type of the identity provider. Must be a registered (`Authenticator`) identifier. |
| `polaris.authentication.token-service.type` | `default` | `string` | The type of the OAuth2 service. Must be a registered (`IcebergRestOAuth2ApiService`) identifier. |
| `polaris.authentication.token-broker.max-token-generation` | `PT1H` | `duration` | The maximum token duration. |
| `polaris.authentication.token-broker.type` | `rsa-key-pair` | `string` | The type of the token broker factory. Must be a registered (`TokenBrokerFactory`) identifier. |
| `polaris.authentication.token-broker.type` | `rsa-key-pair` | `string` | The type of the token broker factory. Must be a registered (`TokenBrokerFactory`) identifier. |
| `polaris.authentication.token-broker.rsa-key-pair.public-key-file` | | `path` | The path to the public key file. |
| `polaris.authentication.token-broker.rsa-key-pair.private-key-file` | | `path` | The path to the private key file. |
| `polaris.authentication.token-broker.symmetric-key.secret` | | `string` | The secret to use for both signing and verifying signatures. Either this option of (`#file()`) must be provided. |
| `polaris.authentication.token-broker.symmetric-key.file` | | `path` | The file to read the secret from. Either this option of (`#secret()`) must be provided. |
| `polaris.authentication.token-broker.symmetric-key.secret` | | `string` | The secret to use for both signing and verifying signatures. Either this option of (`#file()`) must be provided. |
| `polaris.authentication.token-broker.symmetric-key.file` | | `path` | The file to read the secret from. Either this option of (`#secret()`) must be provided. |
| `polaris.authentication.`_`<realm>`_`.type` | `internal` | `enum (INTERNAL, EXTERNAL, MIXED)` | The type of authentication to use. |
| `polaris.authentication.`_`<realm>`_`.credential-mode` | `internal` | `enum (INTERNAL, EXTERNAL)` | The credential mode to use. Valid values are `INTERNAL` and `EXTERNAL`. <br><br>Internal mode is the default. When internal mode is used, callers must have a corresponding principal in the Polaris metastore, which serves as the authoritative source of truth for principals, roles, and grants. <br><br>When external mode is used, callers are authenticated entirely from the presented credentials and are not required to have a corresponding entity in the Polaris metastore. Note that when the presented credentials were issued by Polaris itself, a backing principal entity is always required, regardless of the credential mode. <br><br>External credential mode is only meaningful when an external IDP is used, that is, when the authentication type (#type()) is (`AuthenticationType#EXTERNAL`) or (`AuthenticationType#MIXED`). Also, this mode is not compatible with the default, built-in Polaris authorizer; an external authorizer (e.g., OPA or Ranger) must be configured. |
| `polaris.authentication.`_`<realm>`_`.authenticator.type` | `default` | `string` | The type of the identity provider. Must be a registered (`Authenticator`) identifier. |
| `polaris.authentication.`_`<realm>`_`.token-service.type` | `default` | `string` | The type of the OAuth2 service. Must be a registered (`IcebergRestOAuth2ApiService`) identifier. |
| `polaris.authentication.`_`<realm>`_`.credential-mode` | `internal` | `enum (INTERNAL, EXTERNAL)` | The credential mode to use. Valid values are `INTERNAL` and `EXTERNAL`. <br><br>Internal mode is the default. When internal mode is used, callers must have a corresponding principal in the Polaris metastore, which serves as the authoritative source of truth for principals, roles, and grants. <br><br>When external mode is used, callers are authenticated entirely from the presented credentials and are not required to have a corresponding entity in the Polaris metastore. Note that when the presented credentials were issued by Polaris itself, a backing principal entity is always required, regardless of the credential mode. <br><br>External credential mode is only meaningful when an external IDP is used, that is, when the authentication type (#type()) is (`AuthenticationType#EXTERNAL`) or (`AuthenticationType#MIXED`). Also, this mode is not compatible with the default, built-in Polaris authorizer; an external authorizer (e.g., OPA or Ranger) must be configured. |
| `polaris.authentication.`_`<realm>`_`.authenticator.type` | `default` | `string` | The type of the identity provider. Must be a registered (`Authenticator`) identifier. |
| `polaris.authentication.`_`<realm>`_`.token-service.type` | `default` | `string` | The type of the OAuth2 service. Must be a registered (`IcebergRestOAuth2ApiService`) identifier. |
| `polaris.authentication.`_`<realm>`_`.token-broker.max-token-generation` | `PT1H` | `duration` | The maximum token duration. |
| `polaris.authentication.`_`<realm>`_`.token-broker.type` | `rsa-key-pair` | `string` | The type of the token broker factory. Must be a registered (`TokenBrokerFactory`) identifier. |
| `polaris.authentication.`_`<realm>`_`.token-broker.type` | `rsa-key-pair` | `string` | The type of the token broker factory. Must be a registered (`TokenBrokerFactory`) identifier. |
| `polaris.authentication.`_`<realm>`_`.token-broker.rsa-key-pair.public-key-file` | | `path` | The path to the public key file. |
| `polaris.authentication.`_`<realm>`_`.token-broker.rsa-key-pair.private-key-file` | | `path` | The path to the private key file. |
| `polaris.authentication.`_`<realm>`_`.token-broker.symmetric-key.secret` | | `string` | The secret to use for both signing and verifying signatures. Either this option of (`#file()`) must be provided. |
| `polaris.authentication.`_`<realm>`_`.token-broker.symmetric-key.file` | | `path` | The file to read the secret from. Either this option of (`#secret()`) must be provided. |
| `polaris.authentication.`_`<realm>`_`.token-broker.symmetric-key.secret` | | `string` | The secret to use for both signing and verifying signatures. Either this option of (`#file()`) must be provided. |
| `polaris.authentication.`_`<realm>`_`.token-broker.symmetric-key.file` | | `path` | The file to read the secret from. Either this option of (`#secret()`) must be provided. |
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ build:

Configuration for OPA (Open Policy Agent) authorization.

Beta Feature: OPA authorization is currently in Beta and is not a stable release. It may undergo breaking changes in future versions. Use with caution in production environments.
Beta Feature: OPA authorization is currently in Beta and is not a stable release. It may undergo breaking changes in future versions. Use with caution in production environments.

| Property | Default Value | Type | Description |
|----------|---------------|------|-------------|
Expand All @@ -34,8 +34,8 @@ Beta Feature: OPA authorization is currently in Beta and is not a stable releas
| `polaris.authorization.opa.auth.bearer.static-token.value` | | `string` | Static bearer token value |
| `polaris.authorization.opa.auth.bearer.file-based.path` | | `path` | Path to file containing bearer token |
| `polaris.authorization.opa.auth.bearer.file-based.refresh-interval` | | `duration` | How often to refresh file-based bearer tokens (defaults to 5 minutes if not specified) |
| `polaris.authorization.opa.auth.bearer.file-based.jwt-expiration-refresh` | | `boolean` | Whether to automatically detect JWT tokens and use their 'exp' field for refresh timing. If true and the token is a valid JWT with an 'exp' claim, the token will be refreshed based on the expiration time minus the buffer, rather than the fixed refresh interval. Defaults to true if not specified. |
| `polaris.authorization.opa.auth.bearer.file-based.jwt-expiration-buffer` | | `duration` | Buffer time before JWT expiration to refresh the token. Only used when jwtExpirationRefresh is true and the token is a valid JWT. Defaults to 1 minute if not specified. |
| `polaris.authorization.opa.auth.bearer.file-based.jwt-expiration-refresh` | | `boolean` | Whether to automatically detect JWT tokens and use their 'exp' field for refresh timing. If true and the token is a valid JWT with an 'exp' claim, the token will be refreshed based on the expiration time minus the buffer, rather than the fixed refresh interval. Defaults to true if not specified. |
| `polaris.authorization.opa.auth.bearer.file-based.jwt-expiration-buffer` | | `duration` | Buffer time before JWT expiration to refresh the token. Only used when jwtExpirationRefresh is true and the token is a valid JWT. Defaults to 1 minute if not specified. |
| `polaris.authorization.opa.auth.bearer.file-based.initial-token-wait` | | `duration` | How long to wait for the first token load before failing a request. Defaults to 5 seconds. |
| `polaris.authorization.opa.auth.bearer.file-based.refresh-retry-interval` | | `duration` | How long to wait before retrying after a failed token refresh. Defaults to 1 second. |
| `polaris.authorization.opa.http.timeout` | `PT2S` | `duration` | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ build:

Quarkus configuration mapping for Polaris Credential Manager.

Defines which (`PolarisCredentialManager`) implementation should be used at runtime. This allows switching between different credential management strategies via configuration.
Defines which (`PolarisCredentialManager`) implementation should be used at runtime. This allows switching between different credential management strategies via configuration.

| Property | Default Value | Type | Description |
|----------|---------------|------|-------------|
| `polaris.credential-manager.type` | | `string` | The type identifier of the PolarisCredentialManager implementation to use. This corresponds to the `@Identifier` annotation value on the implementation (e.g., "default"). |
| `polaris.credential-manager.type` | | `string` | The type identifier of the PolarisCredentialManager implementation to use. This corresponds to the `@Identifier` annotation value on the implementation (e.g., "default"). |
Loading
Loading