Skip to content

docs: document datastore addon validation in porter apply #332

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document datastore addon validation in porter apply #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions applications/configuration-as-code/addons-porter-yaml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,43 @@ addons:
ramMegabytes: 110
```

## Validating datastore addons

When your `porter.yaml` defines one or more `addons`, the CLI validates each in-cluster datastore addon (Postgres and Redis) before applying it. This surfaces common configuration mistakes locally as clear errors instead of opaque backend failures.

Validation runs automatically as part of:

- `porter apply -f porter.yaml` — before any addon is applied
- `porter apply validate` and `porter apply -f porter.yaml --validate` — without applying

### What is validated

For every datastore addon block, the CLI checks that:

| Field | Requirement |
|---|---|
| `name` | Must be set |
| `type` | Must be `POSTGRES` or `REDIS` |
| `kind` | Must be `IN_CLUSTER` (the only kind currently validated by the CLI) |
| `config.storageGigabytes` | Must be greater than `0` |
| `config.cpuCores` | Must be greater than `0` |
| `config.ramMegabytes` | Must be greater than `0` |

If any check fails, `porter apply` exits with a non-zero status and prints the failing field. No apps or addons are applied until the errors are fixed.

### Example

```bash
PORTER_ADDON_YAML=true porter apply -f porter.yaml --validate
```

A missing or zero field produces output similar to:

```
✗ porter.yaml validation failed
addon 'config.storageGigabytes' must be greater than 0
```

<Info>
Only in-cluster Postgres and Redis datastores are validated by the CLI today. Managed datastores and custom Helm chart addons skip CLI validation and are validated server-side at apply time.
</Info>
8 changes: 6 additions & 2 deletions standard/cli/command-reference/porter-apply.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,13 @@ You can pass environment variables and secrets directly via command-line flags w

| Flag | Description |
|------|-------------|
| `--validate` | Check that the `porter.yaml` file is valid YAML syntax |
| `--validate` | Validate the `porter.yaml` file locally without applying. Checks YAML syntax and, when `addons` are present, validates each in-cluster datastore addon (Postgres and Redis) — see [Validating datastore addons](/applications/configuration-as-code/addons-porter-yaml#validating-datastore-addons) |
| `--dry-run` | Perform server-side validation to confirm the configuration is valid without applying changes |

<Info>
You can also run `porter apply validate` (no flag) as a standalone subcommand to validate `porter.yaml` in the current directory.
</Info>

### Advanced Options

| Flag | Short | Description |
Expand Down Expand Up @@ -118,7 +122,7 @@ porter apply -f porter.yaml --preview
```

```bash Validate YAML Syntax
# Check that porter.yaml is valid YAML
# Check that porter.yaml is valid YAML and that any datastore addons are well-formed
porter apply -f porter.yaml --validate
```

Expand Down