autopush

autopush

Version: 0.0.17 Type: application AppVersion: 1.72.2

A Helm chart for Kubernetes

Maintainers

NameEmailUrl
WrenIXhttps://wrenix.eu

= Beta

WARNING

We let it run in production, but it is not stable / complete.

TODOs:

====

Usage

Helm must be installed and setup to your kubernetes cluster to use the charts. Refer to Helm’s documentation to get started. Once Helm has been set up correctly, fetch the charts as follows:

helm pull oci://codeberg.org/wrenix/helm-charts/autopush

You can install a chart release using the following command:

helm install autopush-release oci://codeberg.org/wrenix/helm-charts/autopush --values values.yaml

To uninstall a chart release use helm’s delete command:

helm uninstall autopush-release

Requirements

RepositoryNameVersion
oci://docker.io/bitnamichartsredis20.11.4

Values

Autoconnect

KeyTypeDefaultDescription
autoconnect.image.pullPolicystring"IfNotPresent"This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
autoconnect.image.registrystring"codeberg.org"image registry (could be overwritten by global.image.registry)
autoconnect.image.repositorystring"wrenix/autopush/autoconnect"image repository
autoconnect.image.tagstring"latest"image tag - Overrides the image tag whose default is the chart appVersion.
autoconnect.livenessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the liveness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
autoconnect.podAnnotationsobject{}This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
autoconnect.podLabelsobject{}This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
autoconnect.readinessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
autoconnect.replicaCountint1This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
autoconnect.resourcesobject{}We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after ‘resources:’. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi
autoconnect.securityContextobject{}securityContext capabilities: drop: - ALL readOnlyRootFilesystem: true runAsNonRoot: true runAsUser: 1000
autoconnect.service.ports.httpint80port of http service
autoconnect.service.ports.routerint8081port of internal router service
autoconnect.service.typestring"ClusterIP"This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
autoconnect.volumeMountslist[]Additional volumeMounts on the output Deployment definition. - name: foo mountPath: “/etc/foo” readOnly: true

Autoendpoint

KeyTypeDefaultDescription
autoendpoint.image.pullPolicystring"IfNotPresent"This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
autoendpoint.image.registrystring"codeberg.org"image registry (could be overwritten by global.image.registry)
autoendpoint.image.repositorystring"wrenix/autopush/autoendpoint"image repository
autoendpoint.image.tagstring"latest"image tag - Overrides the image tag whose default is the chart appVersion.
autoendpoint.livenessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the liveness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
autoendpoint.podAnnotationsobject{}This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
autoendpoint.podLabelsobject{}This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
autoendpoint.readinessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
autoendpoint.replicaCountint1This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
autoendpoint.resourcesobject{}We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after ‘resources:’. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi
autoendpoint.service.portint80This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
autoendpoint.service.typestring"ClusterIP"This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
autoendpoint.volumeMountslist[]Additional volumeMounts on the output Deployment definition. - name: foo mountPath: “/etc/foo” readOnly: true

UnifiedPush

KeyTypeDefaultDescription
serviceAccount.annotationsobject{}Annotations to add to the service account
serviceAccount.automountbooltrueAutomatically mount a ServiceAccount’s API credentials?
serviceAccount.createbooltrueSpecifies whether a service account should be created
serviceAccount.namestring""The name of the service account to use. If not set and create is true, a name is generated using the fullname template
unifiedPush.enabledboolfalseenable/deploy common-proxy for unifiedpush
unifiedPush.image.pullPolicystring"IfNotPresent"This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
unifiedPush.image.registrystring"docker.io"image registry (could be overwritten by global.image.registry)
unifiedPush.image.repositorystring"unifiedpush/common-proxies"image repository
unifiedPush.image.tagstring"v2.2.0"image tag
unifiedPush.livenessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the liveness more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
unifiedPush.podAnnotationsobject{}This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
unifiedPush.podLabelsobject{}This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
unifiedPush.readinessProbeobject{"httpGet":{"path":"/health","port":"http"}}This is to setup the readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
unifiedPush.replicaCountint1This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
unifiedPush.resourcesobject{}We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after ‘resources:’. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi
unifiedPush.service.portint80This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
unifiedPush.service.typestring"ClusterIP"This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
unifiedPush.volumeMountslist[]Additional volumeMounts on the output Deployment definition. - name: foo mountPath: “/etc/foo” readOnly: true

