Documentation for version v1.12.0 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
The Envoy process, the data path component of Contour, at times needs to be re-deployed. This could be due to an upgrade, a change in configuration, or a node-failure forcing a redeployment.
When implementing this roll out, the following steps should be taken:
Contour implements a new
envoy sub-command which has a
shutdown-manager whose job is to manage a single Envoy instances lifecycle for Kubernetes.
shutdown-manager runs as a new container alongside the Envoy container in the same pod.
It exposes two HTTP endpoints which are used for
livenessProbe as well as to handle the Kubernetes
preStop event hook.
/healthzfail, the container will be restarted.
/shutdownendpoint blocks until the connections are drained.
- name: shutdown-manager command: - /bin/contour args: - envoy - shutdown-manager image: docker.io/projectcontour/contour:main imagePullPolicy: Always lifecycle: preStop: exec: command: - /bin/contour - envoy - shutdown livenessProbe: httpGet: path: /healthz port: 8090 initialDelaySeconds: 3 periodSeconds: 10
The Envoy container also has some configuration to implement the shutdown manager.
preStop hook is configured to use the
/shutdown endpoint which blocks the Envoy container from exiting.
Finally, the pod’s
terminationGracePeriodSeconds is customized to extend the time in which Kubernetes will allow the pod to be in the
The termination grace period defines an upper bound for long-lived sessions.
If during shutdown, the connections aren’t drained to the configured amount, the
terminationGracePeriodSeconds will send a
SIGTERM to the pod killing it.
The shutdown manager has a set of arguments that can be passed to change how it behaves: