Improve the Helm documentation with new stateful configuration #892
+126
−8
Conversation
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
phillipleblanc
added
the
documentation
sgrebnov
approved these changes
Mar 11, 2025
There was a problem hiding this comment.
PR Overview
This PR updates the Helm documentation to include a new stateful configuration for deploying Spice.ai as a StatefulSet with persistent storage. Key changes include:
- Adding an informational block that explains the default stateless deployment and introduces stateful configuration.
- Updating and expanding the configuration tables and YAML examples to support new parameters such as stateful options, service configuration, and acceleration engine.
- Correcting typos and ensuring consistency in parameter names such as replacing "podMonitoring" with "podMonitor".
Reviewed Changes
| File | Description |
|---|---|
| website/docs/deployment/kubernetes/index.md | Added a documentation block on deployment architectures and expanded configuration examples for stateful deployments and other service settings. |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
website/docs/deployment/kubernetes/index.md:298
- [nitpick] Consider adding a comment or documentation reference to clarify the acceptable values and purpose of the 'engine' parameter in the acceleration configuration.
engine: duckdb
website/docs/deployment/kubernetes/index.md:127
- [nitpick] Ensure that 'monitoring.podMonitor.enabled' is used consistently throughout the documentation, replacing any lingering references to the old 'podMonitoring.enabled' key.
helm upgrade --install spiceai spiceai/spiceai --set monitoring.podMonitor.enabled=true
website/docs/deployment/kubernetes/index.md:179
- [nitpick] The example selector key 'custom-selector' is generic; consider using a more descriptive example or adding a comment to clarify its purpose.
custom-selector: value
|
🚀 deployed to https://a08576e7.spiceai-org-website.pages.dev |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improves the Helm documentation to have the new stateful configuration that deploys Spice as a StatefulSet.