Skip to content

Commit

Permalink
feat: upgrade ff-common
Browse files Browse the repository at this point in the history
  • Loading branch information
@philipsens
philipsens committed Jan 9, 2024
1 parent fde4df3 commit 2787f82
Show file tree
Hide file tree
Showing 7 changed files with 339 additions and 87 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.18
version: 0.1.19
- name: openzaak
repository: https://maykinmedia.github.io/charts/
version: 1.1.1
digest: sha256:5f6948fc63dad8dfe41a658f9c44e7500325fd0f0529eefd37dfbdae045ff4c6
generated: "2023-12-15T13:42:37.957752717+01:00"
digest: sha256:ce82dd11b56869744cfbb73f3d36132e419adbe76c7775ebf8b0001bced8f44a
generated: "2024-01-09T18:11:20.827858559+01:00"
6 changes: 3 additions & 3 deletions charts/zaakbrug/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
apiVersion: v2
appVersion: 1.13.35
appVersion: 1.14.2
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.18
version: 2.0.19

dependencies:
- name: ff-common
version: ~0.1.18
version: ~0.1.19
repository: https://frankframework.github.io/charts/
- name: openzaak
alias: staging
Expand Down
67 changes: 50 additions & 17 deletions charts/zaakbrug/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ helm delete zaakbrug
| `frank.memory.percentage` | Set if the values for the memory are in percentages | `false` |
| `frank.memory.minimum` | Sets the initial size of the heap that will be used by the Frank!Framework | `4G` |
| `frank.memory.maximum` | Sets the maximum size of the heap that will be used by the Frank!Framework | `4G` |
| `frank.dtap.stage` | (Required) Set the `DTAP` stage. Options: `LOC`, `DEV`, `TST`, `ACC`, `PRD` | `LOC` |
| `frank.dtap.stage` | (Required) Set the `DTAP` stage. Options: `LOC`, `DEV`, `TST`, `ACC`, `PRD` | `""` |
| `frank.dtap.side` | Set the `DTAP` side of where the instance is running | `""` |
| `frank.credentials.secret` | Set the secret name of the existing secret | `""` |
| `frank.credentials.key` | Set the key inside the secret that contains the data (e.g. `credentials.properties`) | `""` |
Expand All @@ -78,6 +78,7 @@ helm delete zaakbrug
| `frank.security.http.activeDirectory.roleMapping.observer` | Map the rol for Observer | `""` |
| `frank.server.transactionManager` | Set the transaction manager for Tomcat. Options: `NARAYANA`, `BTM`, `` | `""` |
| `frank.environmentVariables` | Set extra environment variables for the Frank! | `{}` |
| `frank.javaOpts` | Append custom options to the `JAVA_OPTS` environment variable for the Frank! | `""` |

### Frank!Framework Connection parameters

Expand All @@ -101,22 +102,38 @@ helm delete zaakbrug

### Frank!Framework deployment parameters

| Name | Description | Value |
| ----------------------------------- | ------------------------------------------------------- | --------- |
| `replicaCount` | Number of Frank!Framework replicas to deploy | `1` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `40` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `1` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `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 | `""` |
| `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` |
The startup probe will enable blue-green deployment, which are great for uptime during upgrades and such.
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` |

### Traffic Exposure Parameters

Expand Down Expand Up @@ -146,6 +163,22 @@ helm delete zaakbrug
| `podSecurityContext` | Set Frank!Framework pod's Security Context | `{}` |
| `securityContext` | Set Frank!Framework container's Security Context | `{}` |

### Persistence

Persistence is used for keeping heap dumps. They can be found at `/heap-dumps` with persistence enabled.
Otherwise, they can be found at `/usr/local/tomcat/logs`

| Name | Description | Value |
| --------------------------- | ---------------------------------------------------------------------------------- | ------- |
| `persistence.enabled` | Enable persistence using Persistent Volume Claims | `false` |
| `persistence.storageClass` | Persistent Volume storage class | `""` |
| `persistence.accessModes` | Persistent Volume access modes | `[]` |
| `persistence.size` | Persistent Volume size | `5Gi` |
| `persistence.dataSource` | Custom PVC data source | `{}` |
| `persistence.existingClaim` | The name of an existing PVC to use for persistence | `""` |
| `persistence.selector` | Selector to match an existing Persistent Volume for the Frank!Framework's data PVC | `{}` |
| `persistence.annotations` | Persistent Volume Claim annotations | `{}` |

### ZaakBrug

Following sections are about the configuration for the ZaakBrug
Expand Down
14 changes: 12 additions & 2 deletions charts/zaakbrug/templates/deployment.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ spec:
configMap:
name: {{ template "ff-common.fullname" . }}-profiles
{{- end -}}
{{- if .Values.persistence.enabled }}
- name: {{ template "ff-common.fullname" . }}-data
persistentVolumeClaim:
claimName: {{ template "ff-common.fullname" . }}-data
{{- end }}
{{- end -}}
{{- define "zaakbrug.deployment.container" -}}
envFrom:
Expand Down Expand Up @@ -94,11 +99,16 @@ volumeMounts:
mountPath: /opt/frank/configurations/Translate/Globals.json
subPath: Globals.json
readOnly: true
{{- end }}
{{- if .Values.zaakbrug.profiles }}
{{- end }}
{{- if .Values.zaakbrug.profiles }}
- name: {{ template "ff-common.fullname" . }}-profiles
mountPath: /opt/frank/configurations/Translate/Profiles.json
subPath: Profiles.json
readOnly: true
{{- end }}
{{- if .Values.persistence.enabled }}
- name: {{ template "ff-common.fullname" . }}-data
subPath: heap-dumps
mountPath: /heap-dumps
{{- end }}
{{- end -}}
2 changes: 2 additions & 0 deletions charts/zaakbrug/templates/manifest.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@
{{ template "ff-common.service.tpl" . }}
---
{{ template "ff-common.ingress.tpl" . }}
---
{{ template "ff-common.persistentvolumeclaim.tpl" . }}
Loading

0 comments on commit 2787f82

Please sign in to comment.