docs: document datastore addon validation in porter apply#332
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: document datastore addon validation in porter apply#332mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Documents the new local validation that the Porter CLI runs against in-cluster datastore addons when applying a multi-app/addons
porter.yaml.Feature recap
The latest CLI release adds a validation step to
porter apply(andporter apply validate/--validate) that checks every in-cluster Postgres or Redis addon block for required fields (name,type,kind,config.storageGigabytes,config.cpuCores,config.ramMegabytes) before any addon is applied. Misconfigured addons now fail fast with a clear, field-level error instead of an opaque backend failure.Changes
applications/configuration-as-code/addons-porter-yaml.mdx— new "Validating datastore addons" section covering when validation runs, the field-level checks, and an example error.standard/cli/command-reference/porter-apply.mdx— updated the--validateflag description to mention datastore addon validation, linked to the new section, and noted theporter apply validatesubcommand.cc @GKestenberg for review.