Configure liveness and readiness probes

In Astronomer Software, you can create liveness and readiness probes to assess whether your Kubernetes Pods or network are healthy and can process requests.

Some components in Astronomer Software include liveness and readiness probes by default, but all components support adding and configuring them. Astronomer Software allows you to use the Kubernetes liveness and readiness probe definitions so you can monitor the state of your Pods.

Liveness probes can be useful in all cases. However, readiness probes might be most useful for the following scenarios:

If you have network ports open on the container
Containers that do not have open ports, but have multiple processes within the container
A setup where a process in a container might never reach a healthy state because it is waiting for some state to be achieved.

Default probe behavior

You can use the following structure to define your probes in your values.yaml file. For example, you might want to adjust any default values by configuring the amount of time until a timeout. You can refer to some of the existing Default probe configurations.

You can add any definitions that are compatible with Kubernetes probes. However, because Kubernetes does not allow having more than one handler of probes you must be sure that you do not define probes to use both exec and httpGet. For consistency, the examples shown in the Default Astronomer Helm probe configurations use httpGet, but can use exec when appropriate.

Liveness probe templates

1 livenessProbe:
2   enabled: true
3   httpGet:
4     path: /index.html
5     port: 443

Readiness probe templates

1 readinessProbe:
2   enabled: true
3   httpGet:
4     path: /index.html
5     port: 444

Retrieve existing probe definitions

You can retrieve the default probe definitions from the Kubernetes manifest. The following example shows how to retrieve the definitions for Houston.

$ kubectl -n "${NAMESPACE}" get deployment -l component=houston -o yaml

This command produces a large amount of yaml output describing your Houston configuration. Within this output, is a section describing the livenessProbe, which looks like the following:

1 livenessProbe:
2   failureThreshold: 10
3   httpGet:
4     path: /v1/healthz
5     port: 8871
6     scheme: HTTP
7   initialDelaySeconds: 30
8   periodSeconds: 10
9   successThreshold: 1
10   timeoutSeconds: 1

You can copy and paste this output into your values.yaml file for your Houston configuration, then adjust the values you want to customize. Then apply a platform config change.

Reference Helm values within your probes

Because values for the liveness and readiness probes are passed through the Helm template function, you can reference Helm values within the probes. Specifically, the livenessProbe and readiness values are rendered to yaml, then passed through the Helm template function, which renders any Helm template syntaxes into the produced yaml.

For example, instead of hardcoding values for your probes to match values defined by other configurations in your values.yaml file, you can use the configuration variable itself.

The following example, using the alertsmanager yaml configuration, shows how the path and ports are defined by Values.ports.http and Values.prefixURL elsewhere in the values.yaml file.

1 readinessProbe:
2   httpGet:
3     path: {{ .Values.prefixURL }}/#/status
4     port: {{ .Values.ports.http }}
5   initialDelaySeconds: 30
6   timeoutSeconds: 30

Default Astronomer Helm probe configurations

The following components have their default probe configuration defined in the Astronomer Helm chart.

If a component does not have probes defined by default, you can see which options can have custom probe configurations.

Alert manager

1 alertmanager_auth-proxy:
2   livenessProbe:
3     httpGet:
4       path: /healthz
5       port: 8084
6       scheme: HTTP
7     initialDelaySeconds: 10
8     periodSeconds: 10
9   readinessProbe:
10     httpGet:
11       path: /healthz
12       port: 8084
13       scheme: HTTP
14     initialDelaySeconds: 10
15     periodSeconds: 10

The following can also be configured to include liveness and readiness probes:

1 alertmanager:
2   livenessProbe: {}

Astronomer

1 astronomer:
2   astroUI:
3     livenessProbe:
4       httpGet:
5         path: /
6         port: 8080
7       initialDelaySeconds: 10
8       periodSeconds: 10
9     readinessProbe:
10       httpGet:
11         path: /
12         port: 8080
13       initialDelaySeconds: 10
14       periodSeconds: 10
15   commander:
16     livenessProbe:
17       httpGet:
18         path: /healthz
19         port: 8880
20         scheme: HTTP
21       initialDelaySeconds: 10
22       periodSeconds: 10
23       failureThreshold: 5
24       successThreshold: 1
25       timeoutSeconds: 5
26     readinessProbe:
27       httpGet:
28         path: /healthz
29         port: 8880
30       initialDelaySeconds: 10
31       periodSeconds: 10
32   houston:
33     livenessProbe:
34       httpGet:
35         path: /v1/healthz
36         port: 8871
37       initialDelaySeconds: 30
38       periodSeconds: 10
39       failureThreshold: 10
40     readinessProbe:
41       httpGet:
42         path: /v1/healthz
43         port: 8871
44       initialDelaySeconds: 30
45       periodSeconds: 10
46       failureThreshold: 10
47   registry:
48     livenessProbe:
49       httpGet:
50         path: /
51         port: 5000
52       initialDelaySeconds: 10
53       periodSeconds: 10
54       timeoutSeconds: 5
55     readinessProbe:
56       httpGet:
57         path: /
58         port: 5000
59       initialDelaySeconds: 10
60       periodSeconds: 10
61       timeoutSeconds: 5

The following can also be configured to include liveness and readiness probes:

1 astronomer:
2   configSyncer:
3     livenessProbe: {}
4     readinessProbe: {}
5   houston:
6     bootstrapper:
7       livenessProbe: {}
8       readinessProbe: {}
9     cleanupAirflowDb:
10       livenessProbe: {}
11       readinessProbe: {}
12     cleanupDeployRevisions:
13       livenessProbe: {}
14       readinessProbe: {}
15     cleanupDeployments:
16       livenessProbe: {}
17       readinessProbe: {}
18     dbMigration:
19       livenessProbe: {}
20       readinessProbe: {}
21     taskUsageMetrics:
22       livenessProbe: {}
23       readinessProbe: {}
24     updateCheck:
25       livenessProbe: {}
26       readinessProbe: {}
27     updateResourceStrategy:
28       livenessProbe: {}
29       readinessProbe: {}
30     updateRuntimeCheck:
31       livenessProbe: {}
32       readinessProbe: {}
33     upgradeDeployments:
34       livenessProbe: {}
35       readinessProbe: {}
36     waitForDB:
37       livenessProbe: {}
38       readinessProbe: {}
39     worker:
40       livenessProbe: {}
41       readinessProbe: {}