-
Notifications
You must be signed in to change notification settings - Fork 383
[doc]: Add doc for helm prod deployment #3265
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
132 changes: 132 additions & 0 deletions
132
...ontent/in-dev/unreleased/configuring-polaris-for-production/configuring-helm.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| --- | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| # | ||
| title: Configuring Helm for Production | ||
| linkTitle: Configuring Helm | ||
| type: docs | ||
| weight: 601 | ||
| --- | ||
|
|
||
| This guide provides instructions for configuring the Polaris Helm chart for a production environment. For full list of chart values, see the [main Helm chart documentation](../../helm/). | ||
|
|
||
| The default Helm chart values are suitable for development and testing, but they are not recommended for production. Following are the key areas to consider for production deployment. | ||
|
|
||
| ## Persistence | ||
|
|
||
| By default, the Polaris Helm chart uses an `in-memory` metastore, which is not suitable for production. A persistent backend must be configured to ensure data is not lost when pods restart. | ||
|
|
||
| To use a persistent backend, `persistence.type` must be set to `relational-jdbc`, and a Kubernetes secret containing the database connection details must be provided. | ||
|
|
||
| ```yaml | ||
| persistence: | ||
| type: relational-jdbc | ||
| relationalJdbc: | ||
| secret: | ||
| name: "polaris-persistence-secret" # A secret containing db credentials | ||
| username: "username" | ||
| password: "password" | ||
| jdbcUrl: "jdbcUrl" | ||
| ``` | ||
|
|
||
| ## Resource Management | ||
|
|
||
| For a production environment, it is crucial to define resource requests and limits for the Polaris pods. Resource requests ensure that pods are allocated enough resources to run, while limits prevent them from consuming too many resources on the node. | ||
|
|
||
| Resource requests and limits can be set in the `values.yaml` file: | ||
|
|
||
| ```yaml | ||
| resources: | ||
| requests: | ||
| memory: "8Gi" | ||
| cpu: "4" | ||
| limits: | ||
| memory: "8Gi" | ||
| cpu: "4" | ||
| ``` | ||
|
|
||
| Adjust these values based on expected workload and available cluster resources. | ||
|
|
||
| ## Authentication | ||
|
|
||
| In a multi-replica production environment, all Polaris pods must share the same token signing keys. The default chart generates random keys for each pod, which will cause token validation failures. | ||
|
|
||
| To use a shared set of keys, a Kubernetes secret to store an RSA key pair or a symmetric key must first be created. | ||
|
|
||
| ### RSA Key Pair | ||
|
|
||
| ```yaml | ||
| authentication: | ||
| tokenBroker: | ||
| type: rsa-key-pair | ||
| secret: | ||
| name: "polaris-rsa-key-pair-secret" # A secret containing the RSA key pair | ||
| rsaKeyPair: | ||
| publicKey: "public.pem" | ||
| privateKey: "private.pem" | ||
| ``` | ||
|
|
||
| ### Symmetric Key | ||
|
|
||
| ```yaml | ||
| authentication: | ||
| tokenBroker: | ||
| type: symmetric-key | ||
| secret: | ||
| name: "polaris-symmetric-key-secret" # A secret containing the symmetric key | ||
| symmetricKey: | ||
| secretKey: "symmetric.key" | ||
| ``` | ||
|
|
||
| ## Scaling | ||
|
|
||
| For high availability, multiple replicas of the Polaris server can be run. This requires a persistent backend to be configured as described above. | ||
|
|
||
| ### Static Replicas | ||
|
|
||
| `replicaCount` must be set to the desired number of pods. | ||
|
|
||
| ```yaml | ||
| replicaCount: 3 | ||
| ``` | ||
|
|
||
| ### Autoscaling | ||
|
|
||
| `autoscaling` can be enabled to define the minimum and maximum number of replicas, and CPU or memory utilization targets. | ||
|
|
||
| ```yaml | ||
| autoscaling: | ||
| enabled: true | ||
| minReplicas: 2 | ||
| maxReplicas: 5 | ||
| targetCPUUtilizationPercentage: 80 | ||
| targetMemoryUtilizationPercentage: 80 | ||
| ``` | ||
|
|
||
| ### Pod Topology Spreading | ||
|
|
||
| For better fault tolerance, `topologySpreadConstraints` can be used to distribute pods across different nodes, racks, or availability zones. This helps prevent a single infrastructure failure from taking down all Polaris replicas. | ||
|
|
||
| Here is an example that spreads pods across different zones and keeps the number of pods in each zone from differing by more than one: | ||
|
|
||
| ```yaml | ||
| topologySpreadConstraints: | ||
| - maxSkew: 1 | ||
| topologyKey: "topology.kubernetes.io/zone" | ||
| whenUnsatisfiable: "DoNotSchedule" | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a warning callout here? Something like:
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So that should be happen automatically (there is also no option for current chart to use a diff persistent metastore). Same as we increase replica counts where by default it depends on the underlying node scaler (e.g. karpenter). Often time, these node scaler will needed additional configuration to enforce the pods spreading. With this addition, we basically tell node scaler don't just schedule them blindly but auto respect the required constraints.