From c53619a3964cbf1d3db5b725c371c5a15644619c Mon Sep 17 00:00:00 2001 From: WrenIX Date: Thu, 27 Feb 2025 13:29:47 +0100 Subject: [PATCH] fix(autopush): add global (and improve docs) --- autopush/Chart.yaml | 2 +- autopush/README.md | 115 ++++++++++-------- .../templates/unifiedpush/deployment.yaml | 2 +- autopush/values.yaml | 98 ++++++++++++--- 4 files changed, 146 insertions(+), 71 deletions(-) diff --git a/autopush/Chart.yaml b/autopush/Chart.yaml index 38f20cf..4ff39cf 100644 --- a/autopush/Chart.yaml +++ b/autopush/Chart.yaml @@ -3,7 +3,7 @@ name: autopush description: A Helm chart for Kubernetes icon: type: application -version: "0.0.12" +version: "0.0.13" # renovate: image=docker.io/mozilla-services/autopush-rs appVersion: "1.72.2" maintainers: diff --git a/autopush/README.md b/autopush/README.md index e2fd01f..13ccb50 100644 --- a/autopush/README.md +++ b/autopush/README.md @@ -7,7 +7,7 @@ description: "A Helm chart for Kubernetes" # autopush -![Version: 0.0.12](https://img.shields.io/badge/Version-0.0.12-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.72.2](https://img.shields.io/badge/AppVersion-1.72.2-informational?style=flat-square) +![Version: 0.0.13](https://img.shields.io/badge/Version-0.0.13-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.72.2](https://img.shields.io/badge/AppVersion-1.72.2-informational?style=flat-square) A Helm chart for Kubernetes @@ -61,47 +61,80 @@ helm uninstall autopush-release ## Values +### Autoconnect + | Key | Type | Default | Description | |-----|------|---------|-------------| -| autoconnect.affinity | object | `{}` | | -| autoconnect.image.pullPolicy | string | `"IfNotPresent"` | | -| autoconnect.image.registry | string | `"codeberg.org"` | | -| autoconnect.image.repository | string | `"wrenix/autopush/autoconnect"` | | -| autoconnect.image.tag | string | `"latest"` | | -| autoconnect.livenessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | 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/ | -| autoconnect.nodeSelector | object | `{}` | | +| autoconnect.image.pullPolicy | string | `"IfNotPresent"` | This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) | +| autoconnect.image.registry | string | `"codeberg.org"` | image registry (could be overwritten by global.image.registry) | +| autoconnect.image.repository | string | `"wrenix/autopush/autoconnect"` | image repository | +| autoconnect.image.tag | string | `"latest"` | image tag - Overrides the image tag whose default is the chart appVersion. | +| autoconnect.livenessProbe | object | `{"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.podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ | | autoconnect.podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ | -| autoconnect.podSecurityContext | object | `{}` | | -| autoconnect.readinessProbe.httpGet.path | string | `"/health"` | | -| autoconnect.readinessProbe.httpGet.port | string | `"http"` | | +| autoconnect.readinessProbe | object | `{"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.replicaCount | int | `1` | This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ | | autoconnect.resources | object | `{}` | 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.securityContext | object | `{}` | securityContext capabilities: drop: - ALL readOnlyRootFilesystem: true runAsNonRoot: true runAsUser: 1000 | -| autoconnect.service.ports.http | int | `80` | | -| autoconnect.service.ports.router | int | `8081` | | -| autoconnect.service.type | string | `"ClusterIP"` | | -| autoconnect.tolerations | list | `[]` | | +| autoconnect.service.ports.http | int | `80` | port of http service | +| autoconnect.service.ports.router | int | `8081` | port of internal router service | +| autoconnect.service.type | string | `"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.volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. - name: foo mountPath: "/etc/foo" readOnly: true | -| autoendpoint.affinity | object | `{}` | | -| autoendpoint.image.pullPolicy | string | `"IfNotPresent"` | | -| autoendpoint.image.registry | string | `"codeberg.org"` | | -| autoendpoint.image.repository | string | `"wrenix/autopush/autoendpoint"` | | -| autoendpoint.image.tag | string | `"latest"` | | -| autoendpoint.livenessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | 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/ | -| autoendpoint.nodeSelector | object | `{}` | | -| autoendpoint.podAnnotations | object | `{}` | | -| autoendpoint.podLabels | object | `{}` | | -| autoendpoint.podSecurityContext | object | `{}` | | -| autoendpoint.readinessProbe.httpGet.path | string | `"/health"` | | -| autoendpoint.readinessProbe.httpGet.port | string | `"http"` | | + +### Autoendpoint + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| autoendpoint.image.pullPolicy | string | `"IfNotPresent"` | This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) | +| autoendpoint.image.registry | string | `"codeberg.org"` | image registry (could be overwritten by global.image.registry) | +| autoendpoint.image.repository | string | `"wrenix/autopush/autoendpoint"` | image repository | +| autoendpoint.image.tag | string | `"latest"` | image tag - Overrides the image tag whose default is the chart appVersion. | +| autoendpoint.livenessProbe | object | `{"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.podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ | +| autoendpoint.podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ | +| autoendpoint.readinessProbe | object | `{"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.replicaCount | int | `1` | This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ | | autoendpoint.resources | object | `{}` | 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.securityContext | object | `{}` | | -| autoendpoint.service.port | int | `80` | | -| autoendpoint.service.type | string | `"ClusterIP"` | | -| autoendpoint.tolerations | list | `[]` | | +| autoendpoint.service.port | int | `80` | This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports | +| autoendpoint.service.type | string | `"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.volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. - name: foo mountPath: "/etc/foo" readOnly: true | + +### UnifiedPush + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| unifiedPush.enabled | bool | `false` | enable/deploy common-proxy for unifiedpush | +| unifiedPush.image.pullPolicy | string | `"IfNotPresent"` | This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) | +| unifiedPush.image.registry | string | `"docker.io"` | image registry (could be overwritten by global.image.registry) | +| unifiedPush.image.repository | string | `"unifiedpush/common-proxies"` | image repository | +| unifiedPush.image.tag | string | `"v2.2.0"` | image tag | +| unifiedPush.livenessProbe | object | `{"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.podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ | +| unifiedPush.podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ | +| unifiedPush.readinessProbe | object | `{"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.replicaCount | int | `1` | This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ | +| unifiedPush.resources | object | `{}` | 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.port | int | `80` | This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports | +| unifiedPush.service.type | string | `"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.volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. - name: foo mountPath: "/etc/foo" readOnly: true | + +### Other Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| autoconnect.affinity | object | `{}` | | +| autoconnect.nodeSelector | object | `{}` | | +| autoconnect.podSecurityContext | object | `{}` | | +| autoconnect.tolerations | list | `[]` | | +| autoendpoint.affinity | object | `{}` | | +| autoendpoint.nodeSelector | object | `{}` | | +| autoendpoint.podSecurityContext | object | `{}` | | +| autoendpoint.securityContext | object | `{}` | | +| autoendpoint.tolerations | list | `[]` | | | config.cryptoKey | string | `""` | run https://github.com/mozilla-services/autopush-rs/blob/master/scripts/fernet_key.py | | config.logs.backtrace | bool | `false` | enable backtrace of autopush | | config.logs.level | string | `"warn"` | set log level of autopush | @@ -139,7 +172,6 @@ helm uninstall autopush-release | redis.architecture | string | `"standalone"` | | | redis.auth.enabled | bool | `true` | | | redis.auth.existingSecret | string | `""` | name of an existing secret with Redis credentials (instead of auth.password), must be created ahead of time | -| redis.auth.existingSecret | string | `nil` | Or use existing secret with "redis-password" key instead of static password | | redis.auth.existingSecretPasswordKey | string | `""` | Password key to be retrieved from existing secret | | redis.auth.password | string | `"autopush"` | XXX Change me! | | redis.dbid | int | `0` | Database ID for non-default database | @@ -151,35 +183,16 @@ helm uninstall autopush-release | redis.master.persistence.enabled | bool | `true` | | | redis.master.service.port | int | `6379` | | | redis.replica.persistence.enabled | bool | `true` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.automount | bool | `true` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.name | string | `""` | | | unifiedPush.affinity | object | `{}` | | | unifiedPush.config.gateway.allowedHosts | list | `[]` | | | unifiedPush.config.gateway.generic.enable | bool | `true` | | | unifiedPush.config.gateway.matrix.enable | bool | `true` | | | unifiedPush.config.uaid | string | `""` | | | unifiedPush.config.verbose | bool | `false` | | -| unifiedPush.enabled | bool | `false` | | -| unifiedPush.image.pullPolicy | string | `"IfNotPresent"` | | -| unifiedPush.image.registry | string | `"docker.io"` | | -| unifiedPush.image.repository | string | `"unifiedpush/common-proxies"` | | -| unifiedPush.image.tag | string | `"v2.2.0"` | | -| unifiedPush.livenessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | 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/ | | unifiedPush.nodeSelector | object | `{}` | | -| unifiedPush.podAnnotations | object | `{}` | | -| unifiedPush.podLabels | object | `{}` | | | unifiedPush.podSecurityContext | object | `{}` | | -| unifiedPush.readinessProbe.httpGet.path | string | `"/health"` | | -| unifiedPush.readinessProbe.httpGet.port | string | `"http"` | | -| unifiedPush.replicaCount | int | `1` | This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ | -| unifiedPush.resources | object | `{}` | 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.securityContext | object | `{}` | | -| unifiedPush.service.port | int | `80` | | -| unifiedPush.service.type | string | `"ClusterIP"` | | | unifiedPush.tolerations | list | `[]` | | -| unifiedPush.volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. - name: foo mountPath: "/etc/foo" readOnly: true | | volumes | list | `[]` | Additional volumes on the output Deployment definition. - name: foo secret: secretName: mysecret optional: false | Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) diff --git a/autopush/templates/unifiedpush/deployment.yaml b/autopush/templates/unifiedpush/deployment.yaml index 62ddbd5..1d6598c 100644 --- a/autopush/templates/unifiedpush/deployment.yaml +++ b/autopush/templates/unifiedpush/deployment.yaml @@ -37,7 +37,7 @@ spec: securityContext: {{- toYaml .securityContext | nindent 12 }} {{- with .image }} - image: "{{ coalesce $.Values.global.image.registry .registry }}/{{ .repository }}:{{ .tag | default (printf "v%s" $.Chart.AppVersion) }}" + image: "{{ coalesce $.Values.global.image.registry .registry }}/{{ .repository }}:{{ .tag }}" imagePullPolicy: {{ coalesce $.Values.global.image.pullPolicy .pullPolicy }} {{- end }} env: diff --git a/autopush/values.yaml b/autopush/values.yaml index e17ad54..49cd568 100644 --- a/autopush/values.yaml +++ b/autopush/values.yaml @@ -104,8 +104,6 @@ redis: # -- Password key to be retrieved from existing secret existingSecretPasswordKey: "" - # -- Or use existing secret with "redis-password" key instead of static password - existingSecret: external: host: redis port: 6379 @@ -128,17 +126,28 @@ redis: autoconnect: # -- This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ + # @section -- Autoconnect replicaCount: 1 image: + # -- image registry (could be overwritten by global.image.registry) + # @section -- Autoconnect registry: codeberg.org + # -- image repository + # @section -- Autoconnect repository: wrenix/autopush/autoconnect + # -- This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) + # @section -- Autoconnect pullPolicy: IfNotPresent + # -- image tag - Overrides the image tag whose default is the chart appVersion. + # @section -- Autoconnect tag: latest # -- This is for setting Kubernetes Annotations to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ + # @section -- Autoconnect podAnnotations: {} # -- This is for setting Kubernetes Labels to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + # @section -- Autoconnect podLabels: {} nodeSelector: {} @@ -157,15 +166,21 @@ autoconnect: # readOnlyRootFilesystem: true # runAsNonRoot: true # runAsUser: 1000 + # @section -- Autoconnect securityContext: {} # This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ service: - # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # -- This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # @section -- Autoconnect type: ClusterIP # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports ports: + # -- port of http service + # @section -- Autoconnect http: 80 + # -- port of internal router service + # @section -- Autoconnect router: 8081 # -- We usually recommend not to specify default resources and to leave this as a conscious @@ -178,13 +193,17 @@ autoconnect: # requests: # cpu: 100m # memory: 128Mi + # @section -- Autoconnect resources: {} - # -- 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/ + # -- 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/ + # @section -- Autoconnect livenessProbe: 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/ + # @section -- Autoconnect readinessProbe: httpGet: path: /health @@ -194,22 +213,34 @@ autoconnect: # - name: foo # mountPath: "/etc/foo" # readOnly: true + # @section -- Autoconnect volumeMounts: [] autoendpoint: # -- This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ + # @section -- Autoendpoint replicaCount: 1 image: + # -- image registry (could be overwritten by global.image.registry) + # @section -- Autoendpoint registry: codeberg.org + # -- image repository + # @section -- Autoendpoint repository: wrenix/autopush/autoendpoint + # -- This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) + # @section -- Autoendpoint pullPolicy: IfNotPresent + # -- image tag - Overrides the image tag whose default is the chart appVersion. + # @section -- Autoendpoint tag: latest - # This is for setting Kubernetes Annotations to a Pod. + # -- This is for setting Kubernetes Annotations to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ + # @section -- Autoendpoint podAnnotations: {} - # This is for setting Kubernetes Labels to a Pod. + # -- This is for setting Kubernetes Labels to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + # @section -- Autoendpoint podLabels: {} nodeSelector: {} @@ -231,9 +262,11 @@ autoendpoint: # This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ service: - # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # -- This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # @section -- Autoendpoint type: ClusterIP - # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + # -- This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + # @section -- Autoendpoint port: 80 # -- We usually recommend not to specify default resources and to leave this as a conscious @@ -246,13 +279,17 @@ autoendpoint: # requests: # cpu: 100m # memory: 128Mi + # @section -- Autoendpoint resources: {} - # -- 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/ + # -- 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/ + # @section -- Autoendpoint livenessProbe: 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/ + # @section -- Autoendpoint readinessProbe: httpGet: path: /health @@ -262,16 +299,28 @@ autoendpoint: # - name: foo # mountPath: "/etc/foo" # readOnly: true + # @section -- Autoendpoint volumeMounts: [] unifiedPush: + # -- enable/deploy common-proxy for unifiedpush + # @section -- UnifiedPush enabled: false # -- This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ + # @section -- UnifiedPush replicaCount: 1 image: + # -- image registry (could be overwritten by global.image.registry) + # @section -- UnifiedPush registry: docker.io + # -- image repository + # @section -- UnifiedPush repository: unifiedpush/common-proxies + # -- This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) + # @section -- UnifiedPush pullPolicy: IfNotPresent + # -- image tag + # @section -- UnifiedPush tag: "v2.2.0" config: @@ -284,11 +333,13 @@ unifiedPush: enable: true allowedHosts: [] - # This is for setting Kubernetes Annotations to a Pod. + # -- This is for setting Kubernetes Annotations to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ + # @section -- UnifiedPush podAnnotations: {} - # This is for setting Kubernetes Labels to a Pod. + # -- This is for setting Kubernetes Labels to a Pod. # For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + # @section -- UnifiedPush podLabels: {} nodeSelector: {} @@ -310,9 +361,11 @@ unifiedPush: # This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ service: - # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # -- This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + # @section -- UnifiedPush type: ClusterIP - # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + # -- This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + # @section -- UnifiedPush port: 80 # -- We usually recommend not to specify default resources and to leave this as a conscious @@ -325,13 +378,17 @@ unifiedPush: # requests: # cpu: 100m # memory: 128Mi + # @section -- UnifiedPush resources: {} - # -- 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/ + # -- 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/ + # @section -- UnifiedPush livenessProbe: 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/ + # @section -- UnifiedPush readinessProbe: httpGet: path: /health @@ -341,19 +398,24 @@ unifiedPush: # - name: foo # mountPath: "/etc/foo" # readOnly: true + # @section -- UnifiedPush volumeMounts: [] # This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ serviceAccount: - # Specifies whether a service account should be created + # -- Specifies whether a service account should be created + # @section -- UnifiedPush create: true - # Automatically mount a ServiceAccount's API credentials? + # -- Automatically mount a ServiceAccount's API credentials? + # @section -- UnifiedPush automount: true - # Annotations to add to the service account + # -- Annotations to add to the service account + # @section -- UnifiedPush annotations: {} - # The name of the service account to use. + # -- The name of the service account to use. # If not set and create is true, a name is generated using the fullname template + # @section -- UnifiedPush name: "" # This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/