Skip to content

Commit

Permalink
fix: health endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
@philipsens
philipsens committed Jan 11, 2024
1 parent 2787f82 commit 2050593
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 47 deletions.
6 changes: 3 additions & 3 deletions charts/zaakbrug/Chart.lock
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
dependencies:
- name: ff-common
repository: https://frankframework.github.io/charts/
version: 0.1.19
version: 0.1.20
- name: openzaak
repository: https://maykinmedia.github.io/charts/
version: 1.1.1
digest: sha256:ce82dd11b56869744cfbb73f3d36132e419adbe76c7775ebf8b0001bced8f44a
generated: "2024-01-09T18:11:20.827858559+01:00"
digest: sha256:1404c380e936034aef4da7350c8a3e1fceb46081dc36ce6a3819232c703843af
generated: "2024-01-11T14:07:13.859541915+01:00"
4 changes: 2 additions & 2 deletions charts/zaakbrug/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: A Helm chart for running ZaakBrug on Kubernetes
name: zaakbrug
icon: https://raw.githubusercontent.com/wearefrank/charts/master/charts/zaakbrug/icon.png
type: application
version: 2.0.19
version: 2.0.20

dependencies:
- name: ff-common
version: ~0.1.19
version: ~0.1.20
repository: https://frankframework.github.io/charts/
- name: openzaak
alias: staging
Expand Down
60 changes: 32 additions & 28 deletions charts/zaakbrug/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,34 +106,38 @@ The startup probe will enable blue-green deployment, which are great for uptime
It (and the liveness probe) will check if the console is accessible, until a better health endpoint is available.
The readiness probe will check if all adapters are running using the server health endpoint

| Name | Description | Value |
| ------------------------------------ | -------------------------------------------------------- | --------- |
| `replicaCount` | Number of Frank!Framework replicas to deploy | `1` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `40` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `20` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `1` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `6` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `10` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `3` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `60` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `5` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `3` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `resources` | Set the resources for the Frank!Framework containers | `{}` |
| `resources.limits` | The resources limits for the Frank!Framework containers | `""` |
| `resources.requests.memory` | The requested memory for the Frank!Framework containers | `""` |
| `resources.requests.cpu` | The requested cpu for the Frank!Framework containers | `""` |
| `terminationGracePeriodSeconds` | Number of seconds after which pods are forcefully killed | `60` |
| `terminationGracePeriodSeconds` | Note: Lower values may cause running adapters to fail | |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `tolerations` | Set tolerations for pod assignment | `[]` |
| `affinity` | Set affinity for pod assignment | `{}` |
| `timeZone` | used for database connection and log timestamps | `Etc/UTC` |
| Name | Description | Value |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | --------- |
| `replicaCount` | Number of Frank!Framework replicas to deploy | `1` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `40` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `1` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `12` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `0` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `1` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `12` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `0` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `5` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `1` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `probesEnabled` | Toggle probes. This should only be used if a Frank! needs to be kept while in a bad state (for debugging purposes) | `{}` |
| `probesEnabled.startupProbe` | Toggle startupProbe | `{}` |
| `probesEnabled.livenessProbe` | Toggle livenessProbe | `{}` |
| `probesEnabled.readinessProbe` | Toggle readinessProbe | `{}` |
| `resources` | Set the resources for the Frank!Framework containers | `{}` |
| `resources.limits` | The resources limits for the Frank!Framework containers | `""` |
| `resources.requests.memory` | The requested memory for the Frank!Framework containers | `""` |
| `resources.requests.cpu` | The requested cpu for the Frank!Framework containers | `""` |
| `terminationGracePeriodSeconds` | Number of seconds after which pods are forcefully killed | `60` |
| `terminationGracePeriodSeconds` | Note: Lower values may cause running adapters to fail | |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `tolerations` | Set tolerations for pod assignment | `[]` |
| `affinity` | Set affinity for pod assignment | `{}` |
| `timeZone` | used for database connection and log timestamps | `Etc/UTC` |

### Traffic Exposure Parameters

Expand Down
14 changes: 7 additions & 7 deletions charts/zaakbrug/values.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@
"periodSeconds": {
"type": "number",
"description": "Period seconds for startupProbe",
"default": 20
"default": 10
},
"timeoutSeconds": {
"type": "number",
Expand All @@ -283,7 +283,7 @@
"failureThreshold": {
"type": "number",
"description": "Failure threshold for startupProbe",
"default": 6
"default": 12
},
"successThreshold": {
"type": "number",
Expand Down Expand Up @@ -354,7 +354,7 @@
"initialDelaySeconds": {
"type": "number",
"description": "Initial delay seconds for livenessProbe",
"default": 10
"default": 0
},
"periodSeconds": {
"type": "number",
Expand All @@ -364,12 +364,12 @@
"timeoutSeconds": {
"type": "number",
"description": "Timeout seconds for livenessProbe",
"default": 10
"default": 1
},
"failureThreshold": {
"type": "number",
"description": "Failure threshold for livenessProbe",
"default": 3
"default": 12
},
"successThreshold": {
"type": "number",
Expand All @@ -384,7 +384,7 @@
"initialDelaySeconds": {
"type": "number",
"description": "Initial delay seconds for readinessProbe",
"default": 60
"default": 0
},
"periodSeconds": {
"type": "number",
Expand All @@ -394,7 +394,7 @@
"timeoutSeconds": {
"type": "number",
"description": "Timeout seconds for readinessProbe",
"default": 3
"default": 1
},
"failureThreshold": {
"type": "number",
Expand Down
23 changes: 16 additions & 7 deletions charts/zaakbrug/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,9 @@ replicaCount: 1
##
startupProbe:
initialDelaySeconds: 40
periodSeconds: 20
periodSeconds: 10
timeoutSeconds: 1
failureThreshold: 6
failureThreshold: 12
successThreshold: 1

## Configure extra options for Frank!Framework containers' liveness probe
Expand All @@ -200,10 +200,10 @@ startupProbe:
## @param livenessProbe.successThreshold Success threshold for livenessProbe
##
livenessProbe:
initialDelaySeconds: 10
initialDelaySeconds: 0
periodSeconds: 10
timeoutSeconds: 10
failureThreshold: 3
timeoutSeconds: 1
failureThreshold: 12
successThreshold: 1

## Configure extra options for Frank!Framework containers' readiness probe
Expand All @@ -215,12 +215,21 @@ livenessProbe:
## @param readinessProbe.successThreshold Success threshold for readinessProbe
##
readinessProbe:
initialDelaySeconds: 60
initialDelaySeconds: 0
periodSeconds: 5
timeoutSeconds: 3
timeoutSeconds: 1
failureThreshold: 3
successThreshold: 1

## @param probesEnabled [object] Toggle probes. This should only be used if a Frank! needs to be kept while in a bad state (for debugging purposes)
## @param probesEnabled.startupProbe [object] Toggle startupProbe
## @param probesEnabled.livenessProbe [object] Toggle livenessProbe
## @param probesEnabled.readinessProbe [object] Toggle readinessProbe
probesEnabled:
startupProbe: true
livenessProbe: true
readinessProbe: true

## Frank!Framework container's resource requests and limits
## ref: https://kubernetes.io/docs/user-guide/compute-resources/
## @param resources [object] Set the resources for the Frank!Framework containers
Expand Down

0 comments on commit 2050593

Please sign in to comment.