This is an automated email from the ASF dual-hosted git repository.
adutra 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 1438ae0d52 Helm chart: use real URLs in values.yaml instead of Hugo
templates (#3879)
1438ae0d52 is described below
commit 1438ae0d52ba1f3846ac997f897b51bb34b62748
Author: Alexandre Dutra <[email protected]>
AuthorDate: Wed Feb 25 18:54:32 2026 +0100
Helm chart: use real URLs in values.yaml instead of Hugo templates (#3879)
Using Hugo templates in values.yaml is not very user-friendly, since users
reading that file cannot guess what the URL is.
Instead, this PR proposes to use regular URLs. In the `main` branch, they
point to the `https://polaris.apache.org/in-dev/unreleased/` root. When doing a
release, the URLs are changed to `https://polaris.apache.org/releases/x.y.z`.
---
.../release-2-update-release-candidate.yml | 4 +++-
helm/polaris/values.schema.json | 26 +++++++++++-----------
helm/polaris/values.yaml | 26 +++++++++++-----------
releasey/libs/_constants.sh | 2 ++
releasey/libs/_version.sh | 2 ++
.../release-guides/manual-release-guide.md | 9 +++++++-
.../in-dev/unreleased/helm-chart/reference.md | 26 +++++++++++-----------
7 files changed, 54 insertions(+), 41 deletions(-)
diff --git a/.github/workflows/release-2-update-release-candidate.yml
b/.github/workflows/release-2-update-release-candidate.yml
index 446412a65b..a07d742782 100644
--- a/.github/workflows/release-2-update-release-candidate.yml
+++ b/.github/workflows/release-2-update-release-candidate.yml
@@ -173,11 +173,13 @@ jobs:
source "${LIBS_DIR}/_constants.sh"
source "${LIBS_DIR}/_exec.sh"
- # Commit version files and changelog
+ # Commit version files, changelog, and Helm chart updates
exec_process git add \
"$VERSION_FILE" \
"$HELM_CHART_YAML_FILE" \
"$HELM_README_FILE" \
+ "$HELM_VALUES_FILE" \
+ "$HELM_VALUES_SCHEMA_FILE" \
"$CHANGELOG_FILE"
exec_process git commit -m "[chore] Bump version to
${version_without_rc}"
diff --git a/helm/polaris/values.schema.json b/helm/polaris/values.schema.json
index aafcacd418..9dd138e9f0 100644
--- a/helm/polaris/values.schema.json
+++ b/helm/polaris/values.schema.json
@@ -3,7 +3,7 @@
"type": "object",
"properties": {
"advancedConfig": {
- "description": "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). Refer to Polaris [Configuration reference]({{% ref
\"../configuration\" %}}) for a complete list of Polaris configuration
properties, and to the [Quarkus Configuratio [...]
+ "description": "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). Refer to Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference)
for a complete list of Polaris configur [...]
"type": "object"
},
"affinity": {
@@ -106,7 +106,7 @@
"type": "object",
"properties": {
"enabled": {
- "description": "Specifies whether automatic horizontal
scaling should be enabled. Do not enable this when using in-memory version
store type. See [Scaling]({{% ref \"production/#scaling\" %}}) for production
recommendations.",
+ "description": "Specifies whether automatic horizontal
scaling should be enabled. Do not enable this when using in-memory version
store type. See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations.",
"type": "boolean"
},
"maxReplicas": {
@@ -323,7 +323,7 @@
}
},
"features": {
- "description": "Features to enable or disable globally. If a
feature is not present in the map, the default built-in value is used. Refer to
Polaris [Configuration reference]({{% ref \"../configuration\" %}}) for a
complete list of available features.",
+ "description": "Features to enable or disable globally. If a
feature is not present in the map, the default built-in value is used. Refer to
Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference)
for a complete list of available features.",
"type": "object",
"properties": {
"realmOverrides": {
@@ -363,7 +363,7 @@
"type": "string"
},
"enabled": {
- "description": "Specifies whether a Gateway should be
created. See [Networking]({{% ref \"networking\" %}}) for more information.",
+ "description": "Specifies whether a Gateway should be
created. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.",
"type": "boolean"
},
"listeners": {
@@ -415,7 +415,7 @@
}
},
"enabled": {
- "description": "Specifies whether an HTTPRoute should be
created. See [Networking]({{% ref \"networking\" %}}) for more information.",
+ "description": "Specifies whether an HTTPRoute should be
created. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.",
"type": "boolean"
},
"gatewayName": {
@@ -483,7 +483,7 @@
}
},
"className": {
- "description": "Specifies the ingressClassName; leave
empty if you don't want to customize it. See [Networking]({{% ref
\"networking\" %}}) for more information.",
+ "description": "Specifies the ingressClassName; leave
empty if you don't want to customize it. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.",
"type": "string"
},
"enabled": {
@@ -609,7 +609,7 @@
"type": "boolean"
},
"format": {
- "description": "The log format to use. Ignored if
JSON format is enabled. See [Logging]({{% ref \"../telemetry/#logging\" %}})
for details.",
+ "description": "The log format to use. Ignored if
JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details.",
"type": "string"
},
"json": {
@@ -643,7 +643,7 @@
"type": "string"
},
"format": {
- "description": "The log format to use. Ignored if
JSON format is enabled. See [Logging]({{% ref \"../telemetry/#logging\" %}})
for details.",
+ "description": "The log format to use. Ignored if
JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details.",
"type": "string"
},
"json": {
@@ -845,7 +845,7 @@
"type": "object",
"properties": {
"enabled": {
- "description": "Specifies whether metrics for the polaris
server should be enabled. See [Metrics]({{% ref \"../telemetry/#metrics\" %}})
for details.",
+ "description": "Specifies whether metrics for the polaris
server should be enabled. See
[Metrics](https://polaris.apache.org/in-dev/unreleased/telemetry/#metrics) for
details.",
"type": "boolean"
},
"tags": {
@@ -1119,12 +1119,12 @@
}
},
"replicaCount": {
- "description": "The number of replicas to deploy (horizontal
scaling). Beware that replicas are stateless; don't set this number \u003e 1
when using in-memory meta store manager. See [Scaling]({{% ref
\"production/#scaling\" %}}) for production recommendations.",
+ "description": "The number of replicas to deploy (horizontal
scaling). Beware that replicas are stateless; don't set this number \u003e 1
when using in-memory meta store manager. See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations.",
"type": "integer",
"minimum": 1
},
"resources": {
- "description": "Configures the resources requests and limits for
polaris pods. This chart does not specify default resources and leaves this as
a conscious choice for the user. This also increases chances charts run on
environments with little resources, such as Minikube. See [Resource
Management]({{% ref \"production/#resource-management\" %}}) for production
recommendations.",
+ "description": "Configures the resources requests and limits for
polaris pods. This chart does not specify default resources and leaves this as
a conscious choice for the user. This also increases chances charts run on
environments with little resources, such as Minikube. See [Resource
Management](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#resource-management)
for production recommendations.",
"type": "object"
},
"revisionHistoryLimit": {
@@ -1225,7 +1225,7 @@
]
},
"type": {
- "description": "The type of service to create. Valid
values are: ExternalName, ClusterIP, NodePort, and LoadBalancer. The default
value is ClusterIP. See [Networking]({{% ref \"networking\" %}}) for more
information.",
+ "description": "The type of service to create. Valid
values are: ExternalName, ClusterIP, NodePort, and LoadBalancer. The default
value is ClusterIP. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.",
"type": "string",
"enum": [
"ExternalName",
@@ -1351,7 +1351,7 @@
}
},
"enabled": {
- "description": "Specifies whether tracing for the polaris
server should be enabled. See [Traces]({{% ref \"../telemetry/#traces\" %}})
for details.",
+ "description": "Specifies whether tracing for the polaris
server should be enabled. See
[Traces](https://polaris.apache.org/in-dev/unreleased/telemetry/#traces) for
details.",
"type": "boolean"
},
"endpoint": {
diff --git a/helm/polaris/values.yaml b/helm/polaris/values.yaml
index a99782e701..2bce3c2b48 100644
--- a/helm/polaris/values.yaml
+++ b/helm/polaris/values.yaml
@@ -20,7 +20,7 @@
# @schema minimum: 1
# -- The number of replicas to deploy (horizontal scaling).
# Beware that replicas are stateless; don't set this number > 1 when using
in-memory meta store manager.
-# See [Scaling]({{% ref "production/#scaling" %}}) for production
recommendations.
+# See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations.
# @section -- Deployment
replicaCount: 1
@@ -141,7 +141,7 @@ service:
# @schema enum: [ExternalName, ClusterIP, NodePort, LoadBalancer]
# -- The type of service to create. Valid values are: ExternalName,
ClusterIP, NodePort, and LoadBalancer.
# The default value is ClusterIP.
- # See [Networking]({{% ref "networking" %}}) for more information.
+ # See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.
# @section -- Service
type: ClusterIP
# @schema minItems: 1
@@ -353,7 +353,7 @@ extraServices:
# Check your ingress controller's documentation.
ingress:
# -- Specifies the ingressClassName; leave empty if you don't want to
customize it.
- # See [Networking]({{% ref "networking" %}}) for more information.
+ # See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.
# @section -- Ingress
className: ""
# -- Specifies whether an ingress should be created.
@@ -399,7 +399,7 @@ ingress:
# A Gateway can be shared across multiple HTTPRoutes.
gateway:
# -- Specifies whether a Gateway should be created.
- # See [Networking]({{% ref "networking" %}}) for more information.
+ # See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.
# @section -- Gateway
enabled: false
# @schema additionalProperties: {type: string}
@@ -445,7 +445,7 @@ gateway:
# HTTPRoute and Ingress are mutually exclusive; only one can be enabled at a
time.
httproute:
# -- Specifies whether an HTTPRoute should be created.
- # See [Networking]({{% ref "networking" %}}) for more information.
+ # See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information.
# @section -- HTTPRoute
enabled: false
# @schema additionalProperties: {type: string}
@@ -472,7 +472,7 @@ httproute:
# -- Configures the resources requests and limits for polaris pods.
# This chart does not specify default resources and leaves this as a conscious
# choice for the user. This also increases chances charts run on environments
with little
-# resources, such as Minikube. See [Resource Management]({{% ref
"production/#resource-management" %}}) for production recommendations.
+# resources, such as Minikube. See [Resource
Management](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#resource-management)
for production recommendations.
# @section -- Resources and Autoscaling
resources:
{}
@@ -486,7 +486,7 @@ resources:
autoscaling:
# -- Specifies whether automatic horizontal scaling should be enabled.
# Do not enable this when using in-memory version store type.
- # See [Scaling]({{% ref "production/#scaling" %}}) for production
recommendations.
+ # See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations.
# @section -- Resources and Autoscaling
enabled: false
# -- The minimum number of replicas to maintain.
@@ -599,7 +599,7 @@ readinessProbe:
# 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).
-# Refer to Polaris [Configuration reference]({{% ref "../configuration" %}})
for a complete list of
+# Refer to Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference)
for a complete list of
# Polaris configuration properties, and to the [Quarkus Configuration
Reference](https://quarkus.io/guides/all-config)
# for a complete list of Quarkus configuration properties.
# @section -- Advanced Configuration
@@ -674,7 +674,7 @@ extraInitContainers: []
# command: ['sh', '-c', 'echo "hello world"']
tracing:
- # -- Specifies whether tracing for the polaris server should be enabled. See
[Traces]({{% ref "../telemetry/#traces" %}}) for details.
+ # -- Specifies whether tracing for the polaris server should be enabled. See
[Traces](https://polaris.apache.org/in-dev/unreleased/telemetry/#traces) for
details.
# @section -- Observability
enabled: false
# -- The collector endpoint URL to connect to (required).
@@ -699,7 +699,7 @@ tracing:
{}
metrics:
- # -- Specifies whether metrics for the polaris server should be enabled. See
[Metrics]({{% ref "../telemetry/#metrics" %}}) for details.
+ # -- Specifies whether metrics for the polaris server should be enabled. See
[Metrics](https://polaris.apache.org/in-dev/unreleased/telemetry/#metrics) for
details.
# @section -- Observability
enabled: true
# @schema additionalProperties: {type: string}
@@ -756,7 +756,7 @@ logging:
# -- Whether to log in JSON format.
# @section -- Logging
json: false
- # -- The log format to use. Ignored if JSON format is enabled. See
[Logging]({{% ref "../telemetry/#logging" %}}) for details.
+ # -- The log format to use. Ignored if JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details.
# @section -- Logging
format: "%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}]
[%X{requestId},%X{realmId}] [%X{traceId},%X{parentId},%X{spanId},%X{sampled}]
(%t) %s%e%n"
# Configuration for the file appender.
@@ -771,7 +771,7 @@ logging:
# -- Whether to log in JSON format.
# @section -- Logging
json: false
- # -- The log format to use. Ignored if JSON format is enabled. See
[Logging]({{% ref "../telemetry/#logging" %}}) for details.
+ # -- The log format to use. Ignored if JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details.
# @section -- Logging
format: "%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}]
[%X{requestId},%X{realmId}] [%X{traceId},%X{parentId},%X{spanId},%X{sampled}]
(%t) %s%e%n"
# -- The local directory where log files are stored. The persistent volume
claim will be mounted
@@ -849,7 +849,7 @@ realmContext:
- POLARIS
# -- Features to enable or disable globally. If a feature is not present in
the map, the default
-# built-in value is used. Refer to Polaris [Configuration reference]({{% ref
"../configuration" %}})
+# built-in value is used. Refer to Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference)
# for a complete list of available features.
# @section -- Features
features:
diff --git a/releasey/libs/_constants.sh b/releasey/libs/_constants.sh
index 03ec4c6ba1..d6fa9f3026 100644
--- a/releasey/libs/_constants.sh
+++ b/releasey/libs/_constants.sh
@@ -38,3 +38,5 @@ VERSION_FILE="$LIBS_DIR/../../version.txt"
CHANGELOG_FILE="$LIBS_DIR/../../CHANGELOG.md"
HELM_CHART_YAML_FILE="$LIBS_DIR/../../helm/polaris/Chart.yaml"
HELM_README_FILE="$LIBS_DIR/../../helm/polaris/README.md"
+HELM_VALUES_FILE="$LIBS_DIR/../../helm/polaris/values.yaml"
+HELM_VALUES_SCHEMA_FILE="$LIBS_DIR/../../helm/polaris/values.schema.json"
diff --git a/releasey/libs/_version.sh b/releasey/libs/_version.sh
index d7eae189d8..b5724f0b94 100644
--- a/releasey/libs/_version.sh
+++ b/releasey/libs/_version.sh
@@ -116,6 +116,8 @@ function update_helm_version {
current_version_with_dash="${old_version//-/--}"
version_with_dash="${version//-/--}"
exec_process sed -E -i~
"s/[0-9]+[.][0-9]+([.][0-9]+)?(--incubating)?--SNAPSHOT/${version_with_dash}/g"
"$HELM_README_FILE"
+ exec_process sed -E -i~ "s|/in-dev/unreleased/|/releases/${new_version}/|g"
"$HELM_VALUES_FILE"
+ exec_process sed -E -i~ "s|/in-dev/unreleased/|/releases/${new_version}/|g"
"$HELM_VALUES_SCHEMA_FILE"
}
function find_next_rc_number {
diff --git a/site/content/community/release-guides/manual-release-guide.md
b/site/content/community/release-guides/manual-release-guide.md
index 524bcb8382..139bf8bc34 100644
--- a/site/content/community/release-guides/manual-release-guide.md
+++ b/site/content/community/release-guides/manual-release-guide.md
@@ -142,10 +142,17 @@ and update the version in the Helm Chart in:
* `helm/polaris/Chart.yaml`
* `helm/polaris/README.md`
+and update the documentation URLs in `helm/polaris/values.yaml` and
`helm/polaris/values.schema.json` to point to the released documentation.
+Replace `/in-dev/unreleased/` with `/releases/x.y.z/` in all documentation
URLs, for example:
+
+```bash
+sed -i~ 's|/in-dev/unreleased/|/releases/x.y.z/|g' helm/polaris/values.yaml
helm/polaris/values.schema.json
+```
+
and commit/push the version bump:
```
-git commit -m "Bump version to x.y.z" version.txt helm/polaris/Chart.yaml
helm/polaris/README.md helm/polaris/values.yaml
+git commit -m "Bump version to x.y.z" version.txt helm/polaris/Chart.yaml
helm/polaris/README.md helm/polaris/values.yaml helm/polaris/values.schema.json
```
Update `CHANGELOG.md`:
diff --git a/site/content/in-dev/unreleased/helm-chart/reference.md
b/site/content/in-dev/unreleased/helm-chart/reference.md
index 88e9dbfd38..12df2775eb 100644
--- a/site/content/in-dev/unreleased/helm-chart/reference.md
+++ b/site/content/in-dev/unreleased/helm-chart/reference.md
@@ -27,7 +27,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| replicaCount | int | `1` | The number of replicas to deploy (horizontal
scaling). Beware that replicas are stateless; don't set this number > 1 when
using in-memory meta store manager. See [Scaling]({{% ref "production/#scaling"
%}}) for production recommendations. |
+| replicaCount | int | `1` | The number of replicas to deploy (horizontal
scaling). Beware that replicas are stateless; don't set this number > 1 when
using in-memory meta store manager. See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations. |
| revisionHistoryLimit | int | `nil` | The number of old ReplicaSets to retain
to allow rollback (if not set, the default Kubernetes value is set to 10). |
### Image
@@ -66,7 +66,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| service.type | string | `"ClusterIP"` | The type of service to create. Valid
values are: ExternalName, ClusterIP, NodePort, and LoadBalancer. The default
value is ClusterIP. See [Networking]({{% ref "networking" %}}) for more
information. |
+| service.type | string | `"ClusterIP"` | The type of service to create. Valid
values are: ExternalName, ClusterIP, NodePort, and LoadBalancer. The default
value is ClusterIP. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information. |
| service.ports[0].name | string | `"polaris-http"` | The name of the port.
Required. |
| service.ports[0].port | int | `8181` | The port the service listens on. By
default, the HTTP port is 8181. |
| service.ports[0].targetPort | int | `0` | Number of the port to access on
the pods targeted by the service. If this is not specified or zero, the value
of the 'port' field is used. |
@@ -118,7 +118,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| ingress.className | string | `""` | Specifies the ingressClassName; leave
empty if you don't want to customize it. See [Networking]({{% ref "networking"
%}}) for more information. |
+| ingress.className | string | `""` | Specifies the ingressClassName; leave
empty if you don't want to customize it. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information. |
| ingress.enabled | bool | `false` | Specifies whether an ingress should be
created. |
| ingress.annotations | object | `{}` | Annotations to add to the ingress. |
| ingress.hosts[0].host | string | `"chart-example.local"` | The host name.
Required. |
@@ -131,7 +131,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| gateway.enabled | bool | `false` | Specifies whether a Gateway should be
created. See [Networking]({{% ref "networking" %}}) for more information. |
+| gateway.enabled | bool | `false` | Specifies whether a Gateway should be
created. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information. |
| gateway.annotations | object | `{}` | Annotations to add to the Gateway. |
| gateway.className | string | `""` | The name of the GatewayClass to use. |
| gateway.listeners[0].name | string | `"http"` | The name of the listener.
Required. |
@@ -145,7 +145,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| httproute.enabled | bool | `false` | Specifies whether an HTTPRoute should
be created. See [Networking]({{% ref "networking" %}}) for more information. |
+| httproute.enabled | bool | `false` | Specifies whether an HTTPRoute should
be created. See
[Networking](https://polaris.apache.org/in-dev/unreleased/helm-chart/networking/)
for more information. |
| httproute.annotations | object | `{}` | Annotations to add to the HTTPRoute.
|
| httproute.gatewayName | string | `""` | Name of the Gateway resource to
attach to. Required. |
| httproute.gatewayNamespace | string | `"default"` | Namespace where the
Gateway is deployed. Required. |
@@ -156,8 +156,8 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| resources | object | `{}` | Configures the resources requests and limits for
polaris pods. This chart does not specify default resources and leaves this as
a conscious choice for the user. This also increases chances charts run on
environments with little resources, such as Minikube. See [Resource
Management]({{% ref "production/#resource-management" %}}) for production
recommendations. |
-| autoscaling.enabled | bool | `false` | Specifies whether automatic
horizontal scaling should be enabled. Do not enable this when using in-memory
version store type. See [Scaling]({{% ref "production/#scaling" %}}) for
production recommendations. |
+| resources | object | `{}` | Configures the resources requests and limits for
polaris pods. This chart does not specify default resources and leaves this as
a conscious choice for the user. This also increases chances charts run on
environments with little resources, such as Minikube. See [Resource
Management](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#resource-management)
for production recommendations. |
+| autoscaling.enabled | bool | `false` | Specifies whether automatic
horizontal scaling should be enabled. Do not enable this when using in-memory
version store type. See
[Scaling](https://polaris.apache.org/in-dev/unreleased/helm-chart/production/#scaling)
for production recommendations. |
| autoscaling.minReplicas | int | `1` | The minimum number of replicas to
maintain. |
| autoscaling.maxReplicas | int | `3` | The maximum number of replicas to
maintain. |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | Optional; set to
zero or empty to disable. |
@@ -193,7 +193,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| advancedConfig | object | `{"quarkus.http.access-log.enabled":true}` |
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). Refer to
Polaris [Configuration reference]({{% ref "../configuration" %}}) for a
complete list of Polaris configuration pro [...]
+| advancedConfig | object | `{"quarkus.http.access-log.enabled":true}` |
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). Refer to
Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-referen
[...]
| extraEnv | list | `[]` | Advanced configuration via Environment Variables.
Extra environment variables to add to the Polaris server container. You can
pass here any valid EnvVar object: [EnvVar
API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#envvar-v1-core)
This can be useful to get configuration values from Kubernetes secrets or
config maps. |
| extraVolumes | list | `[]` | Extra volumes to add to the polaris pod. See
[Volumes](https://kubernetes.io/docs/concepts/storage/volumes/). |
| extraVolumeMounts | list | `[]` | Extra volume mounts to add to the polaris
container. See [Volumes](https://kubernetes.io/docs/concepts/storage/volumes/).
|
@@ -203,11 +203,11 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| tracing.enabled | bool | `false` | Specifies whether tracing for the polaris
server should be enabled. See [Traces]({{% ref "../telemetry/#traces" %}}) for
details. |
+| tracing.enabled | bool | `false` | Specifies whether tracing for the polaris
server should be enabled. See
[Traces](https://polaris.apache.org/in-dev/unreleased/telemetry/#traces) for
details. |
| tracing.endpoint | string | `"http://otlp-collector:4317"` | The collector
endpoint URL to connect to (required). The endpoint URL must have either the
http:// or the https:// scheme. The collector must talk the OpenTelemetry
protocol (OTLP) and the port must be its gRPC port (by default 4317). See
[Quarkus OpenTelemetry](https://quarkus.io/guides/opentelemetry) for more
information. |
| tracing.sample | string | `"1.0d"` | Which requests should be sampled. Valid
values are: "all", "none", or a ratio between 0.0 and "1.0d" (inclusive). E.g.
"0.5d" means that 50% of the requests will be sampled. Note: avoid entering
numbers here, always prefer a string representation of the ratio. |
| tracing.attributes | object | `{}` | Resource attributes to identify the
polaris service among other tracing sources. See [OpenTelemetry Semantic
Conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/#service).
If left empty, traces will be attached to a service named "Apache Polaris"; to
change this, provide a service.name attribute here. |
-| metrics.enabled | bool | `true` | Specifies whether metrics for the polaris
server should be enabled. See [Metrics]({{% ref "../telemetry/#metrics" %}})
for details. |
+| metrics.enabled | bool | `true` | Specifies whether metrics for the polaris
server should be enabled. See
[Metrics](https://polaris.apache.org/in-dev/unreleased/telemetry/#metrics) for
details. |
| metrics.tags | object | `{}` | Additional tags (dimensional labels) to add
to the metrics. |
| serviceMonitor.enabled | bool | `true` | Specifies whether a ServiceMonitor
for Prometheus operator should be created. |
| serviceMonitor.interval | string | `""` | The scrape interval; leave empty
to let Prometheus decide. Must be a valid duration, e.g. 1d, 1h30m, 5m, 10s. |
@@ -223,11 +223,11 @@ weight: 900
| logging.console.enabled | bool | `true` | Whether to enable the console
appender. |
| logging.console.threshold | string | `"ALL"` | The log level of the console
appender. |
| logging.console.json | bool | `false` | Whether to log in JSON format. |
-| logging.console.format | string | `"%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p
[%c{3.}] [%X{requestId},%X{realmId}]
[%X{traceId},%X{parentId},%X{spanId},%X{sampled}] (%t) %s%e%n"` | The log
format to use. Ignored if JSON format is enabled. See [Logging]({{% ref
"../telemetry/#logging" %}}) for details. |
+| logging.console.format | string | `"%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p
[%c{3.}] [%X{requestId},%X{realmId}]
[%X{traceId},%X{parentId},%X{spanId},%X{sampled}] (%t) %s%e%n"` | The log
format to use. Ignored if JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details. |
| logging.file.enabled | bool | `false` | Whether to enable the file appender.
|
| logging.file.threshold | string | `"ALL"` | The log level of the file
appender. |
| logging.file.json | bool | `false` | Whether to log in JSON format. |
-| logging.file.format | string | `"%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}]
[%X{requestId},%X{realmId}] [%X{traceId},%X{parentId},%X{spanId},%X{sampled}]
(%t) %s%e%n"` | The log format to use. Ignored if JSON format is enabled. See
[Logging]({{% ref "../telemetry/#logging" %}}) for details. |
+| logging.file.format | string | `"%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}]
[%X{requestId},%X{realmId}] [%X{traceId},%X{parentId},%X{spanId},%X{sampled}]
(%t) %s%e%n"` | The log format to use. Ignored if JSON format is enabled. See
[Logging](https://polaris.apache.org/in-dev/unreleased/telemetry/#logging) for
details. |
| logging.file.logsDir | string | `"/deployments/logs"` | The local directory
where log files are stored. The persistent volume claim will be mounted here. |
| logging.file.fileName | string | `"polaris.log"` | The log file name. |
| logging.file.rotation.maxFileSize | string | `"100Mi"` | The maximum size of
the log file before it is rotated. Should be expressed as a Kubernetes
quantity. |
@@ -250,7 +250,7 @@ weight: 900
| Key | Type | Default | Description |
|-----|------|---------|-------------|
-| features | object |
`{"SUPPORTED_CATALOG_STORAGE_TYPES":["S3","GCS","AZURE"],"realmOverrides":{}}`
| Features to enable or disable globally. If a feature is not present in the
map, the default built-in value is used. Refer to Polaris [Configuration
reference]({{% ref "../configuration" %}}) for a complete list of available
features. |
+| features | object |
`{"SUPPORTED_CATALOG_STORAGE_TYPES":["S3","GCS","AZURE"],"realmOverrides":{}}`
| Features to enable or disable globally. If a feature is not present in the
map, the default built-in value is used. Refer to Polaris [Configuration
reference](https://polaris.apache.org/in-dev/unreleased/configuration/configuration-reference)
for a complete list of available features. |
| features.realmOverrides | object | `{}` | Features to enable or disable per
realm. This field is a map of maps. The realm name is the key, and the value is
a map of feature names to values. If a feature is not present in the map, the
global value is used. |
### Persistence
