Hookshot optionals (#823)

* Make breaking optionals empty

* Make optionals undefined

* Changelog

* Comment out top level

* Widgets are optional too

* Update 821.misc

---------

Co-authored-by: Will Hunt <will@half-shot.uk>

changelog.d/821.misc

@@ -0,0 +1 @@
+Do not populate optional values in default helm config, as default values are not valid.

helm/hookshot/values.yaml

@@ -126,67 +126,67 @@ hookshot:
       mediaUrl: https://example.com
       port: 9993
       bindAddress: 127.0.0.1
-    github:
+    # github:
       # (Optional) Configure this to enable GitHub support
       #
-      auth:
+      # auth:
         # Authentication for the GitHub App.
         #
-        id: 123
-        privateKeyFile: github-key.pem
-      webhook:
+      #   id: 123
+      #   privateKeyFile: github-key.pem
+      # webhook:
         # Webhook settings for the GitHub app.
         #
-        secret: secrettoken
-      oauth:
+        # secret: secrettoken
+      # oauth:
         # (Optional) Settings for allowing users to sign in via OAuth.
         #
-        client_id: foo
-        client_secret: bar
-        redirect_uri: https://example.com/bridge_oauth/
-      defaultOptions:
+        # client_id: foo
+        # client_secret: bar
+        # redirect_uri: https://example.com/bridge_oauth/
+      # defaultOptions:
         # (Optional) Default options for GitHub connections.
         #
-        showIssueRoomLink: false
-        hotlinkIssues:
-          prefix: "#"
-      userIdPrefix: _github_
+        # showIssueRoomLink: false
+        # hotlinkIssues:
+          # prefix: "#"
+      # userIdPrefix: _github_
       # (Optional) Prefix used when creating ghost users for GitHub accounts.
       #
-    gitlab:
+    # gitlab:
       # (Optional) Configure this to enable GitLab support
       #
-      instances:
-        gitlab.com:
-          url: https://gitlab.com
-      webhook:
-        secret: secrettoken
-        publicUrl: https://example.com/hookshot/
-      userIdPrefix: _gitlab_
+      # instances:
+        # gitlab.com:
+          # url: https://gitlab.com
+      # webhook:
+        # secret: secrettoken
+        # publicUrl: https://example.com/hookshot/
+      # userIdPrefix: _gitlab_
       # (Optional) Prefix used when creating ghost users for GitLab accounts.
       #
-    figma:
+    # figma:
       # (Optional) Configure this to enable Figma support
       #
-      publicUrl: https://example.com/hookshot/
-      instances:
-        your-instance:
-          teamId: your-team-id
-          accessToken: your-personal-access-token
-          passcode: your-webhook-passcode
-    jira:
+      # publicUrl: https://example.com/hookshot/
+      # instances:
+        # your-instance:
+          # teamId: your-team-id
+          # accessToken: your-personal-access-token
+          # passcode: your-webhook-passcode
+    # jira:
       # (Optional) Configure this to enable Jira support. Only specify `url` if you are using a On Premise install (i.e. not atlassian.com)
       #
-      webhook:
+      # webhook:
         # Webhook settings for JIRA
         #
-        secret: secrettoken
-      oauth:
+        # secret: secrettoken
+      # oauth:
         # (Optional) OAuth settings for connecting users to JIRA. See documentation for more information
         #
-        client_id: foo
-        client_secret: bar
-        redirect_uri: https://example.com/bridge_oauth/
+        # client_id: foo
+        # client_secret: bar
+        # redirect_uri: https://example.com/bridge_oauth/
     generic:
       # (Optional) Support for generic webhook events.
       #'allowJsTransformationFunctions' will allow users to write short transformation snippets in code, and thus is unsafe in untrusted environments
@@ -204,81 +204,81 @@ hookshot:
       enabled: false
       pollIntervalSeconds: 600
       pollTimeoutSeconds: 30
-    provisioning:
+    # provisioning:
       # (Optional) Provisioning API for integration managers
       #
-      secret: "!secretToken"
+      # secret: "!secretToken"
     passFile: passkey.pem
     # A passkey used to encrypt tokens stored inside the bridge.
     # Run openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:4096 to generate
     #
-    bot:
+    # bot:
       # (Optional) Define profile information for the bot user
       #
-      displayname: Hookshot Bot
-      avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
-    serviceBots:
+      # displayname: Hookshot Bot
+      # avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
+    # serviceBots:
       # (Optional) Define additional bot users for specific services
       #
-      - localpart: feeds
-        displayname: Feeds
-        avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
-        prefix: "!feeds"
-        service: feeds
+      # - localpart: feeds
+      #   displayname: Feeds
+      #   avatar: mxc://half-shot.uk/2876e89ccade4cb615e210c458e2a7a6883fe17d
+      #   prefix: "!feeds"
+      #   service: feeds
     metrics:
       # (Optional) Prometheus metrics support
       #
       enabled: true
-    queue:
+    # queue:
       # (Optional) Message queue / cache configuration options for large scale deployments.
       # For encryption to work, must be set to monolithic mode and have a host & port specified.
       #
-      monolithic: true
-      port: 6379
-      host: localhost
+      # monolithic: true
+      # port: 6379
+      # host: localhost
     logging:
       # (Optional) Logging settings. You can have a severity debug,info,warn,error
       #
       level: info
       colorize: true
       json: false
       timestampFormat: HH:mm:ss:SSS
-    widgets:
+    # widgets:
       # (Optional) EXPERIMENTAL support for complimentary widgets
       #
-      addToAdminRooms: false
-      disallowedIpRanges:
-        - 127.0.0.0/8
-        - 10.0.0.0/8
-        - 172.16.0.0/12
-        - 192.168.0.0/16
-        - 100.64.0.0/10
-        - 192.0.0.0/24
-        - 169.254.0.0/16
-        - 192.88.99.0/24
-        - 198.18.0.0/15
-        - 192.0.2.0/24
-        - 198.51.100.0/24
-        - 203.0.113.0/24
-        - 224.0.0.0/4
-        - ::1/128
-        - fe80::/10
-        - fc00::/7
-        - 2001:db8::/32
-        - ff00::/8
-        - fec0::/10
-      roomSetupWidget:
-        addOnInvite: false
-      publicUrl: https://example.com/widgetapi/v1/static/
-      branding:
-        widgetTitle: Hookshot Configuration
-    permissions:
+      # addToAdminRooms: false
+      # disallowedIpRanges:
+        # - 127.0.0.0/8
+        # - 10.0.0.0/8
+        # - 172.16.0.0/12
+        # - 192.168.0.0/16
+        # - 100.64.0.0/10
+        # - 192.0.0.0/24
+        # - 169.254.0.0/16
+        # - 192.88.99.0/24
+        # - 198.18.0.0/15
+        # - 192.0.2.0/24
+        # - 198.51.100.0/24
+        # - 203.0.113.0/24
+        # - 224.0.0.0/4
+        # - ::1/128
+        # - fe80::/10
+        # - fc00::/7
+        # - 2001:db8::/32
+        # - ff00::/8
+        # - fec0::/10
+      # roomSetupWidget:
+        # addOnInvite: false
+      # publicUrl: https://example.com/widgetapi/v1/static/
+      # branding:
+        # widgetTitle: Hookshot Configuration
+    # permissions:
       # (Optional) Permissions for using the bridge. See docs/setup.md#permissions for help
       #
-      - actor: example.com
-        services:
-          - service: "*"
-            level: admin
+      # - actor: example.com
+      #   services:
+      #     - service: "*"
+      #       level: admin
     listeners:
       # (Optional) HTTP Listener configuration.
       # Bind resource endpoints to ports and addresses.