dimas-b commented on code in PR #1550: URL: https://github.com/apache/polaris/pull/1550#discussion_r2080655980
##########
site/content/in-dev/unreleased/configuration.md:
##########
@@ -77,43 +77,46 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
## Polaris Configuration Options Reference
-| Configuration Property
| Default Value | Description
|
-|--------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `polaris.persistence.type`
| `in-memory` | Define the persistence backend used by
Polaris (`in-memory`, `eclipse-link`). See [Configuring Apache Polaris for
Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
-| `polaris.persistence.eclipselink.configurationFile`
| | Define the location of the
`persistence.xml`. By default, it's the built-in `persistence.xml` in use.
|
-| `polaris.persistence.eclipselink.persistenceUnit`
| `polaris` | Define the name of the persistence unit
to use, as defined in the `persistence.xml`.
|
-| `polaris.realm-context.type`
| `default` | Define the type of the Polaris realm to
use.
|
-| `polaris.realm-context.realms`
| `POLARIS` | Define the list of realms to use.
|
-| `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.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.
|
-| `polaris.authentication.token-broker.max-token-generation`
| `PT1H` | Define the max token generation policy
on the token broker.
|
-| `polaris.authentication.token-broker.rsa-key-pair.public-key-file`
| `/tmp/public.key` | Define the location of the public key
file.
|
-| `polaris.authentication.token-broker.rsa-key-pair.private-key-file`
| `/tmp/private.key` | Define the location of the private key
file.
|
-| `polaris.authentication.token-broker.symmetric-key.secret`
| `secret` | Define the secret of the symmetric key.
|
-| `polaris.authentication.token-broker.symmetric-key.file`
| `/tmp/symmetric.key` | Define the location of the symmetric key
file.
|
-| `polaris.storage.aws.access-key`
| `accessKey` | Define the AWS S3 access key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.aws.secret-key`
| `secretKey` | Define the AWS S3 secret key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.gcp.token`
| `token` | Define the Google Cloud Storage token.
If unset, the default credential provider chain will be used.
|
-| `polaris.storage.gcp.lifespan`
| `PT1H` | Define the Google Cloud Storage lifespan
type. If unset, the default credential provider chain will be used.
|
-| `polaris.log.request-id-header-name`
| `Polaris-Request-Id` | Define the header name to match request
ID in the log.
|
-| `polaris.log.mdc.aid`
| `polaris` | Define the log context (e.g. MDC) AID.
|
-| `polaris.log.mdc.sid`
| `polaris-service` | Define the log context (e.g. MDC) SID.
|
-| `polaris.rate-limiter.filter.type`
| `no-op` | Define the Polaris rate limiter.
Supported values are `no-op`, `token-bucket`.
|
-| `polaris.rate-limiter.token-bucket.type`
| `default` | Define the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.requests-per-second`
| `9999` | Define the number of requests per second
for the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.window`
| `PT10S` | Define the window type for the token
bucket rate limiter.
|
-| `polaris.metrics.tags.application`
| `Polaris` | Define the application name tag in
metrics.
|
-| `polaris.metrics.tags.service`
| `polaris` | Define the service tag in metrics.
|
-| `polaris.metrics.tags.environment`
| `prod` | Define the environement tag in metrics.
|
-| `polaris.metrics.tags.region`
| `us-west-2` | Define the region tag in metrics.
|
-| `polaris.tasks.max-concurrent-tasks`
| `100` | Define the max number of concurrent
tasks.
|
-| `polaris.tasks.max-queued-tasks`
| `1000` | Define the max number of tasks in queue.
|
+| Configuration Property
| Default Value | Description
|
+|--------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence backend used by
Polaris (`in-memory`, `relational-jdbc`, `eclipse-link`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}}) |
+| `polaris.persistence.relational.jdbc.max-retries`
| `1` | Total number of retries we expect the
persistence to do before giving up
|
+| `polaris.persistence.relational.jdbc.max_duaration_in_ms`
| `5000 ms` | Time in ms since the first attempt the
retries should be performed by jdbc.
|
Review Comment:
suggestion: `Max time interval (ms) since the start of a transaction when
retries can be attempted.`
##########
site/content/in-dev/unreleased/configuration.md:
##########
@@ -77,43 +77,46 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
## Polaris Configuration Options Reference
-| Configuration Property
| Default Value | Description
|
-|--------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `polaris.persistence.type`
| `in-memory` | Define the persistence backend used by
Polaris (`in-memory`, `eclipse-link`). See [Configuring Apache Polaris for
Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
-| `polaris.persistence.eclipselink.configurationFile`
| | Define the location of the
`persistence.xml`. By default, it's the built-in `persistence.xml` in use.
|
-| `polaris.persistence.eclipselink.persistenceUnit`
| `polaris` | Define the name of the persistence unit
to use, as defined in the `persistence.xml`.
|
-| `polaris.realm-context.type`
| `default` | Define the type of the Polaris realm to
use.
|
-| `polaris.realm-context.realms`
| `POLARIS` | Define the list of realms to use.
|
-| `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.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.
|
-| `polaris.authentication.token-broker.max-token-generation`
| `PT1H` | Define the max token generation policy
on the token broker.
|
-| `polaris.authentication.token-broker.rsa-key-pair.public-key-file`
| `/tmp/public.key` | Define the location of the public key
file.
|
-| `polaris.authentication.token-broker.rsa-key-pair.private-key-file`
| `/tmp/private.key` | Define the location of the private key
file.
|
-| `polaris.authentication.token-broker.symmetric-key.secret`
| `secret` | Define the secret of the symmetric key.
|
-| `polaris.authentication.token-broker.symmetric-key.file`
| `/tmp/symmetric.key` | Define the location of the symmetric key
file.
|
-| `polaris.storage.aws.access-key`
| `accessKey` | Define the AWS S3 access key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.aws.secret-key`
| `secretKey` | Define the AWS S3 secret key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.gcp.token`
| `token` | Define the Google Cloud Storage token.
If unset, the default credential provider chain will be used.
|
-| `polaris.storage.gcp.lifespan`
| `PT1H` | Define the Google Cloud Storage lifespan
type. If unset, the default credential provider chain will be used.
|
-| `polaris.log.request-id-header-name`
| `Polaris-Request-Id` | Define the header name to match request
ID in the log.
|
-| `polaris.log.mdc.aid`
| `polaris` | Define the log context (e.g. MDC) AID.
|
-| `polaris.log.mdc.sid`
| `polaris-service` | Define the log context (e.g. MDC) SID.
|
-| `polaris.rate-limiter.filter.type`
| `no-op` | Define the Polaris rate limiter.
Supported values are `no-op`, `token-bucket`.
|
-| `polaris.rate-limiter.token-bucket.type`
| `default` | Define the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.requests-per-second`
| `9999` | Define the number of requests per second
for the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.window`
| `PT10S` | Define the window type for the token
bucket rate limiter.
|
-| `polaris.metrics.tags.application`
| `Polaris` | Define the application name tag in
metrics.
|
-| `polaris.metrics.tags.service`
| `polaris` | Define the service tag in metrics.
|
-| `polaris.metrics.tags.environment`
| `prod` | Define the environement tag in metrics.
|
-| `polaris.metrics.tags.region`
| `us-west-2` | Define the region tag in metrics.
|
-| `polaris.tasks.max-concurrent-tasks`
| `100` | Define the max number of concurrent
tasks.
|
-| `polaris.tasks.max-queued-tasks`
| `1000` | Define the max number of tasks in queue.
|
+| Configuration Property
| Default Value | Description
|
+|--------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence backend used by
Polaris (`in-memory`, `relational-jdbc`, `eclipse-link`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}}) |
+| `polaris.persistence.relational.jdbc.max-retries`
| `1` | Total number of retries we expect the
persistence to do before giving up
|
Review Comment:
Please specify what is retriable... We do not retry on all failures
##########
site/content/in-dev/unreleased/configuration.md:
##########
@@ -77,43 +77,46 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
## Polaris Configuration Options Reference
-| Configuration Property
| Default Value | Description
|
-|--------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `polaris.persistence.type`
| `in-memory` | Define the persistence backend used by
Polaris (`in-memory`, `eclipse-link`). See [Configuring Apache Polaris for
Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
-| `polaris.persistence.eclipselink.configurationFile`
| | Define the location of the
`persistence.xml`. By default, it's the built-in `persistence.xml` in use.
|
-| `polaris.persistence.eclipselink.persistenceUnit`
| `polaris` | Define the name of the persistence unit
to use, as defined in the `persistence.xml`.
|
-| `polaris.realm-context.type`
| `default` | Define the type of the Polaris realm to
use.
|
-| `polaris.realm-context.realms`
| `POLARIS` | Define the list of realms to use.
|
-| `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.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.
|
-| `polaris.authentication.token-broker.max-token-generation`
| `PT1H` | Define the max token generation policy
on the token broker.
|
-| `polaris.authentication.token-broker.rsa-key-pair.public-key-file`
| `/tmp/public.key` | Define the location of the public key
file.
|
-| `polaris.authentication.token-broker.rsa-key-pair.private-key-file`
| `/tmp/private.key` | Define the location of the private key
file.
|
-| `polaris.authentication.token-broker.symmetric-key.secret`
| `secret` | Define the secret of the symmetric key.
|
-| `polaris.authentication.token-broker.symmetric-key.file`
| `/tmp/symmetric.key` | Define the location of the symmetric key
file.
|
-| `polaris.storage.aws.access-key`
| `accessKey` | Define the AWS S3 access key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.aws.secret-key`
| `secretKey` | Define the AWS S3 secret key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.gcp.token`
| `token` | Define the Google Cloud Storage token.
If unset, the default credential provider chain will be used.
|
-| `polaris.storage.gcp.lifespan`
| `PT1H` | Define the Google Cloud Storage lifespan
type. If unset, the default credential provider chain will be used.
|
-| `polaris.log.request-id-header-name`
| `Polaris-Request-Id` | Define the header name to match request
ID in the log.
|
-| `polaris.log.mdc.aid`
| `polaris` | Define the log context (e.g. MDC) AID.
|
-| `polaris.log.mdc.sid`
| `polaris-service` | Define the log context (e.g. MDC) SID.
|
-| `polaris.rate-limiter.filter.type`
| `no-op` | Define the Polaris rate limiter.
Supported values are `no-op`, `token-bucket`.
|
-| `polaris.rate-limiter.token-bucket.type`
| `default` | Define the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.requests-per-second`
| `9999` | Define the number of requests per second
for the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.window`
| `PT10S` | Define the window type for the token
bucket rate limiter.
|
-| `polaris.metrics.tags.application`
| `Polaris` | Define the application name tag in
metrics.
|
-| `polaris.metrics.tags.service`
| `polaris` | Define the service tag in metrics.
|
-| `polaris.metrics.tags.environment`
| `prod` | Define the environement tag in metrics.
|
-| `polaris.metrics.tags.region`
| `us-west-2` | Define the region tag in metrics.
|
-| `polaris.tasks.max-concurrent-tasks`
| `100` | Define the max number of concurrent
tasks.
|
-| `polaris.tasks.max-queued-tasks`
| `1000` | Define the max number of tasks in queue.
|
+| Configuration Property
| Default Value | Description
|
+|--------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence backend used by
Polaris (`in-memory`, `relational-jdbc`, `eclipse-link`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}}) |
+| `polaris.persistence.relational.jdbc.max-retries`
| `1` | Total number of retries we expect the
persistence to do before giving up
|
+| `polaris.persistence.relational.jdbc.max_duaration_in_ms`
| `5000 ms` | Time in ms since the first attempt the
retries should be performed by jdbc.
|
+| `polaris.persistence.relational.jdbc.initial_delay_in_ms`
| `100 ms` | Initial delay in ms before the first
attempt.
|
Review Comment:
Suggestion: `Initial delay before retrying. The delay is doubled after each
retry`.
##########
site/content/in-dev/unreleased/configuration.md:
##########
@@ -77,43 +77,46 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
## Polaris Configuration Options Reference
-| Configuration Property
| Default Value | Description
|
-|--------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `polaris.persistence.type`
| `in-memory` | Define the persistence backend used by
Polaris (`in-memory`, `eclipse-link`). See [Configuring Apache Polaris for
Production)[{{% ref "configuring-polaris-for-production.md" %}}) |
-| `polaris.persistence.eclipselink.configurationFile`
| | Define the location of the
`persistence.xml`. By default, it's the built-in `persistence.xml` in use.
|
-| `polaris.persistence.eclipselink.persistenceUnit`
| `polaris` | Define the name of the persistence unit
to use, as defined in the `persistence.xml`.
|
-| `polaris.realm-context.type`
| `default` | Define the type of the Polaris realm to
use.
|
-| `polaris.realm-context.realms`
| `POLARIS` | Define the list of realms to use.
|
-| `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.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.
|
-| `polaris.authentication.token-broker.max-token-generation`
| `PT1H` | Define the max token generation policy
on the token broker.
|
-| `polaris.authentication.token-broker.rsa-key-pair.public-key-file`
| `/tmp/public.key` | Define the location of the public key
file.
|
-| `polaris.authentication.token-broker.rsa-key-pair.private-key-file`
| `/tmp/private.key` | Define the location of the private key
file.
|
-| `polaris.authentication.token-broker.symmetric-key.secret`
| `secret` | Define the secret of the symmetric key.
|
-| `polaris.authentication.token-broker.symmetric-key.file`
| `/tmp/symmetric.key` | Define the location of the symmetric key
file.
|
-| `polaris.storage.aws.access-key`
| `accessKey` | Define the AWS S3 access key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.aws.secret-key`
| `secretKey` | Define the AWS S3 secret key. If unset,
the default credential provider chain will be used.
|
-| `polaris.storage.gcp.token`
| `token` | Define the Google Cloud Storage token.
If unset, the default credential provider chain will be used.
|
-| `polaris.storage.gcp.lifespan`
| `PT1H` | Define the Google Cloud Storage lifespan
type. If unset, the default credential provider chain will be used.
|
-| `polaris.log.request-id-header-name`
| `Polaris-Request-Id` | Define the header name to match request
ID in the log.
|
-| `polaris.log.mdc.aid`
| `polaris` | Define the log context (e.g. MDC) AID.
|
-| `polaris.log.mdc.sid`
| `polaris-service` | Define the log context (e.g. MDC) SID.
|
-| `polaris.rate-limiter.filter.type`
| `no-op` | Define the Polaris rate limiter.
Supported values are `no-op`, `token-bucket`.
|
-| `polaris.rate-limiter.token-bucket.type`
| `default` | Define the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.requests-per-second`
| `9999` | Define the number of requests per second
for the token bucket rate limiter.
|
-| `polaris.rate-limiter.token-bucket.window`
| `PT10S` | Define the window type for the token
bucket rate limiter.
|
-| `polaris.metrics.tags.application`
| `Polaris` | Define the application name tag in
metrics.
|
-| `polaris.metrics.tags.service`
| `polaris` | Define the service tag in metrics.
|
-| `polaris.metrics.tags.environment`
| `prod` | Define the environement tag in metrics.
|
-| `polaris.metrics.tags.region`
| `us-west-2` | Define the region tag in metrics.
|
-| `polaris.tasks.max-concurrent-tasks`
| `100` | Define the max number of concurrent
tasks.
|
-| `polaris.tasks.max-queued-tasks`
| `1000` | Define the max number of tasks in queue.
|
+| Configuration Property
| Default Value | Description
|
+|--------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence backend used by
Polaris (`in-memory`, `relational-jdbc`, `eclipse-link`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}}) |
Review Comment:
nit: `eclipse-link (deprecated)`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
