From 2c5bbbb6da2376c5345080016be76f09b3854316 Mon Sep 17 00:00:00 2001 From: Simon Larsen Date: Thu, 1 Aug 2024 08:22:51 -0600 Subject: [PATCH] feat: Update OneUptime chart to use `probes` instead of `probe` for probe configuration This commit modifies the OneUptime chart to use the `probes` parameter instead of the `probe` parameter for configuring probes. The `probes` parameter now accepts a key-value pair where the key represents the probe name and the value contains the probe configuration details. This change improves the clarity and consistency of the chart configuration, making it easier to manage and maintain. Files modified: - HelmChart/Public/oneuptime/README.md --- HelmChart/Public/oneuptime/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/HelmChart/Public/oneuptime/README.md b/HelmChart/Public/oneuptime/README.md index a2912dc00e..3542b6b3f2 100644 --- a/HelmChart/Public/oneuptime/README.md +++ b/HelmChart/Public/oneuptime/README.md @@ -92,13 +92,13 @@ The following table lists the configurable parameters of the OneUptime chart and | `nginx.service.type` | nginx service type | `LoadBalancer` | | | `nginx.service.loadBalancerIP` | nginx service load balancer IP | `nil` | | | `deployment.replicaCount` | Number of replicas | `1` | | -| `probe..name` | Probe name | `` | | -| `probe..description` | Probe description | `nil` | | -| `probe..key` | Probe key. Please set this to long random string to secure your probes. | `nil` | | -| `probe..monitoringWorkers` | Number of threads / parallel processes you need to monitor your resources | `3` | | -| `probe..monitorFetchLimit` | Number of resources to be monitored in parallel | `10` | | -| `probe..syntheticMonitorScriptTimeoutInMs` | Timeout for synthetic monitor script | `60000` | | -| `probe..customCodeMonitorScriptTimeoutInMs` | Timeout for custom code monitor script | `60000` | | +| `probes..name` | Probe name | `` | | +| `probes..description` | Probe description | `nil` | | +| `probes..key` | Probe key. Please set this to long random string to secure your probes. | `nil` | | +| `probes..monitoringWorkers` | Number of threads / parallel processes you need to monitor your resources | `3` | | +| `probes..monitorFetchLimit` | Number of resources to be monitored in parallel | `10` | | +| `probes..syntheticMonitorScriptTimeoutInMs` | Timeout for synthetic monitor script | `60000` | | +| `probes..customCodeMonitorScriptTimeoutInMs` | Timeout for custom code monitor script | `60000` | | | `statusPage.cnameRecord` | CNAME record for the status page | `nil` | | | `internalSmtp.sendingDomain` | Domain to send emails from | `nil` | | | `internalSmtp.dkimPrivateKey` | DKIM Private Key that is set for sending domain | `nil` | | @@ -308,7 +308,7 @@ Please do the same for Redis and Clickhouse. - [ ] Please make sure you have a backups enabled for your PVCs. This is outside the scope of this chart. Please refer to your cloud provider's documentation on how to enable backups for PVCs. - [ ] Please make sure you have static passwords for your database passswords (for redis, clickhouse and postgres). You can refer to Bitnami documentation on how to set static passwords for these databases. - [ ] Please set `oneuptimeSecret` and `encryptionSecret` to a long random string. You can use a password generator to generate these strings. -- [ ] Please set `probe..key` to a long random string. This is used to secure your probes. +- [ ] Please set `probes..key` to a long random string. This is used to secure your probes. - [ ] Please regularly update OneUptime. We release updates every day. We recommend you to update the software aleast once a week if you're running OneUptime production. ## Releases