diff --git a/incubator/synapse/0.0.1/CHANGELOG.md b/incubator/synapse/0.0.1/CHANGELOG.md
new file mode 100644
index 00000000000..115b146c5e4
--- /dev/null
+++ b/incubator/synapse/0.0.1/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+
+
+### synapse-0.0.1 (2022-01-23)
+
+#### Feat
+
+* add synapse ([#1768](https://github.com/truecharts/apps/issues/1768))
+
diff --git a/incubator/synapse/0.0.1/CONFIG.md b/incubator/synapse/0.0.1/CONFIG.md
new file mode 100644
index 00000000000..fc9b2fa2d5f
--- /dev/null
+++ b/incubator/synapse/0.0.1/CONFIG.md
@@ -0,0 +1,8 @@
+# Configuration Options
+
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
+https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.
diff --git a/incubator/synapse/0.0.1/Chart.lock b/incubator/synapse/0.0.1/Chart.lock
new file mode 100644
index 00000000000..6cc62d74e88
--- /dev/null
+++ b/incubator/synapse/0.0.1/Chart.lock
@@ -0,0 +1,9 @@
+dependencies:
+- name: common
+ repository: https://truecharts.org
+ version: 8.14.1
+- name: postgresql
+ repository: https://truecharts.org/
+ version: 6.0.56
+digest: sha256:42e0947ed3ace4c471cbd33da0f4e1dc99404b9e405163e5e7451917aaaecb28
+generated: "2022-01-23T23:23:37.27707394Z"
diff --git a/incubator/synapse/0.0.1/Chart.yaml b/incubator/synapse/0.0.1/Chart.yaml
new file mode 100644
index 00000000000..cdbcc44e71b
--- /dev/null
+++ b/incubator/synapse/0.0.1/Chart.yaml
@@ -0,0 +1,32 @@
+apiVersion: v2
+appVersion: "1.50.1"
+dependencies:
+- name: common
+ repository: https://truecharts.org
+ version: 8.14.1
+- condition: postgresql.enabled
+ name: postgresql
+ repository: https://truecharts.org/
+ version: 6.0.56
+deprecated: false
+description: A Helm chart to deploy a Matrix homeserver stack into Kubernetes
+home: https://github.com/truecharts/apps/charts/stable/synapse
+icon: https://truecharts.org/_static/img/appicons/synapse-icon.png
+keywords:
+- chat
+- matrix
+- synapse
+kubeVersion: '>=1.16.0-0'
+maintainers:
+- email: info@truecharts.org
+ name: TrueCharts
+ url: https://truecharts.org
+name: synapse
+sources: []
+type: application
+version: 0.0.1
+annotations:
+ truecharts.org/catagories: |
+ - cloud
+ truecharts.org/SCALE-support: "true"
+ truecharts.org/grade: U
diff --git a/incubator/synapse/0.0.1/README.md b/incubator/synapse/0.0.1/README.md
new file mode 100644
index 00000000000..c24e7dcad2e
--- /dev/null
+++ b/incubator/synapse/0.0.1/README.md
@@ -0,0 +1,34 @@
+# Introduction
+
+A Helm chart to deploy a Matrix homeserver stack into Kubernetes
+
+TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://truecharts.org/ | postgresql | 6.0.56 |
+| https://truecharts.org | common | 8.14.1 |
+
+## Installing the Chart
+
+To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
+
+## Uninstalling the Chart
+
+To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
+
+## Support
+
+- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
+- See the [Wiki](https://truecharts.org)
+- Check our [Discord](https://discord.gg/tVsPTHWTtr)
+- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
+---
+All Rights Reserved - The TrueCharts Project
diff --git a/incubator/synapse/0.0.1/app-readme.md b/incubator/synapse/0.0.1/app-readme.md
new file mode 100644
index 00000000000..8fc105683b7
--- /dev/null
+++ b/incubator/synapse/0.0.1/app-readme.md
@@ -0,0 +1,3 @@
+A Helm chart to deploy a Matrix homeserver stack into Kubernetes
+
+This App is supplied by TrueCharts, for more information please visit https://truecharts.org
diff --git a/incubator/synapse/0.0.1/charts/common-8.14.1.tgz b/incubator/synapse/0.0.1/charts/common-8.14.1.tgz
new file mode 100644
index 00000000000..8e6b665d8ad
Binary files /dev/null and b/incubator/synapse/0.0.1/charts/common-8.14.1.tgz differ
diff --git a/incubator/synapse/0.0.1/charts/postgresql-6.0.56.tgz b/incubator/synapse/0.0.1/charts/postgresql-6.0.56.tgz
new file mode 100644
index 00000000000..81a274008eb
Binary files /dev/null and b/incubator/synapse/0.0.1/charts/postgresql-6.0.56.tgz differ
diff --git a/incubator/synapse/0.0.1/ci/base-values.yaml b/incubator/synapse/0.0.1/ci/base-values.yaml
new file mode 100644
index 00000000000..7e5ba36f000
--- /dev/null
+++ b/incubator/synapse/0.0.1/ci/base-values.yaml
@@ -0,0 +1,5 @@
+matrix:
+ # Hostname where Synapse can be reached.
+ # This is *optional* if an Ingress is configured below. If hostname is unspecified, the Synapse hostname of the
+ # Ingress will be used
+ hostname: "matrix.example.com"
diff --git a/incubator/synapse/0.0.1/ci/basic-values.yaml b/incubator/synapse/0.0.1/ci/basic-values.yaml
new file mode 100644
index 00000000000..7e5ba36f000
--- /dev/null
+++ b/incubator/synapse/0.0.1/ci/basic-values.yaml
@@ -0,0 +1,5 @@
+matrix:
+ # Hostname where Synapse can be reached.
+ # This is *optional* if an Ingress is configured below. If hostname is unspecified, the Synapse hostname of the
+ # Ingress will be used
+ hostname: "matrix.example.com"
diff --git a/incubator/synapse/0.0.1/helm-values.md b/incubator/synapse/0.0.1/helm-values.md
new file mode 100644
index 00000000000..928479e0917
--- /dev/null
+++ b/incubator/synapse/0.0.1/helm-values.md
@@ -0,0 +1,123 @@
+# Default Helm-Values
+
+TrueCharts is primarily build to supply TrueNAS SCALE Apps.
+However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
+
+Most of our Apps also consume our "common" Helm Chart.
+If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
+You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| command[0] | string | `"sh"` | |
+| command[1] | string | `"-c"` | |
+| command[2] | string | `"exec python -B -m synapse.app.homeserver \\\n -c /data/homeserver.yaml \\\n -c /data/secret/secret.yaml \\\n -c /data/custom.yaml\n"` | |
+| coturn.enabled | bool | `false` | |
+| env | object | `{}` | |
+| image.pullPolicy | string | `"IfNotPresent"` | |
+| image.repository | string | `"matrixdotorg/synapse"` | |
+| image.tag | string | `"v1.50.1"` | |
+| installContainers.generate-signing-key.args[0] | string | `"-m"` | |
+| installContainers.generate-signing-key.args[1] | string | `"synapse.app.homeserver"` | |
+| installContainers.generate-signing-key.args[2] | string | `"--config-path"` | |
+| installContainers.generate-signing-key.args[3] | string | `"/data/homeserver.yaml"` | |
+| installContainers.generate-signing-key.args[4] | string | `"--keys-directory"` | |
+| installContainers.generate-signing-key.args[5] | string | `"/data/keys"` | |
+| installContainers.generate-signing-key.args[6] | string | `"--generate-keys"` | |
+| installContainers.generate-signing-key.command[0] | string | `"python"` | |
+| installContainers.generate-signing-key.env[0].name | string | `"SYNAPSE_SERVER_NAME"` | |
+| installContainers.generate-signing-key.env[0].value | string | `"{{ .Values.matrix.serverName }}"` | |
+| installContainers.generate-signing-key.env[1].name | string | `"SYNAPSE_REPORT_STATS"` | |
+| installContainers.generate-signing-key.env[1].value | string | `"no"` | |
+| installContainers.generate-signing-key.image | string | `"{{ .Values.image.repository }}:{{ .Values.image.tag }}"` | |
+| installContainers.generate-signing-key.volumeMounts[0].mountPath | string | `"/data"` | |
+| installContainers.generate-signing-key.volumeMounts[0].name | string | `"config"` | |
+| installContainers.generate-signing-key.volumeMounts[1].mountPath | string | `"/data/secret"` | |
+| installContainers.generate-signing-key.volumeMounts[1].name | string | `"secret"` | |
+| installContainers.generate-signing-key.volumeMounts[2].mountPath | string | `"/data/keys"` | |
+| installContainers.generate-signing-key.volumeMounts[2].name | string | `"key"` | |
+| mail.enabled | bool | `false` | |
+| mail.from | string | `"Matrix "` | |
+| mail.host | string | `""` | |
+| mail.password | string | `""` | |
+| mail.port | int | `25` | |
+| mail.requireTransportSecurity | bool | `true` | |
+| mail.riotUrl | string | `""` | |
+| mail.username | string | `""` | |
+| matrix.adminEmail | string | `"admin@example.com"` | |
+| matrix.blockNonAdminInvites | bool | `false` | |
+| matrix.disabled | bool | `false` | |
+| matrix.disabledMessage | string | `""` | |
+| matrix.encryptByDefault | string | `"invite"` | |
+| matrix.federation.allowPublicRooms | bool | `true` | |
+| matrix.federation.blacklist[0] | string | `"127.0.0.0/8"` | |
+| matrix.federation.blacklist[1] | string | `"10.0.0.0/8"` | |
+| matrix.federation.blacklist[2] | string | `"172.16.0.0/12"` | |
+| matrix.federation.blacklist[3] | string | `"192.168.0.0/16"` | |
+| matrix.federation.blacklist[4] | string | `"100.64.0.0/10"` | |
+| matrix.federation.blacklist[5] | string | `"169.254.0.0/16"` | |
+| matrix.federation.blacklist[6] | string | `"::1/128"` | |
+| matrix.federation.blacklist[7] | string | `"fe80::/64"` | |
+| matrix.federation.blacklist[8] | string | `"fc00::/7"` | |
+| matrix.federation.enabled | bool | `true` | |
+| matrix.logging.rootLogLevel | string | `"WARNING"` | |
+| matrix.logging.sqlLogLevel | string | `"WARNING"` | |
+| matrix.logging.synapseLogLevel | string | `"WARNING"` | |
+| matrix.presence | bool | `true` | |
+| matrix.registration.allowGuests | bool | `false` | |
+| matrix.registration.autoJoinRooms | list | `[]` | |
+| matrix.registration.enabled | bool | `false` | |
+| matrix.retentionPeriod | string | `"7d"` | |
+| matrix.search | bool | `true` | |
+| matrix.security.surpressKeyServerWarning | bool | `true` | |
+| matrix.serverName | string | `"example.com"` | |
+| matrix.uploads.maxPixels | string | `"32M"` | |
+| matrix.uploads.maxSize | string | `"10M"` | |
+| matrix.urlPreviews.enabled | bool | `false` | |
+| persistence.config.enabled | bool | `true` | |
+| persistence.config.mountPath | string | `"/data"` | |
+| persistence.config.objectName | string | `"synapse-config"` | |
+| persistence.config.readOnly | bool | `false` | |
+| persistence.config.type | string | `"configMap"` | |
+| persistence.key.enabled | bool | `true` | |
+| persistence.key.mountPath | string | `"/data/keys"` | |
+| persistence.media.enabled | bool | `true` | |
+| persistence.media.mountPath | string | `"/data/media_store"` | |
+| persistence.secret.enabled | bool | `true` | |
+| persistence.secret.mountPath | string | `"/data/secret"` | |
+| persistence.secret.objectName | string | `"synapse-secret"` | |
+| persistence.secret.readOnly | bool | `false` | |
+| persistence.secret.type | string | `"secret"` | |
+| persistence.uploads.enabled | bool | `true` | |
+| persistence.uploads.mountPath | string | `"/uploads"` | |
+| postgresql.enabled | bool | `true` | |
+| postgresql.env.POSTGRES_INITDB_ARGS | string | `"--encoding=UTF8 --locale=C"` | |
+| postgresql.existingSecret | string | `"dbcreds"` | |
+| postgresql.postgresqlDatabase | string | `"synapse"` | |
+| postgresql.postgresqlUsername | string | `"synapse"` | |
+| probes.liveness.path | string | `"/health"` | |
+| probes.readiness.path | string | `"/health"` | |
+| probes.startup.path | string | `"/health"` | |
+| secret | object | `{}` | |
+| securityContext.allowPrivilegeEscalation | bool | `true` | |
+| securityContext.readOnlyRootFilesystem | bool | `true` | |
+| securityContext.runAsNonRoot | bool | `true` | |
+| service.main.ports.main.port | int | `8008` | |
+| service.main.ports.main.targetPort | int | `8008` | |
+| service.metrics.enabled | bool | `true` | |
+| service.metrics.ports.metrics.enabled | bool | `true` | |
+| service.metrics.ports.metrics.port | int | `9090` | |
+| service.metrics.ports.metrics.targetPort | int | `9090` | |
+| service.replication.enabled | bool | `true` | |
+| service.replication.ports.replication.enabled | bool | `true` | |
+| service.replication.ports.replication.port | int | `9092` | |
+| service.replication.ports.replication.targetPort | int | `9092` | |
+| synapse.appConfig | list | `[]` | List of application config .yaml files to be loaded from /appConfig |
+| synapse.loadCustomConfig | bool | `false` | |
+| synapse.metrics.annotations | bool | `true` | |
+| synapse.metrics.enabled | bool | `true` | |
+| synapse.metrics.port | int | `9092` | |
+
+All Rights Reserved - The TrueCharts Project
diff --git a/incubator/synapse/0.0.1/ix_values.yaml b/incubator/synapse/0.0.1/ix_values.yaml
new file mode 100644
index 00000000000..525c2421065
--- /dev/null
+++ b/incubator/synapse/0.0.1/ix_values.yaml
@@ -0,0 +1,313 @@
+image:
+ repository: matrixdotorg/synapse
+ pullPolicy: IfNotPresent
+ tag: v1.50.1
+
+command:
+ - sh
+ - -c
+ - |
+ exec python -B -m synapse.app.homeserver \
+ -c /data/homeserver.yaml \
+ -c /data/secret/secret.yaml \
+ -c /data/custom.yaml
+
+service:
+ main:
+ ports:
+ main:
+ port: 8008
+ targetPort: 8008
+ replication:
+ enabled: true
+ ports:
+ replication:
+ enabled: true
+ port: 9092
+ targetPort: 9092
+ metrics:
+ enabled: true
+ ports:
+ metrics:
+ enabled: true
+ port: 9090
+ targetPort: 9090
+
+securityContext:
+ readOnlyRootFilesystem: true
+ allowPrivilegeEscalation: true
+ runAsNonRoot: true
+
+secret: {}
+
+installContainers:
+ generate-signing-key:
+ image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+ env:
+ - name: SYNAPSE_SERVER_NAME
+ value: "{{ .Values.matrix.serverName }}"
+ - name: SYNAPSE_REPORT_STATS
+ value: "no"
+ command: ["python"]
+ args:
+ - "-m"
+ - "synapse.app.homeserver"
+ - "--config-path"
+ - "/data/homeserver.yaml"
+ - "--keys-directory"
+ - "/data/keys"
+ - "--generate-keys"
+ volumeMounts:
+ - name: config
+ mountPath: /data
+ - name: secret
+ mountPath: /data/secret
+ - name: key
+ mountPath: /data/keys
+
+env: {}
+
+persistence:
+ config:
+ enabled: true
+ type: configMap
+ objectName: synapse-config
+ mountPath: /data
+ readOnly: false
+ secret:
+ enabled: true
+ type: secret
+ objectName: synapse-secret
+ mountPath: /data/secret
+ readOnly: false
+ key:
+ enabled: true
+ mountPath: "/data/keys"
+ media:
+ enabled: true
+ mountPath: "/data/media_store"
+ uploads:
+ enabled: true
+ mountPath: "/uploads"
+
+probes:
+ liveness:
+ path: /health
+
+ readiness:
+ path: /health
+
+ startup:
+ path: /health
+
+# Synapse Kubernetes resource settings
+synapse:
+ loadCustomConfig: false
+ # -- List of application config .yaml files to be loaded from /appConfig
+ appConfig: []
+ # Prometheus metrics for Synapse
+ # https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md
+ metrics:
+ # Whether Synapse should capture metrics on an additional endpoint
+ enabled: true
+ # Port to listen on for metrics scraping
+ port: 9092
+ annotations: true
+
+# Runtime configuration for Synapse and settings related to the Matrix protocol
+matrix:
+ # Manual overrides for homeserver.yaml, the main configuration file for Synapse
+ # If homeserverOverride is set, the entirety of homeserver.yaml will be replaced with the contents.
+ # If homeserverExtra is set, the contents will be appended to the end of the default configuration.
+ # It is highly recommended that you take a look at the defaults in templates/synapse/_homeserver.yaml, to get a sense
+ # of the requirements and default configuration options to use other services in this chart.
+ # homeserverOverride: {}
+ # homeserverExtra: {}
+
+ # Domain name of the server
+ # This is not necessarily the host name where the service is reachable. In fact, you may want to omit any subdomains
+ # from this value as the server name set here will be the name of your homeserver in the fediverse, and will be the
+ # domain name at the end of every user's username
+ serverName: "example.com"
+
+ urlPreviews:
+ enabled: false
+
+ # Hostname where Synapse can be reached.
+ # This is *optional* if an Ingress is configured below. If hostname is unspecified, the Synapse hostname of the
+ # Ingress will be used
+ # hostname: "matrix.example.com"
+
+ # Set to false to disable presence (online/offline indicators)
+ presence: true
+
+ # Set to true to block non-admins from inviting users to any rooms
+ blockNonAdminInvites: false
+
+ # Set to false to disable message searching
+ search: true
+
+ # Which types of rooms to enable end-to-end encryption on by default
+ # off: none
+ # invite: private messages, or rooms created with the private_chat or trusted_private_chat room preset
+ # all: all rooms
+ encryptByDefault: invite
+
+ # Email address of the administrator
+ adminEmail: "admin@example.com"
+
+ # Settings related to image and multimedia uploads
+ uploads:
+ # Max upload size in bytes
+ maxSize: 10M
+
+ # Max image size in pixels
+ maxPixels: 32M
+
+ # Settings related to federation
+ federation:
+ # Set to false to disable federation and run an isolated homeserver
+ enabled: true
+
+ # Set to false to disallow members of other homeservers from fetching *public* rooms
+ allowPublicRooms: true
+
+ # Whitelist of domains to federate with (comment for all domains except blacklisted)
+ # whitelist: []
+
+ # IP addresses to blacklist federation requests to
+ blacklist:
+ - '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'
+ - '169.254.0.0/16'
+ - '::1/128'
+ - 'fe80::/64'
+ - 'fc00::/7'
+
+ # User registration settings
+ registration:
+ # Allow new users to register an account
+ enabled: false
+
+ # If set, allows registration of standard or admin accounts by anyone who
+ # has the shared secret, even if registration is otherwise disabled.
+ #
+ # sharedSecret:
+
+ # Allow users to join rooms as a guest
+ allowGuests: false
+
+ # Required "3PIDs" - third-party identifiers such as email or msisdn (SMS)
+ # required3Pids:
+ # - email
+ # - msisdn
+
+ # Rooms to automatically join all new users to
+ autoJoinRooms: []
+ # - "#welcome:example.com"
+
+ # How long to keep redacted events in unredacted form in the database
+ retentionPeriod: 7d
+
+ security:
+ # a secret which is used to sign access tokens. If none is specified,
+ # the registration_shared_secret is used, if one is given; otherwise,
+ # a secret key is derived from the signing key.
+ #
+ # macaroonSecretKey:
+
+ # This disables the warning that is emitted when the
+ # trustedKeyServers include 'matrix.org'. See below.
+ # Set to false to re-enable the warning.
+ #
+ surpressKeyServerWarning: true
+
+ # The trusted servers to download signing keys from.
+ #
+ # When we need to fetch a signing key, each server is tried in parallel.
+ #
+ # Normally, the connection to the key server is validated via TLS certificates.
+ # Additional security can be provided by configuring a `verify key`, which
+ # will make synapse check that the response is signed by that key.
+ #
+ # This setting supercedes an older setting named `perspectives`. The old format
+ # is still supported for backwards-compatibility, but it is deprecated.
+ #
+ # 'trustedKeyServers' defaults to matrix.org, but using it will generate a
+ # warning on start-up. To suppress this warning, set
+ # 'surpressKeyServerWarning' to true.
+ #
+ # Options for each entry in the list include:
+ #
+ # serverName: the name of the server. required.
+ #
+ # verifyKeys: an optional map from key id to base64-encoded public key.
+ # If specified, we will check that the response is signed by at least
+ # one of the given keys.
+ #
+ # acceptKeysInsecurely: a boolean. Normally, if `verify_keys` is unset,
+ # and federation_verify_certificates is not `true`, synapse will refuse
+ # to start, because this would allow anyone who can spoof DNS responses
+ # to masquerade as the trusted key server. If you know what you are doing
+ # and are sure that your network environment provides a secure connection
+ # to the key server, you can set this to `true` to override this
+ # behaviour.
+ #
+ # An example configuration might look like:
+ #
+ # trustedKeyServers:
+ # - serverName: my_trusted_server.example.com
+ # verifyKeys:
+ # - id: "ed25519:auto"
+ # key: "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
+ # acceptKeysInsecurely: false
+ # - serverName: my_other_trusted_server.example.com
+
+ # Set to true to globally block access to the homeserver
+ disabled: false
+ # Human readable reason for why the homeserver is blocked
+ disabledMessage: ""
+
+ logging:
+ # Root log level is the default log level for log outputs that do not have more
+ # specific settings.
+ rootLogLevel: WARNING
+ # beware: increasing this to DEBUG will make synapse log sensitive
+ # information such as access tokens.
+ sqlLogLevel: WARNING
+ # The log level for the synapse server
+ synapseLogLevel: WARNING
+
+
+# Settings for email notifications
+mail:
+ # Set to false to disable all email notifications
+ # NOTE: If enabled, either enable the Exim relay or configure an external mail server below
+ enabled: false
+ # Name and email address for outgoing mail
+ from: "Matrix "
+ # Optional: Element instance URL.
+ # If the ingress is enabled, this is unnecessary.
+ # If the ingress is disabled and this is left unspecified, emails will contain a link to https://app.element.io
+ riotUrl: ""
+
+ host: ""
+ port: 25 # SSL: 465, STARTTLS: 587
+ username: ""
+ password: ""
+ requireTransportSecurity: true
+
+coturn:
+ enabled: false
+
+# Enabled postgres
+postgresql:
+ env:
+ POSTGRES_INITDB_ARGS: "--encoding=UTF8 --locale=C"
+ enabled: true
+ existingSecret: "dbcreds"
+ postgresqlUsername: synapse
+ postgresqlDatabase: synapse
diff --git a/incubator/synapse/0.0.1/questions.yaml b/incubator/synapse/0.0.1/questions.yaml
new file mode 100644
index 00000000000..ccffd8eb0ef
--- /dev/null
+++ b/incubator/synapse/0.0.1/questions.yaml
@@ -0,0 +1,2423 @@
+groups:
+ - name: "Container Image"
+ description: "Image to be used for container"
+ - name: "Controller"
+ description: "Configure workload deployment"
+ - name: "Container Configuration"
+ description: "additional container configuration"
+ - name: "App Configuration"
+ description: "App specific config options"
+ - name: "Networking and Services"
+ description: "Configure Network and Services for container"
+ - name: "Storage and Persistence"
+ description: "Persist and share data that is separate from the container"
+ - name: "Ingress"
+ description: "Ingress Configuration"
+ - name: "Security and Permissions"
+ description: "Configure security context and permissions"
+ - name: "Resources and Devices"
+ description: "Specify resources/devices to be allocated to workload"
+ - name: "Middlewares"
+ description: "Traefik Middlewares"
+ - name: "Metrics"
+ description: "Metrics"
+ - name: "Addons"
+ description: "Addon Configuration"
+ - name: "Advanced"
+ description: "Advanced Configuration"
+portals:
+ web_portal:
+ protocols:
+ - "$kubernetes-resource_configmap_portal_protocol"
+ host:
+ - "$kubernetes-resource_configmap_portal_host"
+ ports:
+ - "$kubernetes-resource_configmap_portal_port"
+questions:
+ - variable: portal
+ group: "Container Image"
+ label: "Configure Portal Button"
+ schema:
+ type: dict
+ hidden: true
+ attrs:
+ - variable: enabled
+ label: "Enable"
+ description: "enable the portal button"
+ schema:
+ hidden: true
+ editable: false
+ type: boolean
+ default: true
+ - variable: global
+ label: "global settings"
+ group: "Controller"
+ schema:
+ type: dict
+ hidden: true
+ attrs:
+ - variable: isSCALE
+ label: "flag this is SCALE"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: controller
+ group: "Controller"
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: advanced
+ label: "Show Advanced Controller Settings"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: type
+ description: "Please specify type of workload to deploy"
+ label: "(Advanced) Controller Type"
+ schema:
+ type: string
+ default: "deployment"
+ required: true
+ enum:
+ - value: "deployment"
+ description: "Deployment"
+ - value: "statefulset"
+ description: "Statefulset"
+ - value: "daemonset"
+ description: "Daemonset"
+ - variable: replicas
+ description: "Number of desired pod replicas"
+ label: "Desired Replicas"
+ schema:
+ type: int
+ default: 1
+ required: true
+ - variable: strategy
+ description: "Please specify type of workload to deploy"
+ label: "(Advanced) Update Strategy"
+ schema:
+ type: string
+ default: "Recreate"
+ required: true
+ enum:
+ - value: "Recreate"
+ description: "Recreate: Kill existing pods before creating new ones"
+ - value: "RollingUpdate"
+ description: "RollingUpdate: Create new pods and then kill old ones"
+ - value: "OnDelete"
+ description: "(Legacy) OnDelete: ignore .spec.template changes"
+ - variable: expert
+ label: "Show Expert Configuration Options"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: extraArgs
+ label: "Extra Args"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: arg
+ label: "arg"
+ schema:
+ type: string
+ - variable: labelsList
+ label: "Controller Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: labelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: annotationsList
+ label: " Controller Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: annotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: secret
+ group: "Container Configuration"
+ label: "Image Secrets"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: NEXTCLOUD_ADMIN_USER
+ label: "NEXTCLOUD_ADMIN_USER (First Install Only)"
+ description: "Sets the initial nextcloud's admin username, changing this variable after first launch will NOT change admin's username"
+ schema:
+ type: string
+ required: true
+ default: "REPLACETHIS"
+ - variable: NEXTCLOUD_ADMIN_PASSWORD
+ label: "NEXTCLOUD_ADMIN_PASSWORD (First Install Only)"
+ description: "Sets the initial nextcloud's admin password, changing this variable after first launch will NOT change admin's password"
+ schema:
+ type: string
+ private: true
+ required: true
+ default: "REPLACETHIS"
+ - variable: env
+ group: "Container Configuration"
+ label: "Image Environment"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: TZ
+ label: "Timezone"
+ schema:
+ type: string
+ default: "Etc/UTC"
+ $ref:
+ - "definitions/timezone"
+ - variable: UMASK
+ label: "UMASK"
+ description: "Sets the UMASK env var for LinuxServer.io (compatible) containers"
+ schema:
+ type: string
+ default: "002"
+ - variable: TRUSTED_PROXIES
+ label: "Trusted Proxies (Advanced)"
+ description: "Sets nextcloud Trusted Proxies"
+ schema:
+ type: string
+ default: "172.16.0.0/16"
+ - variable: NODE_IP
+ label: "NODE_IP"
+ description: "Sets nextcloud nodeip for nodeport connections (Ensure this is correct at first install!)"
+ schema:
+ type: string
+ $ref:
+ - "definitions/nodeIP"
+
+ - variable: envList
+ label: "Image environment"
+ group: "Container Configuration"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: envItem
+ label: "Environment Variable"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: expertpodconf
+ group: "Container Configuration"
+ label: "Show Expert Config"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: tty
+ label: "Enable TTY"
+ description: "Determines whether containers in a pod runs with TTY enabled. By default pod has it disabled."
+ group: "Workload Details"
+ schema:
+ type: boolean
+ default: false
+ - variable: stdin
+ label: "Enable STDIN"
+ description: "Determines whether containers in a pod runs with stdin enabled. By default pod has it disabled."
+ group: "Workload Details"
+ schema:
+ type: boolean
+ default: false
+ - variable: termination
+ group: "Container Configuration"
+ label: "Termination settings"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: gracePeriodSeconds
+ label: "Grace Period Seconds"
+ schema:
+ type: int
+ default: 10
+ - variable: podLabelsList
+ group: "Container Configuration"
+ label: "Pod Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: podLabelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: podAnnotationsList
+ group: "Container Configuration"
+ label: "Pod Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: podAnnotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: service
+ group: "Networking and Services"
+ label: "Configure Service(s)"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: main
+ label: "Main Service"
+ description: "The Primary service on which the healthcheck runs, often the webUI"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable the service"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: type
+ label: "Service Type"
+ description: "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
+ schema:
+ type: string
+ default: "Simple"
+ enum:
+ - value: "Simple"
+ description: "Simple"
+ - value: "ClusterIP"
+ description: "ClusterIP"
+ - value: "NodePort"
+ description: "NodePort (Advanced)"
+ - value: "LoadBalancer"
+ description: "LoadBalancer (Advanced)"
+ - variable: loadBalancerIP
+ label: "LoadBalancer IP"
+ description: "LoadBalancerIP"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: string
+ default: ""
+ - variable: externalIPs
+ label: "External IP's"
+ description: "External IP's"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: list
+ default: []
+ items:
+ - variable: externalIP
+ label: "External IP"
+ schema:
+ type: string
+ - variable: ipFamilyPolicy
+ label: "IP Family Policy"
+ description: "(Advanced) Specify the ip policy"
+ schema:
+ show_if: [["type", "!=", "Simple"]]
+ type: string
+ default: "SingleStack"
+ enum:
+ - value: "SingleStack"
+ description: "SingleStack"
+ - value: "PreferDualStack"
+ description: "PreferDualStack"
+ - value: "RequireDualStack"
+ description: "RequireDualStack"
+ - variable: ipFamilies
+ label: "(advanced) IP families"
+ description: "(advanced) The ip families that should be used"
+ schema:
+ show_if: [["type", "!=", "Simple"]]
+ type: list
+ default: []
+ items:
+ - variable: ipFamily
+ label: "IP family"
+ schema:
+ type: string
+ - variable: ports
+ label: "Service's Port(s) Configuration"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: main
+ label: "Main Service Port Configuration"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: port
+ label: "Port"
+ description: "This port exposes the container port on the service"
+ schema:
+ type: int
+ default: 10020
+ required: true
+ - variable: advanced
+ label: "Show Advanced settings"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: protocol
+ label: "Port Type"
+ schema:
+ type: string
+ default: "HTTP"
+ enum:
+ - value: HTTP
+ description: "HTTP"
+ - value: "HTTPS"
+ description: "HTTPS"
+ - value: TCP
+ description: "TCP"
+ - value: "UDP"
+ description: "UDP"
+ - variable: nodePort
+ label: "Node Port (Optional)"
+ description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer"
+ schema:
+ type: int
+ min: 9000
+ max: 65535
+ - variable: targetPort
+ label: "Target Port"
+ description: "The internal(!) port on the container the Application runs on"
+ schema:
+ type: int
+ default: 80
+
+ - variable: serviceexpert
+ group: "Networking and Services"
+ label: "Show Expert Config"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: hostNetwork
+ group: "Networking and Services"
+ label: "Host-Networking (Complicated)"
+ schema:
+ type: boolean
+ default: false
+
+ - variable: externalInterfaces
+ description: "Add External Interfaces"
+ label: "Add external Interfaces"
+ group: "Networking"
+ schema:
+ type: list
+ items:
+ - variable: interfaceConfiguration
+ description: "Interface Configuration"
+ label: "Interface Configuration"
+ schema:
+ type: dict
+ $ref:
+ - "normalize/interfaceConfiguration"
+ attrs:
+ - variable: hostInterface
+ description: "Please specify host interface"
+ label: "Host Interface"
+ schema:
+ type: string
+ required: true
+ $ref:
+ - "definitions/interface"
+ - variable: ipam
+ description: "Define how IP Address will be managed"
+ label: "IP Address Management"
+ schema:
+ type: dict
+ required: true
+ attrs:
+ - variable: type
+ description: "Specify type for IPAM"
+ label: "IPAM Type"
+ schema:
+ type: string
+ required: true
+ enum:
+ - value: "dhcp"
+ description: "Use DHCP"
+ - value: "static"
+ description: "Use static IP"
+ show_subquestions_if: "static"
+ subquestions:
+ - variable: staticIPConfigurations
+ label: "Static IP Addresses"
+ schema:
+ type: list
+ items:
+ - variable: staticIP
+ label: "Static IP"
+ schema:
+ type: ipaddr
+ cidr: true
+ - variable: staticRoutes
+ label: "Static Routes"
+ schema:
+ type: list
+ items:
+ - variable: staticRouteConfiguration
+ label: "Static Route Configuration"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: destination
+ label: "Destination"
+ schema:
+ type: ipaddr
+ cidr: true
+ required: true
+ - variable: gateway
+ label: "Gateway"
+ schema:
+ type: ipaddr
+ cidr: false
+ required: true
+
+ - variable: dnsPolicy
+ group: "Networking and Services"
+ label: "dnsPolicy"
+ schema:
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "ClusterFirst"
+ description: "ClusterFirst"
+ - value: "ClusterFirstWithHostNet"
+ description: "ClusterFirstWithHostNet"
+ - value: "None"
+ description: "None"
+
+ - variable: dnsConfig
+ label: "DNS Configuration"
+ group: "Networking and Services"
+ description: "Specify custom DNS configuration which will be applied to the pod"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: nameservers
+ label: "Nameservers"
+ schema:
+ default: []
+ type: list
+ items:
+ - variable: nameserver
+ label: "Nameserver"
+ schema:
+ type: string
+ - variable: options
+ label: "options"
+ schema:
+ default: []
+ type: list
+ items:
+ - variable: option
+ label: "Option Entry"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: searches
+ label: "Searches"
+ schema:
+ default: []
+ type: list
+ items:
+ - variable: search
+ label: "Search Entry"
+ schema:
+ type: string
+
+ - variable: serviceList
+ label: "Add Manual Custom Services"
+ group: "Networking and Services"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: serviceListEntry
+ label: "Custom Service"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable the service"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ default: ""
+ - variable: type
+ label: "Service Type"
+ description: "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
+ schema:
+ type: string
+ default: "Simple"
+ enum:
+ - value: "Simple"
+ description: "Simple"
+ - value: "NodePort"
+ description: "NodePort"
+ - value: "ClusterIP"
+ description: "ClusterIP"
+ - value: "LoadBalancer"
+ description: "LoadBalancer"
+ - variable: loadBalancerIP
+ label: "LoadBalancer IP"
+ description: "LoadBalancerIP"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: string
+ default: ""
+ - variable: externalIPs
+ label: "External IP's"
+ description: "External IP's"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: list
+ default: []
+ items:
+ - variable: externalIP
+ label: "External IP"
+ schema:
+ type: string
+ - variable: portsList
+ label: "Additional Service Ports"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: portsListEntry
+ label: "Custom ports"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable the port"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: name
+ label: "Port Name"
+ schema:
+ type: string
+ default: ""
+ - variable: protocol
+ label: "Port Type"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: HTTP
+ description: "HTTP"
+ - value: "HTTPS"
+ description: "HTTPS"
+ - value: TCP
+ description: "TCP"
+ - value: "UDP"
+ description: "UDP"
+ - variable: targetPort
+ label: "Target Port"
+ description: "This port exposes the container port on the service"
+ schema:
+ type: int
+ required: true
+ - variable: port
+ label: "Container Port"
+ schema:
+ type: int
+ required: true
+ - variable: nodePort
+ label: "Node Port (Optional)"
+ description: "This port gets exposed to the node. Only considered when service type is NodePort"
+ schema:
+ type: int
+ min: 9000
+ max: 65535
+
+ - variable: persistence
+ label: "Integrated Persistent Storage"
+ description: "Integrated Persistent Storage"
+ group: "Storage and Persistence"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: data
+ label: "App Data Storage"
+ description: "Stores the Application Data."
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: type
+ label: "Type of Storage"
+ description: "Sets the persistence type, Anything other than PVC could break rollback!"
+ schema:
+ type: string
+ default: "simplePVC"
+ enum:
+ - value: "simplePVC"
+ description: "PVC (simple)"
+ - value: "simpleHP"
+ description: "HostPath (simple)"
+ - value: "emptyDir"
+ description: "emptyDir"
+ - value: "pvc"
+ description: "pvc"
+ - value: "hostPath"
+ description: "hostPath"
+ - variable: setPermissionsSimple
+ label: "Automatic Permissions"
+ description: "Automatically set permissions on install"
+ schema:
+ show_if: [["type", "=", "simpleHP"]]
+ type: boolean
+ default: true
+ - variable: setPermissions
+ label: "Automatic Permissions"
+ description: "Automatically set permissions on install"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: boolean
+ default: true
+ - variable: readOnly
+ label: "readOnly"
+ schema:
+ type: boolean
+ default: false
+ - variable: hostPathSimple
+ label: "hostPath"
+ description: "Path inside the container the storage is mounted"
+ schema:
+ show_if: [["type", "=", "simpleHP"]]
+ type: hostpath
+ - variable: hostPath
+ label: "hostPath"
+ description: "Path inside the container the storage is mounted"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: hostpath
+ - variable: medium
+ label: "EmptyDir Medium"
+ schema:
+ show_if: [["type", "=", "emptyDir"]]
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "Memory"
+ description: "Memory"
+ - variable: size
+ label: "Size quotum of storage"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "999Gi"
+ - variable: hostPathType
+ label: "(Advanced) hostPath Type"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "DirectoryOrCreate"
+ description: "DirectoryOrCreate"
+ - value: "Directory"
+ description: "Directory"
+ - value: "FileOrCreate"
+ description: "FileOrCreate"
+ - value: "File"
+ description: "File"
+ - value: "Socket"
+ description: "Socket"
+ - value: "CharDevice"
+ description: "CharDevice"
+ - value: "BlockDevice"
+ description: "BlockDevice"
+ - variable: storageClass
+ label: "(Advanced) storageClass"
+ description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "SCALE-ZFS"
+ - variable: accessMode
+ label: "(Advanced) Access Mode"
+ description: "Allow or disallow multiple PVC's writhing to the same PV"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "ReadWriteOnce"
+ enum:
+ - value: "ReadWriteOnce"
+ description: "ReadWriteOnce"
+ - value: "ReadOnlyMany"
+ description: "ReadOnlyMany"
+ - value: "ReadWriteMany"
+ description: "ReadWriteMany"
+ - variable: advanced
+ label: "Show Advanced Options"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: labelsList
+ label: "Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: labelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: annotationsList
+ label: "Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: annotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: persistenceList
+ label: "Additional app storage"
+ group: "Storage and Persistence"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: persistenceListEntry
+ label: "Custom Storage"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable the storage"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: name
+ label: "Name (optional)"
+ description: "Not required, please set to config when mounting /config or temp when mounting /tmp"
+ schema:
+ type: string
+ - variable: type
+ label: "Type of Storage"
+ description: "Sets the persistence type, Anything other than PVC could break rollback!"
+ schema:
+ type: string
+ default: "simpleHP"
+ enum:
+ - value: "simplePVC"
+ description: "PVC (simple)"
+ - value: "simpleHP"
+ description: "HostPath (simple)"
+ - value: "emptyDir"
+ description: "emptyDir"
+ - value: "pvc"
+ description: "pvc"
+ - value: "hostPath"
+ description: "hostPath"
+ - variable: setPermissionsSimple
+ label: "Automatic Permissions"
+ description: "Automatically set permissions on install"
+ schema:
+ show_if: [["type", "=", "simpleHP"]]
+ type: boolean
+ default: true
+ - variable: setPermissions
+ label: "Automatic Permissions"
+ description: "Automatically set permissions on install"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: boolean
+ default: true
+ - variable: readOnly
+ label: "readOnly"
+ schema:
+ type: boolean
+ default: false
+ - variable: hostPathSimple
+ label: "hostPath"
+ description: "Path inside the container the storage is mounted"
+ schema:
+ show_if: [["type", "=", "simpleHP"]]
+ type: hostpath
+ - variable: hostPath
+ label: "hostPath"
+ description: "Path inside the container the storage is mounted"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: hostpath
+ - variable: mountPath
+ label: "mountPath"
+ description: "Path inside the container the storage is mounted"
+ schema:
+ type: string
+ default: ""
+ required: true
+ valid_chars: '^\/([a-zA-Z0-9._-]+(\s?[a-zA-Z0-9._-]+|\/?))+$'
+ - variable: medium
+ label: "EmptyDir Medium"
+ schema:
+ show_if: [["type", "=", "emptyDir"]]
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "Memory"
+ description: "Memory"
+ - variable: size
+ label: "Size quotum of storage"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "999Gi"
+ - variable: hostPathType
+ label: "(Advanced) hostPath Type"
+ schema:
+ show_if: [["type", "=", "hostPath"]]
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "DirectoryOrCreate"
+ description: "DirectoryOrCreate"
+ - value: "Directory"
+ description: "Directory"
+ - value: "FileOrCreate"
+ description: "FileOrCreate"
+ - value: "File"
+ description: "File"
+ - value: "Socket"
+ description: "Socket"
+ - value: "CharDevice"
+ description: "CharDevice"
+ - value: "BlockDevice"
+ description: "BlockDevice"
+ - variable: storageClass
+ label: "(Advanced) storageClass"
+ description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "SCALE-ZFS"
+ - variable: accessMode
+ label: "(Advanced) Access Mode"
+ description: "Allow or disallow multiple PVC's writhing to the same PV"
+ schema:
+ show_if: [["type", "=", "pvc"]]
+ type: string
+ default: "ReadWriteOnce"
+ enum:
+ - value: "ReadWriteOnce"
+ description: "ReadWriteOnce"
+ - value: "ReadOnlyMany"
+ description: "ReadOnlyMany"
+ - value: "ReadWriteMany"
+ description: "ReadWriteMany"
+ - variable: advanced
+ label: "Show Advanced Options"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: labelsList
+ label: "Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: labelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: annotationsList
+ label: "Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: annotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: ingress
+ label: ""
+ group: "Ingress"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: main
+ label: "Main Ingress"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable Ingress"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: hosts
+ label: "Hosts"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: hostEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: host
+ label: "HostName"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: paths
+ label: "Paths"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: pathEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: path
+ label: "path"
+ schema:
+ type: string
+ required: true
+ default: "/"
+ - variable: pathType
+ label: "pathType"
+ schema:
+ type: string
+ required: true
+ default: "Prefix"
+
+ - variable: tls
+ label: "TLS-Settings"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: tlsEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: hosts
+ label: "Certificate Hosts"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: host
+ label: "Host"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: scaleCert
+ label: "Select TrueNAS SCALE Certificate"
+ schema:
+ type: int
+ $ref:
+ - "definitions/certificate"
+
+ - variable: entrypoint
+ label: "(Advanced) Traefik Entrypoint"
+ description: "Entrypoint used by Traefik when using Traefik as Ingress Provider"
+ schema:
+ type: string
+ default: "websecure"
+ required: true
+ - variable: middlewares
+ label: "Traefik Middlewares"
+ description: "Add previously created Traefik Middlewares to this Ingress"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ default: ""
+ required: true
+
+ - variable: expert
+ label: "Show Expert Configuration Options"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: enableFixedMiddlewares
+ description: "These middlewares enforce a number of best practices."
+ label: "Enable Default Middlewares"
+ schema:
+ type: boolean
+ default: true
+ - variable: ingressClassName
+ label: "IngressClass Name"
+ schema:
+ type: string
+ default: ""
+ - variable: labelsList
+ label: "Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: labelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: annotationsList
+ label: "Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: annotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+
+ - variable: ingressList
+ label: "Add Manual Custom Ingresses"
+ group: "Ingress"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: ingressListEntry
+ label: "Custom Ingress"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable Ingress"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ default: ""
+ - variable: ingressClassName
+ label: "IngressClass Name"
+ schema:
+ type: string
+ default: ""
+ - variable: labelsList
+ label: "Labels"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: labelItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: annotationsList
+ label: "Annotations"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: annotationItem
+ label: "Label"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ - variable: hosts
+ label: "Hosts"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: hostEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: host
+ label: "HostName"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: paths
+ label: "Paths"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: pathEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: path
+ label: "path"
+ schema:
+ type: string
+ required: true
+ default: "/"
+ - variable: pathType
+ label: "pathType"
+ schema:
+ type: string
+ required: true
+ default: "Prefix"
+ - variable: service
+ label: "Linked Service"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Service Name"
+ schema:
+ type: string
+ default: ""
+ - variable: port
+ label: "Service Port"
+ schema:
+ type: int
+ - variable: tls
+ label: "TLS-Settings"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: tlsEntry
+ label: "Host"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: hosts
+ label: "Certificate Hosts"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: host
+ label: "Host"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: scaleCert
+ label: "Select TrueNAS SCALE Certificate"
+ schema:
+ type: int
+ $ref:
+ - "definitions/certificate"
+ - variable: entrypoint
+ label: "Traefik Entrypoint"
+ description: "Entrypoint used by Traefik when using Traefik as Ingress Provider"
+ schema:
+ type: string
+ default: "websecure"
+ required: true
+ - variable: middlewares
+ label: "Traefik Middlewares"
+ description: "Add previously created Traefik Middlewares to this Ingress"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ default: ""
+ required: true
+
+ - variable: advancedSecurity
+ label: "Show Advanced Security Settings"
+ group: "Security and Permissions"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: securityContext
+ label: "Security Context"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: privileged
+ label: "Privileged mode"
+ schema:
+ type: boolean
+ default: false
+ - variable: readOnlyRootFilesystem
+ label: "ReadOnly Root Filesystem"
+ schema:
+ type: boolean
+ default: false
+ - variable: allowPrivilegeEscalation
+ label: "Allow Privilege Escalation"
+ schema:
+ type: boolean
+ default: false
+ - variable: runAsNonRoot
+ label: "runAsNonRoot"
+ schema:
+ type: boolean
+ default: false
+ - variable: capabilities
+ label: "Capabilities"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: drop
+ label: "Drop Capability"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: dropEntry
+ label: ""
+ schema:
+ type: string
+ - variable: add
+ label: "Add Capability"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: addEntry
+ label: ""
+ schema:
+ type: string
+
+ - variable: podSecurityContext
+ group: "Security and Permissions"
+ label: "Pod Security Context"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: runAsUser
+ label: "runAsUser"
+ description: "The UserID of the user running the application"
+ schema:
+ type: int
+ default: 0
+ - variable: runAsGroup
+ label: "runAsGroup"
+ description: The groupID this App of the user running the application"
+ schema:
+ type: int
+ default: 0
+ - variable: fsGroup
+ label: "fsGroup"
+ description: "The group that should own ALL storage."
+ schema:
+ type: int
+ default: 33
+ - variable: fsGroupChangePolicy
+ label: "When should we take ownership?"
+ schema:
+ type: string
+ default: "OnRootMismatch"
+ enum:
+ - value: "OnRootMismatch"
+ description: "OnRootMismatch"
+ - value: "Always"
+ description: "Always"
+ - variable: supplementalGroups
+ label: "supplemental Groups"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: supplementalGroupsEntry
+ label: "supplemental Group"
+ schema:
+ type: int
+
+
+ - variable: advancedresources
+ label: "Set Custom Resource Limits/Requests (Advanced)"
+ group: "Resources and Devices"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: resources
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: limits
+ label: "Advanced Limit Resource Consumption"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: cpu
+ label: "CPU"
+ description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/indepth/validation/"
+ schema:
+ type: string
+ default: "4000m"
+ valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
+ - variable: memory
+ label: "RAM"
+ description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/indepth/validation/"
+ schema:
+ type: string
+ default: "8Gi"
+ valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
+ - variable: requests
+ label: "Minimum Resources Required (request)"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: cpu
+ label: "CPU"
+ description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/indepth/validation/"
+ schema:
+ type: string
+ default: "10m"
+ valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
+ - variable: memory
+ label: "RAM"
+ description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/indepth/validation/"
+ schema:
+ type: string
+ default: "50Mi"
+ valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
+
+ - variable: deviceList
+ label: "Mount USB devices"
+ group: "Resources and Devices"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: deviceListEntry
+ label: "Device"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "Enable the storage"
+ schema:
+ type: boolean
+ default: true
+ - variable: type
+ label: "(Advanced) Type of Storage"
+ description: "Sets the persistence type"
+ schema:
+ type: string
+ default: "hostPath"
+ hidden: true
+ - variable: readOnly
+ label: "readOnly"
+ schema:
+ type: boolean
+ default: false
+ - variable: hostPath
+ label: "Host Device Path"
+ description: "Path to the device on the host system"
+ schema:
+ type: path
+ - variable: mountPath
+ label: "Container Device Path"
+ description: "Path inside the container the device is mounted"
+ schema:
+ type: string
+ default: "/dev/ttyACM0"
+
+ # Specify GPU configuration
+ - variable: scaleGPU
+ label: "GPU Configuration"
+ group: "Resources and Devices"
+ schema:
+ type: dict
+ $ref:
+ - "definitions/gpuConfiguration"
+ attrs: []
+
+ - variable: autoscaling
+ group: "Advanced"
+ label: "(Advanced) Horizontal Pod Autoscaler"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: target
+ label: "Target"
+ description: "deployment name, defaults to main deployment"
+ schema:
+ type: string
+ default: ""
+ - variable: minReplicas
+ label: "Minimum Replicas"
+ schema:
+ type: int
+ default: 1
+ - variable: maxReplicas
+ label: "Maximum Replicas"
+ schema:
+ type: int
+ default: 5
+ - variable: targetCPUUtilizationPercentage
+ label: "Target CPU Utilization Percentage"
+ schema:
+ type: int
+ default: 80
+ - variable: targetMemoryUtilizationPercentage
+ label: "Target Memory Utilization Percentage"
+ schema:
+ type: int
+ default: 80
+ - variable: networkPolicy
+ group: "Advanced"
+ label: "(Advanced) Network Policy"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: policyType
+ label: "Policy Type"
+ schema:
+ type: string
+ default: ""
+ enum:
+ - value: ""
+ description: "Default"
+ - value: "ingress"
+ description: "Ingress"
+ - value: "egress"
+ description: "Egress"
+ - value: "ingress-egress"
+ description: "Ingress and Egress"
+ - variable: egress
+ label: "Egress"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: egressEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: to
+ label: "To"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: toEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: ipBlock
+ label: "ipBlock"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: cidr
+ label: "cidr"
+ schema:
+ type: string
+ default: ""
+ - variable: except
+ label: "except"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: exceptint
+ label: ""
+ schema:
+ type: int
+ - variable: namespaceSelector
+ label: "namespaceSelector"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: matchExpressions
+ label: "matchExpressions"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: expressionEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: key
+ label: "Key"
+ schema:
+ type: string
+ - variable: operator
+ label: "operator"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "In"
+ description: "In"
+ - value: "NotIn"
+ description: "NotIn"
+ - value: "Exists "
+ description: "Exists "
+ - value: "DoesNotExist "
+ description: "DoesNotExist "
+ - variable: values
+ label: "values"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: value
+ label: ""
+ schema:
+ type: string
+ - variable: podSelector
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: matchExpressions
+ label: "matchExpressions"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: expressionEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: key
+ label: "Key"
+ schema:
+ type: string
+ - variable: operator
+ label: "operator"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "In"
+ description: "In"
+ - value: "NotIn"
+ description: "NotIn"
+ - value: "Exists "
+ description: "Exists "
+ - value: "DoesNotExist "
+ description: "DoesNotExist "
+ - variable: values
+ label: "values"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: value
+ label: ""
+ schema:
+ type: string
+ - variable: ports
+ label: "Ports"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: portsEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: port
+ label: "port"
+ schema:
+ type: int
+ - variable: endPort
+ label: "port"
+ schema:
+ type: int
+ - variable: protocol
+ label: "Protocol"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "TCP"
+ description: "TCP"
+ - value: "UDP"
+ description: "UDP"
+ - value: "SCTP"
+ description: "SCTP"
+ - variable: ingress
+ label: "Ingress"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: ingressEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: from
+ label: "From"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: fromEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: ipBlock
+ label: "ipBlock"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: cidr
+ label: "cidr"
+ schema:
+ type: string
+ default: ""
+ - variable: except
+ label: "except"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: exceptint
+ label: ""
+ schema:
+ type: int
+ - variable: namespaceSelector
+ label: "namespaceSelector"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: matchExpressions
+ label: "matchExpressions"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: expressionEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: key
+ label: "Key"
+ schema:
+ type: string
+ - variable: operator
+ label: "operator"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "In"
+ description: "In"
+ - value: "NotIn"
+ description: "NotIn"
+ - value: "Exists "
+ description: "Exists "
+ - value: "DoesNotExist "
+ description: "DoesNotExist "
+ - variable: values
+ label: "values"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: value
+ label: ""
+ schema:
+ type: string
+ - variable: podSelector
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: matchExpressions
+ label: "matchExpressions"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: expressionEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: key
+ label: "Key"
+ schema:
+ type: string
+ - variable: operator
+ label: "operator"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "In"
+ description: "In"
+ - value: "NotIn"
+ description: "NotIn"
+ - value: "Exists "
+ description: "Exists "
+ - value: "DoesNotExist "
+ description: "DoesNotExist "
+ - variable: values
+ label: "values"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: value
+ label: ""
+ schema:
+ type: string
+ - variable: ports
+ label: "Ports"
+ schema:
+ type: list
+ default: []
+ items:
+ - variable: portsEntry
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: port
+ label: "port"
+ schema:
+ type: int
+ - variable: endPort
+ label: "port"
+ schema:
+ type: int
+ - variable: protocol
+ label: "Protocol"
+ schema:
+ type: string
+ default: "TCP"
+ enum:
+ - value: "TCP"
+ description: "TCP"
+ - value: "UDP"
+ description: "UDP"
+ - value: "SCTP"
+ description: "SCTP"
+
+
+ - variable: addons
+ group: "Addons"
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: vpn
+ label: "VPN"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: type
+ label: "Type"
+ schema:
+ type: string
+ default: "disabled"
+ enum:
+ - value: "disabled"
+ description: "disabled"
+ - value: "openvpn"
+ description: "OpenVPN"
+ - value: "wireguard"
+ description: "Wireguard"
+ - variable: openvpn
+ label: "OpenVPN Settings"
+ schema:
+ type: dict
+ show_if: [["type", "=", "openvpn"]]
+ attrs:
+ - variable: username
+ label: "authentication username"
+ description: "authentication username, optional"
+ schema:
+ type: string
+ default: ""
+ - variable: password
+ label: "authentication password"
+ description: "authentication credentials"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: killSwitch
+ label: "Enable killswitch"
+ schema:
+ type: boolean
+ show_if: [["type", "!=", "disabled"]]
+ default: true
+ - variable: excludedNetworks_IPv4
+ label: "Killswitch Excluded IPv4 networks"
+ description: "list of killswitch excluded ipv4 addresses"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: networkv4
+ label: "IPv4 Network"
+ schema:
+ type: string
+ required: true
+ - variable: excludedNetworks_IPv6
+ label: "Killswitch Excluded IPv6 networks"
+ description: "list of killswitch excluded ipv4 addresses"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: networkv6
+ label: "IPv6 Network"
+ schema:
+ type: string
+ required: true
+
+ - variable: configFile
+ label: "VPN Config File Location"
+ schema:
+ type: dict
+ show_if: [["type", "!=", "disabled"]]
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: type
+ label: "type"
+ schema:
+ type: string
+ default: "hostPath"
+ hidden: true
+ - variable: hostPathType
+ label: "hostPathType"
+ schema:
+ type: string
+ default: "File"
+ hidden: true
+ - variable: noMount
+ label: "noMount"
+ schema:
+ type: boolean
+ default: true
+ hidden: true
+ - variable: hostPath
+ label: "Full path to file"
+ description: "path to your local VPN config file for example: /mnt/tank/vpn.conf or /mnt/tank/vpn.ovpn"
+ schema:
+ type: string
+ default: ""
+ required: true
+ - variable: envList
+ label: "VPN environment Variables"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: envItem
+ label: "Environment Variable"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ required: true
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ required: true
+
+ - variable: codeserver
+ label: "Codeserver"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: git
+ label: "Git Settings"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: deployKey
+ description: "Raw SSH private key"
+ label: "deployKey"
+ schema:
+ type: string
+ - variable: deployKeyBase64
+ description: "Base64-encoded SSH private key. When both variables are set, the raw SSH key takes precedence"
+ label: "deployKeyBase64"
+ schema:
+ type: string
+ - variable: service
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: type
+ label: "Service Type"
+ description: "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
+ schema:
+ type: string
+ default: "NodePort"
+ enum:
+ - value: "NodePort"
+ description: "NodePort"
+ - value: "ClusterIP"
+ description: "ClusterIP"
+ - value: "LoadBalancer"
+ description: "LoadBalancer"
+ - variable: loadBalancerIP
+ label: "LoadBalancer IP"
+ description: "LoadBalancerIP"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: string
+ default: ""
+ - variable: externalIPs
+ label: "External IP's"
+ description: "External IP's"
+ schema:
+ show_if: [["type", "=", "LoadBalancer"]]
+ type: list
+ default: []
+ items:
+ - variable: externalIP
+ label: "External IP"
+ schema:
+ type: string
+ - variable: ports
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: codeserver
+ label: ""
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: nodePort
+ description: "leave empty to disable"
+ label: "nodePort"
+ schema:
+ type: int
+ default: 36107
+ - variable: envList
+ label: "Codeserver environment Variables"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: envItem
+ label: "Environment Variable"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ required: true
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ required: true
+
+
+ - variable: promtail
+ label: "Promtail"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: loki
+ label: "Loki URL"
+ schema:
+ type: string
+ required: true
+ - variable: logs
+ label: "Log Paths"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ required: true
+ - variable: path
+ label: "Path"
+ schema:
+ type: string
+ required: true
+ - variable: args
+ label: "Promtail ecommand line arguments"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: arg
+ label: "Arg"
+ schema:
+ type: string
+ required: true
+ - variable: envList
+ label: "Promtail environment Variables"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: envItem
+ label: "Environment Variable"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ required: true
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ required: true
+
+
+
+
+ - variable: netshoot
+ label: "Netshoot"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: enabled
+ label: "enabled"
+ schema:
+ type: boolean
+ default: false
+ show_subquestions_if: true
+ subquestions:
+ - variable: envList
+ label: "Netshoot environment Variables"
+ schema:
+ type: list
+ show_if: [["type", "!=", "disabled"]]
+ default: []
+ items:
+ - variable: envItem
+ label: "Environment Variable"
+ schema:
+ additional_attrs: true
+ type: dict
+ attrs:
+ - variable: name
+ label: "Name"
+ schema:
+ type: string
+ required: true
+ - variable: value
+ label: "Value"
+ schema:
+ type: string
+ required: true
diff --git a/incubator/synapse/0.0.1/security.md b/incubator/synapse/0.0.1/security.md
new file mode 100644
index 00000000000..ac974cb2c40
--- /dev/null
+++ b/incubator/synapse/0.0.1/security.md
@@ -0,0 +1,25 @@
+---
+hide:
+ - toc
+---
+
+# Security Overview
+
+
+
+## Helm-Chart
+
+##### Scan Results
+
+
+
+| No Misconfigurations found |
+|:---------------------------------|
+
+## Containers
+
+##### Detected Containers
+
+
+##### Scan Results
+
diff --git a/incubator/synapse/0.0.1/templates/_configmap.tpl b/incubator/synapse/0.0.1/templates/_configmap.tpl
new file mode 100644
index 00000000000..b9597f3dab9
--- /dev/null
+++ b/incubator/synapse/0.0.1/templates/_configmap.tpl
@@ -0,0 +1,153 @@
+{{/* Define the configs */}}
+{{- define "synapse.config" -}}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+ name: synapse-config
+ labels:
+ {{ include "common.labels" . | nindent 4 }}
+ annotations:
+ rollme: {{ randAlphaNum 5 | quote }}
+data:
+ homeserver.yaml: |
+ server_name: {{ .Values.matrix.serverName }}
+ pid_file: /data/homeserver.pid
+ public_baseurl: {{ include "matrix.baseUrl" . | quote }}
+ use_presence: {{ .Values.matrix.presence }}
+
+ allow_public_rooms_over_federation: {{ and .Values.matrix.federation.enabled .Values.matrix.federation.allowPublicRooms }}
+
+ block_non_admin_invites: {{ .Values.matrix.blockNonAdminInvites }}
+
+ enable_search: {{ .Values.matrix.search }}
+
+ {{- if .Values.matrix.federation.whitelist }}
+ federation_domain_whitelist:
+ {{- range .Values.matrix.federation.whitelist }}
+ - {{ . }}
+ {{- end }}
+ {{- end}}
+
+ federation_ip_range_blacklist:
+ {{- range .Values.matrix.federation.blacklist }}
+ - {{ . }}
+ {{- end }}
+
+ listeners:
+ - port: 8008
+ tls: false
+ type: http
+ x_forwarded: true
+ bind_addresses: ['0.0.0.0']
+ resources:
+ - names: [client, federation]
+ compress: false
+
+ {{- if .Values.synapse.metrics.enabled }}
+ - type: metrics
+ port: {{ .Values.synapse.metrics.port }}
+ bind_addresses: ['0.0.0.0']
+ resources:
+ - names: [metrics]
+ {{- end }}
+
+ admin_contact: 'mailto:{{ .Values.matrix.adminEmail }}'
+ hs_disabled: {{ .Values.matrix.disabled }}
+ hs_disabled_message: {{ .Values.matrix.disabledMessage }}
+ redaction_retention_period: {{ .Values.matrix.retentionPeriod }}
+
+ log_config: "/data/{{ .Values.matrix.serverName }}.log.config"
+ media_store_path: "/data/media_store"
+ uploads_path: "/data/uploads"
+ max_upload_size: {{ .Values.matrix.uploads.maxSize }}
+ max_image_pixels: {{ .Values.matrix.uploads.maxPixels }}
+ url_preview_enabled: {{ .Values.matrix.urlPreviews.enabled }}
+
+ {{- if .Values.coturn.enabled -}}
+ {{- if not (empty .Values.coturn.uris) }}
+ turn_uris:
+ {{- range .Values.coturn.uris }}
+ - {{ . }}
+ {{- end }}
+ {{- else }}
+ turn_uris:
+ - "turn:{{ include "matrix.hostname" . }}?transport=udp"
+ {{- end }}
+ turn_user_lifetime: 1h
+ turn_allow_guests: {{ .Values.coturn.allowGuests }}
+ {{- end }}
+
+ enable_registration: {{ .Values.matrix.registration.enabled }}
+
+ allow_guest_access: {{ .Values.matrix.registration.allowGuests }}
+
+ {{- if .Values.synapse.metrics.enabled }}
+ enable_metrics: true
+ {{- end }}
+
+ report_stats: false
+
+ {{- if .Values.synapse.appConfig }}
+ app_service_config_files:
+ {{- range .Values.synapse.appConfig }}
+ - {{ . }}
+ {{- end }}
+ {{- end }}
+
+ signing_key_path: "/data/keys/{{ .Values.matrix.serverName }}.signing.key"
+
+ {{- if .Values.matrix.security.trustedKeyServers }}
+ trusted_key_servers:
+ {{- range .Values.matrix.security.trustedKeyServers }}
+ - server_name: {{ .serverName }}
+ {{- if .verifyKeys }}
+ verify_keys:
+ {{- range .verifyKeys }}
+ {{ .id | quote }}: {{ .key | quote }}
+ {{- end }}
+ {{- end }}
+ {{- if .acceptKeysInsecurely }}
+ accept_keys_insecurely: {{ .acceptKeysInsecurely }}
+ {{- end }}
+ {{- end }}
+ {{- end }}
+
+ suppress_key_server_warning: {{ .Values.matrix.security.supressKeyServerWarning }}
+ {{- if not .Values.loadCustomConfig }}
+ custom.yaml: |
+ # PLACEHOLDER
+ {{- end }}
+
+ {{ .Values.matrix.serverName }}.log.config: |
+ version: 1
+
+ formatters:
+ precise:
+ format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+
+ filters:
+ context:
+ (): synapse.util.logcontext.LoggingContextFilter
+ request: ""
+
+ handlers:
+ console:
+ class: logging.StreamHandler
+ formatter: precise
+ filters: [context]
+
+ loggers:
+ synapse:
+ level: {{ .Values.matrix.logging.synapseLogLevel }}
+
+ synapse.storage.SQL:
+ # beware: increasing this to DEBUG will make synapse log sensitive
+ # information such as access tokens.
+ level: {{ .Values.matrix.logging.sqlLogLevel }}
+
+
+ root:
+ level: {{ .Values.matrix.logging.rootLogLevel }}
+ handlers: [console]
+{{- end }}
diff --git a/incubator/synapse/0.0.1/templates/_helpers.tpl b/incubator/synapse/0.0.1/templates/_helpers.tpl
new file mode 100644
index 00000000000..21bbda61c3c
--- /dev/null
+++ b/incubator/synapse/0.0.1/templates/_helpers.tpl
@@ -0,0 +1,20 @@
+Synapse hostname, derived from either the Values.matrix.hostname override or the Ingress definition
+*/}}
+{{- define "matrix.hostname" -}}
+{{- if .Values.matrix.hostname }}
+{{- .Values.matrix.hostname -}}
+{{- else }}
+{{- .Values.ingress.hosts.synapse -}}
+{{- end }}
+{{- end }}
+
+{{/*
+Synapse hostname prepended with https:// to form a complete URL
+*/}}
+{{- define "matrix.baseUrl" -}}
+{{- if .Values.matrix.hostname }}
+{{- printf "https://%s" .Values.matrix.hostname -}}
+{{- else }}
+{{- printf "https://%s" .Values.ingress.hosts.synapse -}}
+{{- end }}
+{{- end }}
diff --git a/incubator/synapse/0.0.1/templates/_secret.tpl b/incubator/synapse/0.0.1/templates/_secret.tpl
new file mode 100644
index 00000000000..f83ef68469c
--- /dev/null
+++ b/incubator/synapse/0.0.1/templates/_secret.tpl
@@ -0,0 +1,55 @@
+{{/* Define the configs */}}
+{{- define "synapse.secret" -}}
+---
+apiVersion: v1
+kind: Secret
+metadata:
+ name: synapse-secret
+ labels:
+ {{ include "common.labels" . | nindent 4 }}
+ annotations:
+ rollme: {{ randAlphaNum 5 | quote }}
+stringData:
+ {{- $previous := lookup "v1" "Secret" .Release.Namespace "synapse-secret" }}
+ {{- $msk := "" }}
+ secret.yaml: |
+ {{- if .Values.mail.enabled }}
+ email:
+ enable_notifs: {{ .Values.mail.enabled }}
+ notif_from: {{ .Values.mail.from }}
+ smtp_host: {{ .Values.mail.external.host }}
+ smtp_port: {{ .Values.mail.external.port }}
+ smtp_user: {{ .Values.mail.external.username }}
+ smtp_pass: {{ .Values.mail.external.password }}
+ require_transport_security: {{ .Values.mail.external.requireTransportSecurity }}
+ {{- end }}
+
+ database:
+ name: "psycopg2"
+ args:
+ user: "{{ .Values.postgresql.postgresqlUsername }}"
+ password: {{ .Values.postgresql.postgresqlPassword }}
+ database: "{{ .Values.postgresql.postgresqlDatabase }}"
+ host: "{{ printf "%v-%v" .Release.Name "postgresql" }}"
+ port: "5432"
+ cp_min: 5
+ cp_max: 10
+ sslmode: "disable"
+
+ {{- if .Values.matrix.registration.sharedSecret }}
+ registration_shared_secret: {{ .Values.matrix.registration.sharedSecret }}
+ {{- end }}
+
+ {{- if $previous }}
+ {{- $msk = ( index $previous.data "macaroon_secret_key" ) | b64dec }}
+ macaroon_secret_key: {{ ( index $previous.data "macaroon_secret_key" ) }}
+ {{- else }}
+ {{- $msk = randAlphaNum 50 }}
+ macaroon_secret_key: {{ $msk | b64enc | quote }}
+ {{- end }}
+
+ {{- if .Values.coturn.enabled -}}
+ turn_shared_secret: {{ include "matrix.coturn.sharedSecret" . }}
+ {{- end }}
+
+{{- end }}
diff --git a/incubator/synapse/0.0.1/templates/common.yaml b/incubator/synapse/0.0.1/templates/common.yaml
new file mode 100644
index 00000000000..1bac1bd32ee
--- /dev/null
+++ b/incubator/synapse/0.0.1/templates/common.yaml
@@ -0,0 +1,11 @@
+{{/* Make sure all variables are set properly */}}
+{{- include "common.setup" . }}
+
+{{/* Render configmap for synapse */}}
+{{- include "synapse.config" . }}
+
+{{/* Render secret for synapse */}}
+{{- include "synapse.secret" . }}
+
+{{/* Render the templates */}}
+{{ include "common.postSetup" . }}
diff --git a/incubator/synapse/0.0.1/values.yaml b/incubator/synapse/0.0.1/values.yaml
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/incubator/synapse/item.yaml b/incubator/synapse/item.yaml
new file mode 100644
index 00000000000..73e4fd6f919
--- /dev/null
+++ b/incubator/synapse/item.yaml
@@ -0,0 +1,4 @@
+icon_url: https://truecharts.org/_static/img/appicons/synapse-icon.png
+categories:
+- cloud
+