Skip to content

Commit 3cf00cf

Browse files
authored
Cron jobs documentation update (#434)
* Update the CronJob doc with current behavior Signed-off-by: ibcht <irenee@tuta.io> * Bump chart minor version Signed-off-by: ibcht <irenee@tuta.io> --------- Signed-off-by: ibcht <irenee@tuta.io> Co-authored-by: ibcht <irenee@tuta.io>
1 parent 3d31fa1 commit 3cf00cf

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

charts/nextcloud/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: nextcloud
3-
version: 4.1.0
3+
version: 4.1.1
44
appVersion: 27.0.2
55
description: A file sharing server that puts the control and security of your own data back into your hands.
66
keywords:

charts/nextcloud/README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ helm install my-release nextcloud/nextcloud
1919
* [Database Configurations](#database-configurations)
2020
* [Persistence Configurations](#persistence-configurations)
2121
* [Metrics Configurations](#metrics-configurations)
22-
* [Cronjob](#cronjob)
22+
* [Cron jobs](#cron-jobs)
2323
* [Multiple config.php file](#multiple-configphp-file)
2424
* [Using nginx](#using-nginx)
2525
* [Preserving Source IP](#preserving-source-ip)
@@ -150,11 +150,11 @@ The following table lists the configurable parameters of the nextcloud chart and
150150
| `redis.auth.password` | The password redis uses | `''` |
151151
| `redis.auth.existingSecret` | The name of an existing secret with Redis® credentials | `''` |
152152
| `redis.auth.existingSecretPasswordKey` | Password key to be retrieved from existing secret | `''` |
153-
| `cronjob.enabled` | Whether to enable/disable cronjob | `false` |
154-
| `cronjob.lifecycle.postStartCommand` | Specify deployment lifecycle hook postStartCommand | `nil` |
155-
| `cronjob.lifecycle.preStopCommand` | Specify deployment lifecycle hook preStopCommand | `nil` |
156-
| `cronjob.resources` | CPU/Memory resource requests/limits for the cronjob sidecar | `{}` |
157-
| `cronjob.securityContext` | Optional security context for cronjob | `nil` |
153+
| `cronjob.enabled` | Whether to enable/disable cron jobs sidecar | `false` |
154+
| `cronjob.lifecycle.postStartCommand` | Specify deployment lifecycle hook postStartCommand for the cron jobs sidecar | `nil` |
155+
| `cronjob.lifecycle.preStopCommand` | Specify deployment lifecycle hook preStopCommand for the cron jobs sidecar | `nil` |
156+
| `cronjob.resources` | CPU/Memory resource requests/limits for the cron jobs sidecar | `{}` |
157+
| `cronjob.securityContext` | Optional security context for cron jobs sidecar | `nil` |
158158
| `service.type` | Kubernetes Service type | `ClusterIP` |
159159
| `service.loadBalancerIP` | LoadBalancerIp for service type LoadBalancer | `""` |
160160
| `service.nodePort` | NodePort for service type NodePort | `nil` |
@@ -326,14 +326,11 @@ helm install --name my-release -f values.yaml nextcloud/nextcloud
326326
327327
> **Tip**: You can use the default [values.yaml](values.yaml)
328328
329-
## Cronjob
329+
## Cron jobs
330330
331-
This chart can utilize Kubernetes `CronJob` resource to execute [background tasks](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/background_jobs_configuration.html).
331+
To execute [background tasks](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/background_jobs_configuration.html) by using system cron instead of default Ajax cron, set `cronjob.enabled` parameter to `true`. Background jobs are important for tasks that do not necessarily need user intervention, but still need to be executed frequently (cleaning up, sending some notifications, pulling RSS feeds, etc.).
332332
333-
To use this functionality, set `cronjob.enabled` parameter to `true` and switch background mode to Webcron in your nextcloud settings page.
334-
See the [Configuration](#configuration) section for further configuration of the cronjob resource.
335-
336-
> **Note**: For the cronjobs to work correctly, ingress must be also enabled (set `ingress.enabled` to `true`) and `nextcloud.host` has to be publicly resolvable.
333+
Enabling this option will create a sidecar container in the Nextcloud pod, which will start a [`crond` daemon](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron) responsible for running the Nextcloud cron.php script. At first launch, the background jobs mode in your Nextcloud basic settings will automatically be set to ***Cron***.
337334
338335
## Multiple config.php file
339336

0 commit comments

Comments
 (0)