Merge pull request #11 from small-hack/fix-pixelfed-templating-issues

fix valkey templating issues, add more docs

charts/pixelfed/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.3.2
+version: 0.3.3
 
 # This is the version number of the application being deployed.
 # renovate:image=ghcr.io/mattlqx/docker-pixelfed

charts/pixelfed/README.md

@@ -1,6 +1,6 @@
 # pixelfed
 
-![Version: 0.3.2](https://img.shields.io/badge/Version-0.3.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.12.3-nginx](https://img.shields.io/badge/AppVersion-v0.12.3--nginx-informational?style=flat-square)
+![Version: 0.3.3](https://img.shields.io/badge/Version-0.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.12.3-nginx](https://img.shields.io/badge/AppVersion-v0.12.3--nginx-informational?style=flat-square)
 
 A Helm chart for deploying Pixelfed on Kubernetes
 
@@ -66,7 +66,7 @@ A Helm chart for deploying Pixelfed on Kubernetes
 | nameOverride | string | `""` | This is to override the chart name. |
 | nodeSelector | object | `{}` |  |
 | pixelfed.account_deletion | bool | `true` | Enable account deletion (may be a requirement in some jurisdictions) |
-| pixelfed.activity_pub.enabled | bool | `false` |  |
+| pixelfed.activity_pub.enabled | bool | `false` | enable ActivityPub |
 | pixelfed.activity_pub.inbox | bool | `false` |  |
 | pixelfed.activity_pub.outbox | bool | `false` |  |
 | pixelfed.activity_pub.remote_follow | bool | `false` |  |
@@ -99,18 +99,18 @@ A Helm chart for deploying Pixelfed on Kubernetes
 | pixelfed.instance.reports.email_enabled | bool | `false` | Send a report email to the admin account for new autospam/reports |
 | pixelfed.instance.show_peers | bool | `false` | Enable the api/v1/peers API endpoint |
 | pixelfed.mail.driver | string | `"smtp"` | options: "smtp" (default), "sendmail", "mailgun", "mandrill", "ses" "sparkpost", "log", "array" |
-| pixelfed.mail.encryption | string | `"tls"` |  |
+| pixelfed.mail.encryption | string | `"tls"` | mail server encryption type |
 | pixelfed.mail.existingSecret | string | `""` | name of an existing Kubernetes Secret for mail credentials |
 | pixelfed.mail.existingSecretKeys.host | string | `""` | key in existing Kubernetes Secret for host. If set, ignores mail.host |
 | pixelfed.mail.existingSecretKeys.password | string | `""` | key in existing Kubernetes Secret for password. If set, ignores mail.password |
 | pixelfed.mail.existingSecretKeys.port | string | `""` | key in existing Kubernetes Secret for port. If set, ignores mail.port |
 | pixelfed.mail.existingSecretKeys.username | string | `""` | key in existing Kubernetes Secret for username. If set, ignores mail.username |
-| pixelfed.mail.from_address | string | `"pixelfed@example.com"` |  |
+| pixelfed.mail.from_address | string | `"pixelfed@example.com"` | address to use for sending emails |
-| pixelfed.mail.from_name | string | `"Pixelfed"` |  |
+| pixelfed.mail.from_name | string | `"Pixelfed"` | name to use for sending emails |
 | pixelfed.mail.host | string | `"smtp.mailtrap.io"` |  |
-| pixelfed.mail.password | string | `""` |  |
+| pixelfed.mail.password | string | `""` | mail server password |
-| pixelfed.mail.port | int | `2525` |  |
+| pixelfed.mail.port | int | `2525` | mail server port |
-| pixelfed.mail.username | string | `""` |  |
+| pixelfed.mail.username | string | `""` | mail server username |
 | pixelfed.max_account_size | int | `1000000` | The max allowed account size in KB |
 | pixelfed.max_album_length | int | `6` | The max number of media per post album |
 | pixelfed.max_avatar_size | int | `2000` | The max user avatar size in KB |
@@ -192,4 +192,4 @@ A Helm chart for deploying Pixelfed on Kubernetes
 | volumes | list | `[]` | Additional volumes on the output Deployment definition. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

charts/pixelfed/templates/deployment.yaml

@@ -190,12 +190,16 @@ spec:
               value: {{ printf "%s-primary" (.Values.valkey.fullnameOverride) }}
               {{- end }}
             - name: REDIS_PORT
+              {{- if .Values.externalValkey }}
               {{- if .Values.externalValkey.existingSecret }}
               valueFrom:
                 secretKeyRef:
                   name: {{ .Values.externalValkey.existingSecret }}
                   key: {{ .Values.externalValkey.existingSecretKeys.port }}
               {{- else }}
+              value: {{ .Values.externalValkey.port }}
+              {{- end }}
+              {{- else }}
               value: {{ .Values.valkey.primary.service.ports.valkey | quote }}
               {{- end }}
             - name: REDIS_PASSWORD

charts/pixelfed/values.yaml

@@ -375,6 +375,7 @@ pixelfed:
 
   # ActivityPub Configuration
   activity_pub:
+    # -- enable ActivityPub
     enabled: false
     remote_follow: false
     inbox: false
@@ -399,11 +400,17 @@ pixelfed:
     # "sparkpost", "log", "array"
     driver: smtp
     host: smtp.mailtrap.io
+    # -- mail server port
     port: 2525
+    # -- mail server username
     username: ""
+    # -- mail server password
     password: ""
+    # -- mail server encryption type
     encryption: "tls"
+    # -- address to use for sending emails
     from_address: "pixelfed@example.com"
+    # -- name to use for sending emails
     from_name: "Pixelfed"
     # -- name of an existing Kubernetes Secret for mail credentials
     existingSecret: ""