convoy docs
Search

Reference

The convoy API groups, their kinds and fields, and the kubectl convoy plugin.

The API kinds are in three API groups. The kubectl convoy plugin and the credential types of all kinds have their own pages.

The field tables on these pages come from the OpenAPI schema of convoy. The descriptions come from the Go doc comments in the convoy API types.

“Required” means that the schema marks the field as required. The apiserver validation can be stricter. The page of each kind describes the validation rules.