convoy docs
Search

Release pin

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

A PUT or PATCH to releases/<name>/pin sets or clears the pin. The body is a Release with the pin field. The endpoint changes only pin.

  • A renderRef pins the Release to that render. The apiserver sets pinnedAt and pinnedBy.
  • An empty renderRef clears the pin.
  • The apiserver rejects a pin before the Release has a successful render.
  • The apiserver does not check that the render exists. If the render store does not contain it, the controller reports Applied=False with reason Pinned.

status.pin.intent is freeze when the pinned render is the last applied render, and rollback when it is a different render.

sh
kubectl convoy release pin podinfo                     # pin the current render
kubectl convoy release pin podinfo --render-ref sha256:…
kubectl convoy release unpin podinfo

In the code

convoy v0.9.0