kubectl convoy

The kubectl plugin for the Release subresources.

kubectl-convoy is a kubectl plugin. Put the binary on your PATH and run it as kubectl convoy. To build it from source:

go install github.com/kumodo-io/convoy/cmd/[email protected]

Global flags#

Flag	Meaning
`--kubeconfig`	The kubeconfig file. The default is the standard kubeconfig discovery.
`--context`	The kubeconfig context.
`-n`, `--namespace`	The namespace of the Release. The default is the namespace of the context.

All commands are under kubectl convoy release.

Command	What it does	Flags
`sync <name>`	Requests a reconcile. In manual sync mode, also requests the apply.	`--force`: skip the pre-apply dry run, and start a new rollout when the rollout is `Failed` or `RolledBack`.
`pin <name>`	Pins the Release to a render.	`--render-ref`: the render to pin. The default is the last applied render.
`unpin <name>`	Clears the pin.
`preview <name>`	Prints the desired render as YAML.
`diff <name>`	Shows how the live objects differ from the desired render.	`--render <ref>`: compare a stored render instead. `-o json`: print the raw result.
`history <name>`	Shows the applied renders. Needs a render store.	`-o json`
`health <name>`	Shows the health state of each resource.	`-o json`
`mutations get <name>`	Prints the mutation list as YAML.
`mutations set <name>`	Replaces the mutation list.	`-f <file>` (`-f -` reads stdin), or `--from-string <yaml>`
`mutations add <name>`	Adds mutations to the end of the list.	`-f`, `--from-string`
`lifecycle get <name>`	Prints the lifecycle hooks as YAML.
`lifecycle set <name>`	Replaces the lifecycle hooks.	`-f`, `--from-string`

Each command calls a Release subresource. Kubernetes RBAC on that subresource applies.