Other Values

KeyTypeDefaultDescription
autoconnect.affinityobject{}
autoconnect.nodeSelectorobject{}
autoconnect.podSecurityContextobject{}
autoconnect.tolerationslist[]
autoendpoint.affinityobject{}
autoendpoint.nodeSelectorobject{}
autoendpoint.podSecurityContextobject{}
autoendpoint.securityContextobject{}
autoendpoint.tolerationslist[]
config.cryptoKeystring""run https://github.com/mozilla-services/autopush-rs/blob/master/scripts/fernet_key.py
config.logs.backtraceboolfalseenable backtrace of autopush
config.logs.levelstring"warn"set log level of autopush
fullnameOverridestring""
global.image.pullPolicystringnilif set it will overwrite all pullPolicy
global.image.registrystringnilif set it will overwrite all registry entries
grafana.dashboards.annotationsobject{}
grafana.dashboards.enabledboolfalse
grafana.dashboards.labels.grafana_dashboardstring"1"
imagePullSecretslist[]This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
ingress.annotationsobject{}
ingress.classNamestring""
ingress.enabledboolfalse
ingress.hoststring"chart-example.local"
ingress.tlslist[]
nameOverridestring""This is to override the chart name.
prometheus.enabledbooltruestart statsd sidecar and configure
prometheus.image.pullPolicystring"IfNotPresent"
prometheus.image.registrystring"docker.io"
prometheus.image.repositorystring"prom/statsd-exporter"
prometheus.image.tagstring"v0.28.0"
prometheus.livenessProbeobject{"httpGet":{"path":"/","port":"metrics"}}This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
prometheus.readinessProbe.httpGet.pathstring"/"
prometheus.readinessProbe.httpGet.portstring"metrics"
prometheus.resourcesobject{}We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after ‘resources:’. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi
prometheus.rules.additionalRuleslist[]
prometheus.rules.default.alertLabelsobject{}
prometheus.rules.default.enabledbooltrue
prometheus.rules.enabledboolfalse
prometheus.rules.labelsobject{}
prometheus.securityContextobject{}securityContext capabilities: drop: - ALL readOnlyRootFilesystem: true runAsNonRoot: true runAsUser: 1000
prometheus.servicemonitor.enabledboolfalse
prometheus.servicemonitor.labelsobject{}
prometheus.volumeMountslist[]Additional volumeMounts on the output Deployment definition. - name: foo mountPath: “/etc/foo” readOnly: true
redis.architecturestring"standalone"
redis.auth.enabledbooltrue
redis.auth.existingSecretstring""name of an existing secret with Redis credentials (instead of auth.password), must be created ahead of time
redis.auth.existingSecretPasswordKeystring""Password key to be retrieved from existing secret
redis.auth.passwordstring"autopush"XXX Change me!
redis.dbidint0Database ID for non-default database
redis.external.existingSecretPasswordKeystring"redis-password"Password key to be retrieved from existing secret
redis.external.hoststring"redis"
redis.external.portint6379
redis.global.storageClassstring""
redis.internalbooltrue
redis.master.persistence.enabledbooltrue
redis.master.service.portint6379
redis.replica.persistence.enabledbooltrue
unifiedPush.affinityobject{}
unifiedPush.config.gateway.allowedHostslist[]
unifiedPush.config.gateway.generic.enablebooltrue
unifiedPush.config.gateway.matrix.enablebooltrue
unifiedPush.config.uaidstring""
unifiedPush.config.verboseboolfalse
unifiedPush.nodeSelectorobject{}
unifiedPush.podSecurityContextobject{}
unifiedPush.securityContextobject{}
unifiedPush.tolerationslist[]
volumeslist[]Additional volumes on the output Deployment definition. - name: foo secret: secretName: mysecret optional: false

Autogenerated from chart metadata using helm-docs