Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(probes) allows overriding the default liveness/readiness probe with custom commands #1070

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix(probes) allows overriding the default liveness/readiness probe with custom commands #1070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cadee10
fix(probes) allows overriding the default liveness/readiness probe wi…
Manan-Kothari May 22, 2024
3695ea4
docs update changelog
Manan-Kothari May 22, 2024
0193117
docs update changelog
Manan-Kothari May 22, 2024
4522b7a
adding tests
Manan-Kothari Jun 3, 2024
a57717b
fixing typo
Manan-Kothari Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions charts/kong/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
with non-KIC labels. Requires KIC 3.0+.
[#1061](https://github.com/Kong/charts/pull/1061)

* Allows overriding the liveness/readiness probes to use a command, default behavior is not changed
[#1070](https://github.com/Kong/charts/pull/1070)


## 2.38.0

### Changes
Expand Down Expand Up @@ -209,27 +213,27 @@

## 2.26.5

### Fixed
### Fixed

* Kuma ServiceAccount Token hints and volumes are also available in migrations
Pods.
[#877](https://github.com/Kong/charts/pull/877)

## 2.26.4

### Fixed
### Fixed

* updated `admin_api_uri` to `admin_gui_api_url` as per [kong documentation](https://docs.konghq.com/gateway/3.4.x/reference/configuration/#admin_api_uri).
* updated `admin_api_uri` to `admin_gui_api_url` as per [kong documentation](https://docs.konghq.com/gateway/3.4.x/reference/configuration/#admin_api_uri).

## 2.26.3

### Fixed
### Fixed

* Enabled Service and Ingress in Kong Manager for non enterprise users.

## 2.26.2

### Fixed
### Fixed

* Add missing CRD KongConsumerGroup and extend status subresource for CRDs

Expand Down
23 changes: 13 additions & 10 deletions charts/kong/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ helm install kong/kong --generate-name

## Table of contents

- [Kong for Kubernetes](#kong-for-kubernetes)
- [TL;DR;](#tldr)
- [Table of contents](#table-of-contents)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Uninstall](#uninstall)
Expand Down Expand Up @@ -57,6 +60,8 @@ helm install kong/kong --generate-name
- [Ingress Controller Parameters](#ingress-controller-parameters)
- [The `env` section](#the-env-section)
- [The `customEnv` section](#the-customenv-section)
- [The `gatewayDiscovery` section](#the-gatewaydiscovery-section)
- [Configuration](#configuration-1)
- [General Parameters](#general-parameters)
- [The `env` section](#the-env-section-1)
- [The `customEnv` section](#the-customenv-section-1)
Expand All @@ -71,9 +76,7 @@ helm install kong/kong --generate-name
- [Sessions](#sessions)
- [Email/SMTP](#emailsmtp)
- [Prometheus Operator integration](#prometheus-operator-integration)
- [Argo CD considerations](#argo-cd-considerations)
- [Changelog](https://github.com/Kong/charts/blob/main/charts/kong/CHANGELOG.md)
- [Upgrading](https://github.com/Kong/charts/blob/main/charts/kong/UPGRADE.md)
- [Argo CD Considerations](#argo-cd-considerations)
- [Seeking help](#seeking-help)

## Prerequisites
Expand Down Expand Up @@ -464,7 +467,7 @@ listens if you do not provide your own. The chart can create
configure them for you. To use this integration, install cert-manager, create
an issuer, set `certificates.enabled: true` in values.yaml, and set your issuer
name in `certificates.issuer` or `certificates.clusterIssuer` depending on the
issuer type.
issuer type.

If you do not have an issuer available, you can install the example [self-signed ClusterIssuer](https://cert-manager.io/docs/configuration/selfsigned/#bootstrapping-ca-issuers)
and set `certificates.clusterIssuer: selfsigned-issuer` for testing. You
Expand Down Expand Up @@ -705,7 +708,7 @@ or `ingress` sections, as it is used only for stream listens.

#### Admin Service mTLS

On top of the common parameters listed above, the `admin` service supports parameters for mTLS client verification.
On top of the common parameters listed above, the `admin` service supports parameters for mTLS client verification.
If any of `admin.tls.client.caBundle` or `admin.tls.client.secretName` are set, the admin service will be configured to
require mTLS client verification. If both are set, `admin.tls.client.caBundle` will take precedence.

Expand Down Expand Up @@ -879,8 +882,8 @@ On the Gateway release side, set either `admin.tls.client.secretName` to the nam
| autoscaling.targetCPUUtilizationPercentage | Target Percentage for when autoscaling takes affect. Only used if cluster does not support `autoscaling/v2` or `autoscaling/v2beta2` | `80` |
| autoscaling.metrics | metrics used for autoscaling for clusters that supports `autoscaling/v2` or `autoscaling/v2beta2` | See [values.yaml](values.yaml) |
| updateStrategy | update strategy for deployment | `{}` |
| readinessProbe | Kong readiness probe | |
| livenessProbe | Kong liveness probe | |
| readinessProbe | Kong readiness probe | See [values.yaml](values.yaml#L826) |
| livenessProbe | Kong liveness probe | See [values.yaml](values.yaml#L838) |
| startupProbe | Kong startup probe | |
| lifecycle | Proxy container lifecycle hooks | see `values.yaml` |
| terminationGracePeriodSeconds | Sets the [termination grace period](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution) for Deployment pods | 30 |
Expand Down Expand Up @@ -929,11 +932,11 @@ containerSecurityContext: # run as root to bind to lower ports
runAsUser: 0
```

**Note:** The default `podAnnotations` values disable inbound proxying for Kuma
and Istio. This is appropriate when using Kong as a gateway for external
**Note:** The default `podAnnotations` values disable inbound proxying for Kuma
and Istio. This is appropriate when using Kong as a gateway for external
traffic inbound into the cluster.

If you want to use Kong as an internal proxy within the cluster network, you
If you want to use Kong as an internal proxy within the cluster network, you
should enable inbound the inbound mesh proxies:

```yaml
Expand Down
24 changes: 24 additions & 0 deletions charts/kong/ci/probe-test-values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# CI test for testing the probe with an exec command instead of the default httpGet
# - enable the probes with execGet

livenessProbe:
exec:
command:
- python3.10
- /home/kong/scripts/liveness_probe.py
initialDelaySeconds: 10
periodSeconds: 10
timeoutSeconds: 5
successThreshold: 1
failureThreshold: 3

readinessProbe:
exec:
command:
- python3.10
- /home/kong/scripts/readiness_probe.py
initialDelaySeconds: 10
periodSeconds: 10
timeoutSeconds: 5
successThreshold: 1
failureThreshold: 3

Check failure on line 24 in charts/kong/ci/probe-test-values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (ingress) 

24:22 [new-line-at-end-of-file] no new line character at the end of file

Check failure on line 24 in charts/kong/ci/probe-test-values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (kong) 

24:22 [new-line-at-end-of-file] no new line character at the end of file

Check failure on line 24 in charts/kong/ci/probe-test-values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (gateway-operator) 

24:22 [new-line-at-end-of-file] no new line character at the end of file
23 changes: 22 additions & 1 deletion charts/kong/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,9 +275,30 @@ spec:
{{- include "kong.volumeMounts" . | nindent 10 }}
{{- include "kong.userDefinedVolumeMounts" .Values.deployment | nindent 10 }}
readinessProbe:
{{- if .Values.readinessProbe.exec }}
exec:
{{ toYaml .Values.readinessProbe.exec | indent 10 }}
initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds }}
periodSeconds: {{ .Values.readinessProbe.periodSeconds }}
successThreshold: {{ .Values.readinessProbe.successThreshold }}
failureThreshold: {{ .Values.readinessProbe.failureThreshold }}
{{- else }}
{{ include "kong.proxy.compatibleReadiness" . | indent 10 }}
{{- end }}
livenessProbe:
{{ toYaml .Values.livenessProbe | indent 10 }}
{{- if .Values.livenessProbe.exec }}
exec:
{{ toYaml .Values.livenessProbe.exec | indent 10 }}
{{- else }}
httpGet:
{{ toYaml .Values.livenessProbe.httpGet | indent 10 }}
{{- end }}
initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }}
periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
successThreshold: {{ .Values.livenessProbe.successThreshold }}
failureThreshold: {{ .Values.livenessProbe.failureThreshold }}
Comment on lines +297 to +301
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about making this into a small helm template which could be reused for both liveness and readiness probe?

{{- if .Values.startupProbe }}
startupProbe:
{{ toYaml .Values.startupProbe | indent 10 }}
Expand Down
2 changes: 2 additions & 0 deletions charts/kong/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,6 +823,7 @@ resources: {}
# memory: 2G

# readinessProbe for Kong pods
# replace httpGet with exec if you want to use a custom command
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please specify in the comments here an exemplary use case for exec? So that potential users know how exactly this can be used? I'm thinking something that could simply be uncommented to work ( assuming that httpGet section gets commented ). WDYT?

readinessProbe:
httpGet:
path: "/status/ready"
Expand All @@ -835,6 +836,7 @@ readinessProbe:
failureThreshold: 3

# livenessProbe for Kong pods
# replace httpGet with exec if you want to use a custom command
livenessProbe:
httpGet:
path: "/status"
Expand Down
Loading