The deck gateway validate command reads one or more declarative state files and ensures validity. It reports YAML/JSON parsing issues, checks for foreign relationships, and alerts if there are broken relationships or missing links present.
This command also validates against the Admin API via communication with Kong Gateway. This increases the time for validation but catches significant errors. No resource is created in Kong Gateway.
For offline validation, see deck file validate.
The deck gateway validate command may take a long time to check all entities if you have a large state file.
To reduce this time, you can provide the --online-entities-list flag and specify specific entities to validate.
For example:
deck gateway validate --online-entities-list Plugins kong.yaml
Usage:
deck gateway validate [flags] [kong-state-files...]
Flags:
-h, --help help for validate
--konnect-compatibility validate that the state file(s) are ready to be deployed to Konnect
--online-entities-list strings indicate the list of entities that should be validated online validation.
--parallelism int Maximum number of concurrent requests to Kong. (default 10)
--rbac-resources-only indicate that the state file(s) contains RBAC resources only (Kong Enterprise only).
-w, --workspace string validate configuration of a specific workspace (Kong Enterprise only).
This takes precedence over _workspace fields in state files.