Public Information

samples/probes/README.md

@@ -0,0 +1,37 @@
+# Custom Probes Example
+
+In this example, we show how to change the probes on the main container in a chart.
+Especially with nappl, it can happen that it takes longer in larger projects, so you may want to
+adjust the startup delay times or switch entirely to your own or different health checks.
+
+In practice, the probes provided by the vendor are often not suitable for production environments. nplus ships with tested alternatives,
+but depending on your setup, you may still need to adjust them.
+
+You can override the probes as follows:
+
+For example, in the instance chart:
+
+```
+nappl:
+  probes:
+    startupProbe:
+    httpGet:
+      path: /index.html
+      port: application
+    initialDelaySeconds: 60
+    failureThreshold: 10
+  livenessProbe:
+    httpGet:
+      path: /nscalealinst1/rest/configuration/sysinfo.json
+      port: application
+    initialDelaySeconds: 60
+    timeoutSeconds: 3
+    failureThreshold: 5
+  readinessProbe:
+    httpGet:
+      path: /jmx/status
+      port: application
+    failureThreshold: 3
+```
+
+The example above overrides the shipped *nplus* probes with the original Ceyoniq probes, as they were (as of February 2026) in [GitHub](https://github.com/ceyoniq/container/blob/main/kubernetes/kustomize/nscale/base/application-layer.yaml).