This is an automated email from the ASF dual-hosted git repository.
yzheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 6f51d81e1 Sync helm doc (#2034)
6f51d81e1 is described below
commit 6f51d81e1d5de549d47a0f3b44f4daa2acb496df
Author: Yong Zheng <[email protected]>
AuthorDate: Fri Jul 11 14:07:02 2025 -0500
Sync helm doc (#2034)
---
site/content/in-dev/unreleased/helm.md | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/site/content/in-dev/unreleased/helm.md
b/site/content/in-dev/unreleased/helm.md
index b649641df..44cf6cdb9 100644
--- a/site/content/in-dev/unreleased/helm.md
+++ b/site/content/in-dev/unreleased/helm.md
@@ -191,14 +191,20 @@ ct install --namespace polaris --charts ./helm/polaris
|-----|------|---------|-------------|
| advancedConfig | object | `{}` | Advanced configuration. You can pass here
any valid Polaris or Quarkus configuration property. Any property that is
defined here takes precedence over all the other configuration values generated
by this chart. Properties can be passed "flattened" or as nested YAML objects
(see examples below). Note: values should be strings; avoid using numbers,
booleans, or other types. |
| affinity | object | `{}` | Affinity and anti-affinity for polaris pods. See
https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity.
|
-| authentication | object |
`{"authenticator":{"type":"default"},"tokenBroker":{"maxTokenGeneration":"PT1H","secret":{"name":null,"privateKey":"private.pem","publicKey":"public.pem","secretKey":"secret"},"type":"rsa-key-pair"},"tokenService":{"type":"default"}}`
| Polaris authentication configuration. |
+| authentication | object |
`{"authenticator":{"type":"default"},"tokenBroker":{"maxTokenGeneration":"PT1H","secret":{"name":null,"privateKey":"private.pem","publicKey":"public.pem","rsaKeyPair":{"privateKey":"private.pem","publicKey":"public.pem"},"secretKey":"symmetric.pem","symmetricKey":{"secretKey":"symmetric.pem"}},"type":"rsa-key-pair"},"tokenService":{"type":"default"}}`
| Polaris authentication configuration. |
| authentication.authenticator | object | `{"type":"default"}` | The type of
authentication to use. Two built-in types are supported: default and test; test
is not recommended for production. |
-| authentication.tokenBroker | object |
`{"maxTokenGeneration":"PT1H","secret":{"name":null,"privateKey":"private.pem","publicKey":"public.pem","secretKey":"secret"},"type":"rsa-key-pair"}`
| The type of token broker to use. Two built-in types are supported:
rsa-key-pair and symmetric-key. |
-| authentication.tokenBroker.secret | object |
`{"name":null,"privateKey":"private.pem","publicKey":"public.pem","secretKey":"secret"}`
| The secret name to pull the public and private keys, or the symmetric key
secret from. |
+| authentication.tokenBroker | object |
`{"maxTokenGeneration":"PT1H","secret":{"name":null,"privateKey":"private.pem","publicKey":"public.pem","rsaKeyPair":{"privateKey":"private.pem","publicKey":"public.pem"},"secretKey":"symmetric.pem","symmetricKey":{"secretKey":"symmetric.pem"}},"type":"rsa-key-pair"}`
| The type of token broker to use. Two built-in types are supported:
rsa-key-pair and symmetric-key. |
+| authentication.tokenBroker.maxTokenGeneration | string | `"PT1H"` | Maximum
token generation duration (e.g., PT1H for 1 hour). |
+| authentication.tokenBroker.secret | object |
`{"name":null,"privateKey":"private.pem","publicKey":"public.pem","rsaKeyPair":{"privateKey":"private.pem","publicKey":"public.pem"},"secretKey":"symmetric.pem","symmetricKey":{"secretKey":"symmetric.pem"}}`
| The secret name to pull the public and private keys, or the symmetric key
secret from. |
| authentication.tokenBroker.secret.name | string | `nil` | The name of the
secret to pull the keys from. If not provided, a key pair will be generated.
This is not recommended for production. |
-| authentication.tokenBroker.secret.privateKey | string | `"private.pem"` |
The private key file to use for RSA key pair token broker. Only required when
using rsa-key-pair. |
-| authentication.tokenBroker.secret.publicKey | string | `"public.pem"` | The
public key file to use for RSA key pair token broker. Only required when using
rsa-key-pair. |
-| authentication.tokenBroker.secret.secretKey | string | `"secret"` | The
symmetric key file to use for symmetric key token broker. Only required when
using symmetric-key. |
+| authentication.tokenBroker.secret.privateKey | string | `"private.pem"` |
DEPRECATED: Use `authentication.tokenBroker.secret.rsaKeyPair.privateKey`
instead. Key name inside the secret for the private key |
+| authentication.tokenBroker.secret.publicKey | string | `"public.pem"` |
DEPRECATED: Use `authentication.tokenBroker.secret.rsaKeyPair.publicKey`
instead. Key name inside the secret for the public key |
+| authentication.tokenBroker.secret.rsaKeyPair | object |
`{"privateKey":"private.pem","publicKey":"public.pem"}` | Optional:
configuration specific to RSA key pair secret. |
+| authentication.tokenBroker.secret.rsaKeyPair.privateKey | string |
`"private.pem"` | Key name inside the secret for the private key |
+| authentication.tokenBroker.secret.rsaKeyPair.publicKey | string |
`"public.pem"` | Key name inside the secret for the public key |
+| authentication.tokenBroker.secret.secretKey | string | `"symmetric.pem"` |
DEPRECATED: Use `authentication.tokenBroker.secret.symmetricKey.secretKey`
instead. Key name inside the secret for the symmetric key |
+| authentication.tokenBroker.secret.symmetricKey | object |
`{"secretKey":"symmetric.pem"}` | Optional: configuration specific to symmetric
key secret. |
+| authentication.tokenBroker.secret.symmetricKey.secretKey | string |
`"symmetric.pem"` | Key name inside the secret for the symmetric key |
| authentication.tokenService | object | `{"type":"default"}` | The type of
token service to use. Two built-in types are supported: default and test; test
is not recommended for production. |
| autoscaling.enabled | bool | `false` | Specifies whether automatic
horizontal scaling should be enabled. Do not enable this when using in-memory
version store type. |
| autoscaling.maxReplicas | int | `3` | The maximum number of replicas to
maintain. |
