convoy docs
Search

Release subresources

The verbs, served components and RBAC of the Release subresources.

All paths are under /apis/core.convoy.kumodo.io/v1alpha1/namespaces/<namespace>/releases/<name>/. Kubernetes RBAC controls each subresource separately, for example releases/pin or releases/mutations.

SubresourceVerbsServed byPurpose
statusGET, PUT, PATCHapiserverThe status of the Release. Only convoy components write it.
syncPOSTapiserverRequests a reconcile now. In manual sync mode, also requests the apply.
pinGET, PUT, PATCHapiserverReads, sets or clears the pin.
mutationsGET, PUT, PATCHapiserverReads or replaces the mutations list.
lifecycleGET, PUT, PATCHapiserverReads or replaces the lifecycle hooks.
previewGETobserverThe desired render as a YAML stream.
diffGETobserverThe difference between the desired render and the live objects.
healthGETobserverThe health state of each resource.
historyGETobserverThe applied renders in the render store.

The apiserver sends preview, diff, health and history to the observer at --observer-url. Without --observer-url, these subresources return 503 Service Unavailable.

  • Sync

    The POST request that starts a reconcile, and its force parameter.

  • Pin

    The request that sets or clears the pin of a Release.

  • Mutations

    The fields, types, admission rules and subresource of the Release mutation pipeline.

  • Lifecycle hooks

    The fields, admission rules, status and subresource of Release lifecycle hooks.

  • Preview

    The desired render of a Release as a YAML stream.

  • Diff

    The difference between the desired render and the live objects.

  • Health

    The last health assessment of each resource of a Release.

  • History

    The applied renders of a Release in the render store.

In the code

convoy v0.9.0