About Readiness and Liveness Probes

The TimesTen Operator provides readiness and liveness probes so that Kubernetes can determine the health of the TimesTen Operator.

The readiness and liveness probes are defined in the operator.yaml YAML manifest file.

Here is a snippet of the operator.yaml file, showing the readiness and liveness probes:

# Copyright (c) 2019 - 2023, Oracle and/or its affiliates.
apiVersion: apps/v1
kind: Deployment
metadata:
  name: timesten-operator
spec:
...
          ports:
          - name: probes
            containerPort: 8081
            protocol: TCP
          ...
          readinessProbe:
            httpGet:
              scheme: HTTP
              path: /healthz
              port: probes
            initialDelaySeconds: 10
            periodSeconds: 10
            timeoutSeconds: 10
            successThreshold: 1
            failureThreshold: 1
          livenessProbe:
            httpGet:
              scheme: HTTP
              path: /healthz
              port: probes
            initialDelaySeconds: 10
            periodSeconds: 30
            timeoutSeconds: 10
            successThreshold: 1
            failureThreshold: 3
          env:
            ...
            - name: EXPOSE_PROBES
              value: "1"
 ...

The TimesTen Operator exposes these probes to applications in the Kubernetes cluster by creating the timesten-operator Kubernetes Service.

Although we do not recommend it, you can choose to not expose these probes by setting the TimesTen Operator EXPOSE_PROBES environment variable to "0".

Note:

If you do set EXPOSE_PROBES to "0", helm test will not work properly. For information about using Helm to test the TimesTen Operator deployment, see Test the TimesTen Operator.

For information about the TimesTen Operator environment variables, see TimesTen Kubernetes Operator Environment Variables.

The operator.yaml file that is provided by the TimesTen Operator is discussed in the upcoming Customize the TimesTen Operator section. This section shows you how to customize the TimesTen Operator and shows you the liveness and readiness probes entries in the operator.yaml file.