Skip to content

Commit 116fe13

Browse files
wrenixprovokateurin
wrenix
and
provokateurin
committed
fix(notify_push): improve after review
Co-authored-by: Kate <[email protected]> Signed-off-by: WrenIX <[email protected]>
1 parent dee7d3b commit 116fe13

File tree

4 files changed

+83
-11
lines changed

4 files changed

+83
-11
lines changed

‎charts/nextcloud/CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Changelog
22

3-
This Helm-Chart use semantic-releases, so only major version contains breaking changes.
3+
This Helm-Chart increase there major version on every breaking change (or major version of Nextcloud itself) inspired by semantic releases.
44

5-
Here we list, what is changed.
5+
Here we list all major versions and their breaking changes for migration.
66

77

88
## v7
99

10-
- move `metrics.serviceMonitor` to `prometheus.serviceMonitor`: It us used for nextcloud-exporter and notify-push
10+
- move `metrics.serviceMonitor` to `prometheus.serviceMonitor`: It is used for nextcloud-exporter and notify-push

‎charts/nextcloud/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ helm install my-release nextcloud/nextcloud
2828
* [Headers set on NGINX](#headers-set-on-nginx)
2929
* [Probes Configurations](#probes-configurations)
3030
* [Collabora Configuration](#collabora-configuration)
31+
* [Notify Push](#notify-push)
3132
* [Imaginary](#imaginary)
3233
* [Cron jobs](#cron-jobs)
3334
* [Using the nextcloud docker image auto-configuration via env vars](#using-the-nextcloud-docker-image-auto-configuration-via-env-vars)
@@ -500,6 +501,38 @@ The nextcloud deployment includes a series of different probes you can use to de
500501
> [!Note]
501502
> If you are getting errors on initialization (such as `Fatal error: require_once(): Failed opening required '/var/www/html/lib/versioncheck.php'`, but you can get other errors as well), a good first step is to try and enable the startupProbe and/or increase the `initialDelaySeconds` for the `livenessProbe` and `readinessProbe` to something much greater (consider using `120` seconds instead of `10`. This is an especially good idea if your cluster is running on older hardware, has a slow internet connection, or you're using a slower storage class, such as NFS that's running with older disks or a slow connection.
502503

504+
### Notify Push
505+
506+
We include an optional Client Push [nextcloud/notify_push](https://github.com/nextcloud/notify_push).
507+
508+
509+
| Parameter | Description | Default |
510+
|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|------------------------|
511+
| `notifyPush.enabled` | Enable another deployment to handle notify_push (sometimes called ClientPush) | `false` |
512+
| `notifyPush.autoSetup` | Setup notify_push on nextcloud per docker-entrypoint-hooks before start | `false` |
513+
| `notifyPush.replicaCount` | Number of notify-push pod replicas to deploy | `1` |
514+
| `notifyPush.image.registry` | notify-push image registry | `docker.io` |
515+
| `notifyPush.image.repository` | notify-push image name | `miles170/notify_push` |
516+
| `notifyPush.image.tag` | notify-push image tag | `v0.7.0` |
517+
| `notifyPush.image.pullPolicy` | notify-push image pull policy | `IfNotPresent` |
518+
| `notifyPush.image.pullSecrets` | notify-push image pull secrets | `[]` |
519+
| `notifyPush.redisURLEnv` | option to set the redis_url per env (if a external redis is used) e.g.: `value: ""` or `valueFrom: {secretKeyRef:{name:"",key:""}}` | `""` |
520+
| `notifyPush.podAnnotations` | Additional annotations for notify-push pods | `{}` |
521+
| `notifyPush.podLabels` | Additional labels for notify-push pods | `{}` |
522+
| `notifyPush.podSecurityContext` | Optional security context for the notify-push pod | `nil` |
523+
| `notifyPush.securityContext` | Optional security context for the notify-push container | `nil` |
524+
| `notifyPush.resources` | notify-push resources | `{}` |
525+
| `notifyPush.service.type` | notify-push: Kubernetes Service type | `ClusterIP` |
526+
| `notifyPush.service.loadBalancerIP` | Use serviceLoadBalancerIP to request a specific static IP, otherwise leave blank | `nil` |
527+
| `notifyPush.service.nodePort` | notify-push: NodePort for service type NodePort | `nil` |
528+
| `notifyPush.service.annotations` | Additional annotations for service notify-push | `{}` |
529+
| `notifyPush.service.labels` | Additional labels for service notify-push | `{}` |
530+
| `notifyPush.ingress.path` | Add path in default ingress to notify_push service | `/push` |
531+
| `notifyPush.ingress.pathType` | PathType for additional path in default ingress for notify-push path | `Prefix` |
532+
533+
> [!Note]
534+
> notify-push needs an redis (redis.enabled=true or notifyPush.redisURLEnv={...})
535+
503536
### Collabora Configuration
504537

505538
This section provides options to enable and configure the Collabora Online server within your deployment. Please ensure to review the [Collabora Online Helm chart documentation](https://github.com/CollaboraOnline/online/tree/master/kubernetes/helm/collabora-online) for additional details and recommended values.

‎charts/nextcloud/files/notify_push.sh.tpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/sh
22
/var/www/html/occ app:install notify_push
3-
/var/www/html/occ config:app:set notify_push base_endpoint --value="https://{{ .Values.nextcloud.host }}{{ .Values.notifyPush.ingress.path }}"
4-
# /var/www/html/occ notify_push:setup "https://{{ .Values.nextcloud.host }}{{ .Values.notifyPush.ingress.path }}"
3+
/var/www/html/occ config:app:set notify_push base_endpoint --value="http{{ if .Values.ingress.tls }}s{{ end }}://{{ .Values.nextcloud.host }}{{ .Values.notifyPush.ingress.path }}"
4+
# /var/www/html/occ notify_push:setup "http{{ if .Values.ingress.tls }}s{{ end }}://{{ .Values.nextcloud.host }}{{ .Values.notifyPush.ingress.path }}"

‎charts/nextcloud/values.yaml

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -694,38 +694,77 @@ dnsConfig:
694694

695695
# Notify Push (Clientpush)
696696
notifyPush:
697-
# -- enable another deployment to handle notify_push (sometimes called ClientPush)
697+
# -- Enable another deployment to handle notify_push (sometimes called ClientPush)
698+
# @section -- Notify Push (Clientpush)
698699
enabled: false
700+
# -- Setup notify_push on nextcloud per docker-entrypoint-hooks before start
701+
# @section -- Notify Push (Clientpush)
699702
autoSetup: false
700703

704+
# -- Number of notify-push pod replicas to deploy
705+
# @section -- Notify Push (Clientpush)
701706
replicaCount: 1
702707

703708
image:
709+
# -- notify-push image registry
710+
# @section -- Notify Push (Clientpush)
704711
registry: docker.io
705-
# -- image of notify_push (there is no official image yet: https://github.com/nextcloud/notify_push/issues/106)
712+
# -- notify-push image name (there is no official image yet: https://github.com/nextcloud/notify_push/issues/106)
713+
# @section -- Notify Push (Clientpush)
706714
repository: miles170/notify_push
715+
# -- notify-push image tag
716+
# @section -- Notify Push (Clientpush)
707717
tag: v0.7.0
718+
# -- notify-push image pull policy
719+
# @section -- Notify Push (Clientpush)
708720
pullPolicy: IfNotPresent
709-
pullSecrets:
721+
# -- notify-push image pull secrets
722+
# e.g.
710723
# - myRegistrKeySecretName
724+
# @section -- Notify Push (Clientpush)
725+
pullSecrets: []
726+
711727
# -- option to set the redis_url per env (if a external redis is used) e.g.: `value: ""` or `valueFrom: {secretKeyRef:{name:"",key:""}}`
728+
# @section -- Notify Push (Clientpush)
712729
redisURLEnv:
713730

714-
resources: {}
715-
731+
# -- Additional annotations for notify-push pods
732+
# @section -- Notify Push (Clientpush)
716733
podAnnotations: {}
734+
# -- Additional labels for notify-push pods
735+
# @section -- Notify Push (Clientpush)
717736
podLabels: {}
737+
# -- Optional security context for the notify-push pod
738+
# @section -- Notify Push (Clientpush)
739+
podSecurityContext: {}
740+
741+
# -- Optional security context for the notify-push container
742+
# @section -- Notify Push (Clientpush)
743+
securityContext: {}
744+
# -- notify-push resources
745+
# @section -- Notify Push (Clientpush)
746+
resources: {}
718747

719748
service:
749+
# -- notify-push: Kubernetes Service type
750+
# @section -- Notify Push (Clientpush)
720751
type: ClusterIP
721752
# -- Use serviceLoadBalancerIP to request a specific static IP, otherwise leave blank
753+
# @section -- Notify Push (Clientpush)
722754
loadBalancerIP:
755+
# -- Additional annotations for service notify-push
756+
# @section -- Notify Push (Clientpush)
723757
annotations: {}
758+
# -- Additional labels for service notify-push
759+
# @section -- Notify Push (Clientpush)
724760
labels: {}
725761

726762
ingress:
727-
# -- patch default ingress to forward following path to notify_push service
763+
# -- Add path in default ingress to notify_push service
764+
# @section -- Notify Push (Clientpush)
728765
path: /push
766+
# -- PathType for additional path in default ingress for notify-push path
767+
# @section -- Notify Push (Clientpush)
729768
pathType: Prefix
730769

731770
imaginary:

0 commit comments

Comments
 (0)