Probe Properties

You can configure start-up, readiness, and liveness probes to check the health and status of the CHF application.

Start-up Probe Properties specifies the start-up probe properties, which check whether the CHF application initializes. If you configure the start-up probe, no other probes are run until this probe completes successfully. By default, the start-up probe is not preconfigured for the CHF application.

Table 1. Start-up Probe Properties
Name	Description
[container].startupProbe.failureThreshold	When a probe fails, Kubernetes tries `failureThreshold` times before giving up.
[container].startupProbe.periodSeconds	Performs the probe every time after the specified `periodSeconds`.
[container].startupProbe.successThreshold	The minimum consecutive successful attempts for the probe to be considered successful after having failed.
[container].startupProbe.timeoutSeconds	The number of seconds after which the probe times out.
[container].startupProbe.httpGet	An action to perform based on HTTP Get requests. The default `path` is `/path` and the default `port` is `8080`.
[container].startupProbe.exec	Runs the specified command to perform the probe.

Readiness Probe Properties specifies the readiness probe properties, which are used to do a periodic probe of container service readiness. The container is removed from service endpoints if the probe fails.

Table 2. Readiness Probe Properties
Name	Description
[container].readinessProbe.failureThreshold	When a probe fails, Kubernetes tries `failureThreshold` times before giving up. The default value is 3.
[container].readinessProbe.periodSeconds	Performs the probe every time after the specified `periodSeconds`. The default value is 10.
[container].readinessProbe.successThreshold	The minimum consecutive successful attempts for the probe to be considered successful after having failed. The default value is 1.
[container].readinessProbe.timeoutSeconds	The number of seconds after which the probe times out. The default value is 1.
[container].readinessProbe.initialDelaySeconds	The number of seconds after the container starts before the probe is initiated. The default value is 20.
[container].readinessProbe.httpGet	An action to perform based on HTTP Get requests. The default `path` is `/readycheck` and the default `port` is `operations`.
[container].readinessProbe.exec	Runs the specified command to perform the probe.

Liveness Probe Properties specifies the liveness probe properties, which do a periodic probe of container liveness. The container is restarted if the probe fails.

Table 3. Liveness Probe Properties
Name	Description
[container].livenessProbe.failureThreshold	When a probe fails, Kubernetes tries `failureThreshold` times before giving up. The default value is 3.
[container].livenessProbe.periodSeconds	Performs the probe every time after the specified `periodSeconds`. The default value is 20.
[container].livenessProbe.successThreshold	The minimum consecutive successful attempts for the probe to be considered successful after having failed. The default value is 1.
[container].livenessProbe.timeoutSeconds	The number of seconds after which the probe times out. The default value is 1.
[container].livenessProbe.initialDelaySeconds	The number of seconds after the container starts before the probe is initiated. The default value is 10.
[container].livenessProbe.httpGet	An action to perform based on HTTP Get requests. The default `path` is `/healthcheck` and the default `port` is `operations`.
[container].livenessProbe.exec	Runs the specified command to perform the probe.

This is an example of a probe properties configuration:

readinessProbe:
          initialDelaySeconds: 20
          periodSeconds: 10
          httpGet:
            path: /readycheck
            port: operations

        livenessProbe:
          initialDelaySeconds: 10
          periodSeconds: 20
          httpGet:
            path: /healthcheck
            port: operations