Merge pull request #3 from smapiot/upgrade-version-and-envs

Update Chart to Feed Service Version 1.16.0

Author: FlorianRappl

Chart.yaml

@@ -4,7 +4,7 @@ description: A Helm chart for operating the Piral Feed Service in Kubernetes
 type: application
 
 # The chart version.
-version: 0.4.0-beta
+version: 0.5.0-beta
 
 # The version number of the Feed Service.
-appVersion: "v1.13.4"
+appVersion: "v1.16.0"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 smapiot
+Copyright (c) 2025 smapiot
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,13 @@
 # Piral Feed Service Helm Chart
 
-Chart version: `0.4.0`
+Chart version: `0.5.0`
 Status: `beta`
 
 ## Introduction
 
 This chart bootstraps a **Feed Service deployment** to a Kubernetes Cluster using the Helm package manager. The specific configuration values will be added to a config map and will be injected as environment variables into the pod, which executes the Feed Service. The sensitive values are injected via Kubernetes secrets.
 
-**Remark:** This Helm chart version supports version `1.13.4` of the Feed Service.
+**Remark:** This Helm chart version supports version `1.16.0` of the Feed Service.
 
 Additional configuration options can be configured via environment variables, which can be added as required in section `extendedConfig` in the `values.yaml` file.
 

templates/configmap.yaml

@@ -42,6 +42,12 @@ data:
   {{- if (.Values.globalConfig.auditHandler) }}
   PIRAL_AUDIT_HANDLER: "{{ .Values.globalConfig.auditHandler }}"
   {{- end }}
+  {{- if (.Values.globalConfig.httpProxy) }}
+  PIRAL_DEFAULT_HTTP_PROXY: "{{ .Values.globalConfig.httpProxy }}"
+  {{- end}}
+  {{- if (.Values.globalConfig.webhookMaxRetries) }}
+  PIRAL_WEBHOOK_MAX_RETRIES: "{{ .Values.globalConfig.webhookMaxRetries }}"
+  {{- end}}
 
   ## --------------------
   ## Authentication
@@ -55,6 +61,9 @@ data:
   {{- if (.Values.authentication.local.username) }}
   PIRAL_AUTH_LOCAL_USER: "{{ .Values.authentication.local.username }}"
   {{- end }}
+  {{- if (.Values.authentication.local.passAlg) }}
+  PIRAL_AUTH_LOCAL_PASS_ALG: "{{ .Values.authentication.local.passAlg }}"
+  {{- end }}
   {{- end }}
 
   ## Microsoft Authentication
@@ -74,7 +83,10 @@ data:
   {{- end }}
   {{- if (.Values.authentication.microsoft.lowercaseId ) }}
   PIRAL_AUTH_MICROSOFT_LOWERCASE_ID: "{{ .Values.authentication.microsoft.lowercaseId }}"
-  {{- end }}  
+  {{- end }}
+  {{- if (.Values.authentication.microsoft.lowercaseEmail ) }}
+  PIRAL_AUTH_MICROSOFT_LOWERCASE_EMAIL: "{{ .Values.authentication.microsoft.lowercaseEmail }}"
+  {{- end }}
   {{- end }}
 
   ## Generic OAuth2
@@ -171,6 +183,9 @@ data:
   {{- if (.Values.authentication.saml.lowercaseId ) }}
   PIRAL_AUTH_SAML_LOWERCASE_ID: "{{ .Values.authentication.saml.lowercaseId }}"
   {{- end }}
+  {{- if (.Values.authentication.saml.checkAssertions ) }}
+  PIRAL_AUTH_SAML_CHECK_ASSERTIONS: "{{ .Values.authentication.saml.checkAssertions }}"
+  {{- end }}
   {{- end }}
 
   ## --------------------
@@ -267,12 +282,14 @@ data:
   PIRAL_DB_REDIS_PREFIX: "{{ .Values.database.redis.prefix }}"
   {{- end }}
   {{- end }}
+
   ## MongoDB
   {{- if (eq .Values.database.provider "mongodb") }}
   {{- if (.Values.database.mongodb.prefix ) }}
   PIRAL_DB_MONGO_COLLECTION_PREFIX: "{{ .Values.database.mongodb.prefix }}"
   {{- end }}
   {{- end }}
+
   ## SQL
   {{- if (eq .Values.database.provider "sql") }}
   PIRAL_DB_SQL_NAME: "{{ required "Please provide the name for the SQL database" .Values.database.sql.dbname }}"
@@ -292,11 +309,19 @@ data:
   {{- end }}
   {{- end }}
 
+  ## DynamoDB
+  {{- if (eq .Values.database.provider "aws-dynamodb") }}
+  PIRAL_DB_DYNAMODB_REGION: "{{ required "Please provide the Amazon DynamoDB Region" .Values.database.dynamoDb.region }}"
+  {{- if (.Values.database.dynamoDb.prefix ) }}
+  PIRAL_DB_DYNAMODB_TABLE_PREFIX: "{{ .Values.database.dynamoDb.prefix }}"
+  {{- end }}
+  {{- end }}
+
   ## -----------------------
   ## Cache
   ## -----------------------
   PIRAL_CACHE: "{{ .Values.cache.provider }}"
-    ## Redis
+  ## Redis
   {{- if (eq .Values.cache.provider "redis") }}
   PIRAL_CACHE_REDIS_HOST: "{{ required "Please provide the host for the Redis database" .Values.cache.redis.host }}"
   {{- if (.Values.cache.redis.port ) }}
@@ -309,6 +334,17 @@ data:
   PIRAL_CACHE_REDIS_PREFIX: "{{ .Values.cache.redis.prefix }}"
   {{- end }}
   {{- end }}
+  ## Memcache
+  {{- if (eq .Values.cache.provider "memcache") }}
+  PIRAL_CACHE_MEMCACHE_SERVERS: "{{ required "Please provide the Memcache servers" .Values.cache.memcache.servers }}"
+  {{- if (.Values.cache.memcache.authUser ) }}
+  PIRAL_CACHE_MEMCACHE_AUTH_USER: "{{ .Values.cache.memcache.authUser }}"
+  {{- end }}
+  {{- if (.Values.cache.memcache.prefix ) }}
+  PIRAL_CACHE_MEMCACHE_PREFIX: "{{ .Values.cache.memcache.prefix }}"
+  {{- end }}
+  {{- end }}
+
 
   ## -----------------------
   ## Notification configuration
@@ -336,6 +372,12 @@ data:
   PIRAL_NOTIFICATION_SENDGRID_SENDER: "{{ .Values.notifications.sendgrid.sender }}"
   {{- end }}
   {{- end }}
+  ## ntfy.sh
+  {{- if (eq .Values.notifications.provider "ntfy") }}
+  {{- if (.Values.notifications.ntfy.url) }}
+  PIRAL_NOTIFICATION_NTFY_URL: "{{ .Values.notifications.ntfy.url }}"
+  {{- end }}
+  {{- end }}
 
   ## -----------------------
   ## Portal UI configuration

templates/secret.yaml

@@ -29,6 +29,9 @@ data:
   {{- if (eq .Values.authentication.provider "microsoft") }}
   PIRAL_AUTH_MICROSOFT_CLIENTID: {{ required "Please provide a client id for the Microsoft authentication provider" .Values.authentication.microsoft.clientId | b64enc | quote }}
   PIRAL_AUTH_MICROSOFT_TENANTID: {{ required "Please provide a tenant id for the Microsoft authentication provider" .Values.authentication.microsoft.tenantId | b64enc | quote }}
+  {{- if (.Values.authentication.microsoft.clientSecret ) }}
+  PIRAL_AUTH_MICROSOFT_CLIENTSECRET: "{{ .Values.authentication.microsoft.clientSecret }}"
+  {{- end }}
   {{- end }}
 
   ## --------------------
@@ -74,6 +77,11 @@ data:
   {{- if (eq .Values.database.provider "sql") }}
   PIRAL_DB_SQL_PASS: {{ required "Please provide the user password for accessing the SQL database" .Values.database.sql.password | b64enc | quote }}
   {{- end }}
+  ## DynamoDB
+  {{- if (eq .Values.database.provider "aws-dynamodb") }}
+  PIRAL_DB_DYNAMODB_ACCESS_ID: "{{ required "Please provide the Amazon DynamoDB AWS access key ID" .Values.database.dynamoDb.accessId }}"
+  PIRAL_DB_DYNAMODB_ACCESS_KEY: "{{ required "Please provide the Amazon DynamoDB AWS secret access key" .Values.database.dynamoDb.accessKey }}"
+  {{- end }}
 
   ## --------------------
   ## Cache
@@ -82,6 +90,12 @@ data:
   {{- if (eq .Values.cache.provider "redis") }}
   PIRAL_CACHE_REDIS_AUTH_PASS: {{ required "Please provide the password for accessing the Redis cache" .Values.cache.redis.password | b64enc | quote }}
   {{- end }}
+  ## Memcache
+  {{- if (eq .Values.cache.provider "memcache") }}
+  {{- if (.Values.cache.memcache.authPass ) }}
+  PIRAL_CACHE_MEMCACHE_AUTH_PASS: "{{ .Values.cache.memcache.authPass }}"
+  {{- end }}
+  {{- end }}
 
   ## -----------------------
   ## Notifications

values.yaml

@@ -8,7 +8,7 @@ image:
   repository: piral.azurecr.io/piral-feed-service
   pullPolicy: Always
   # Overrides the image tag whose default is the chart appVersion.
-  tag: "v1.13.4"
+  tag: "v1.16.0"
 
 # Configure the secret, which contains the credentials for the container registry.
 # For creating the image pull secret please visit:
@@ -120,6 +120,13 @@ globalConfig:
   # The audit handler to use (optional, default: "none"); choices: "none", "local"
   auditHandler: "none"
 
+  # The URL of a proxy to be used for HTTP requests. This might be needed if your feed service instance cannot communicate with external web services directly.
+  httpProxy: ""
+
+  # The maximum number of retries that the feed service should attempt when invoking webhook endpoints.
+  # Uses an exponential backoff for running the retries. (default: 3)
+  webhookMaxRetries: 3
+
 # Specify the authentication provider for the feed service. Options are:
 # microsoft, oauth2, oidc, local, ldap, saml (default is local, if no provider is specified)
 authentication:
@@ -133,6 +140,10 @@ authentication:
     # As alternative to providing the username and password directly in this values file,
     # you can specify the name of the K8s secret if it exists already or is created outside of this deployment.
     passwordSecret: ""
+    # The algorithm used for transporting the password of the local admin. 
+    # For "plain" you just store the password in the environment variable. For "sha256" you compute the SHA256 hash of the password and store the base64 representation in the environment variable.
+    # (default: plain)
+    passAlg: "plain"
 
   # Configuration details for the Microsoft authentication provider.
   # Required settings are: tenantId, clientId and adminEmail
@@ -150,6 +161,8 @@ authentication:
     authorityUrl: ""
     # The ID of the application created in the Microsoft AD (called "client ID")
     clientId: ""
+    # Azure AD client secret for advanced auth provider capabilities such as an AAD user lookup. (default: empty)
+    clientSecret: ""
     # The tenant id from the Microsoft AD configuration
     tenantId: ""
     # Flag for access restricting the users registered in the Microsoft AD. 
@@ -158,6 +171,8 @@ authentication:
     # The scope used for the client authentication. Default is set to "api://<client-id>/Profile.Read"
     # The scope is set in the Microsoft AD app registration and has a full URI format
     scope: ""
+    # Determines if the user's email should be always considered case-insensitive; choices: yes, no. (default: no)
+    lowercaseEmail: "no"
 
   # Configuration details required for a generic OAuth2 authentication provider    
   # Required settings are: clientId, authorizationUrl, tokenUrl, oauth2Key, and adminId
@@ -277,6 +292,8 @@ authentication:
     # Transform user IDs given by the IdP to be case-insensitive
     # Optional. Choices: yes, no (default: no)
     lowercaseId: "no"
+    # If enabled the assertions in the SAML response will be checked for a valid signature, too; choices: yes, no. (default: no)
+    checkAssertions: "no"
 
 # File storage configuration for persisting the pilets. Options are:
 # azure-blobstorage, aws-s3, do-spaces, disk (default is disk, if no provider is specified)
@@ -373,7 +390,7 @@ database:
     useTls: "no"
     # Prefix for the feed service keys in Redis
     prefix: "piral"
-
+  
   # Configuration for the MongoDB as database provider
   mongodb:
     # Connection string for accessing the MongoDB
@@ -400,6 +417,16 @@ database:
     # The location of a CA certificate to use for DB server trust (default: none)
     caCertLocation: ""
 
+  dynamoDb:
+    # Required. The Amazon DynamoDB AWS access key ID.
+    accessId: ""
+    # Required. The Amazon DynamoDB AWS access key.
+    accessKey: ""
+    # Required. The Amazon DynamoDB Region.
+    region: ""
+    # The Amazon DynamoDB prefix for the table names. (default: empty)
+    prefix: ""
+
 # The feed service will utilize the cache to store entities for faster access
 # Options for the cache are: memory, redis (default: memory)
 cache:
@@ -417,6 +444,16 @@ cache:
     # Prefix for the feed service keys in Redis
     prefix: "piral"
 
+  memcache:
+    # Required. A comma separated list of [hostname:port] servers for connecting to the Memcache provider.
+    servers: ""
+    # Host access for the Memcache provider (default: nothing)
+    authUser: ""
+    # Host access for the Memcache provider (default: nothing)
+    authPass: ""
+    # Prefix to be used for the Memcache entries (default: piral)
+    prefix: "piral"
+
 
 
 # Configuration for notifications
@@ -445,6 +482,11 @@ notifications:
     apiKey: ""
     # Email address for the notifications (default: noreply@piral.cloud)
     sender: "noreply@piral.cloud"
+  
+  # Configuration for the ntfy.sh provider
+  ntfy:
+    # The full URL of the topic to be used for sending push notifications via ntfy.sh (default: nothing)
+    url: ""
 
 
 # Example configuration for storing data e.g. in a persistent file share as location,
@@ -475,6 +517,8 @@ portalConfig:
   PIRAL_UI_PRIMARY_COLOR: "#56aa1c"
   # Secondary color in the UI (optional, default: #78bb49) 
   PIRAL_UI_SECONDARY_COLOR: "#78bb49"
+  # Tertiary color in the UI (optional, default #745a13)
+  PIRAL_UI_TERTIARY_COLOR: "#745a13"
   # Font color in the UI (optional, default: #101010)
   PIRAL_UI_FONT_COLOR: "#101010"
   # Color of semi-transparent text (default: hsla(0,2%,55%,.7))
@@ -485,16 +529,28 @@ portalConfig:
   PIRAL_UI_CONTRAST_COLOR: "#ffffff"
   # Shadow color to be used (default: #f2f2f2)
   PIRAL_UI_SHADOW_COLOR: "#f2f2f2"
+  # The danger color to be used in the pages (UI portal, overview page, login, ...). (default: #d61c1c)
+  PIRAL_UI_DANGER_COLOR: "#d61c1c"
+  # The success color to be used in the pages (UI portal, overview page, login, ...). (default: #499e0d)
+  PIRAL_UI_SUCCESS_COLOR: "#499e0d"
+  # The info color to be used in the pages (UI portal, overview page, login, ...). (default: #1d72f3)
+  PIRAL_UI_INFO_COLOR: "#1d72f3"
+  # The warning color to be used in the pages (UI portal, overview page, login, ...). (default: #ffc007)
+  PIRAL_UI_WARNING_COLOR: "#ffc007"
   # Path to a logo for the UI (optional, example: /media/logo.png)
   # PIRAL_UI_LOGO_PATH: ""
   # API key for the portal's intrinsic pilet feed ("cloud") (example: abc)
   # PIRAL_UI_FEED_API_KEY: ""
   # Shows the cookie consent dialog; choices on, off (default: off)
   PIRAL_UI_SHOW_CONSENT: "off"
+  # Shows the homepage in the portal - otherwise the Piral Feed Service redirects to the login directly; choices on, off (default: off)
+  PIRAL_UI_SHOW_HOME: "off"
   # Disables the UI module/endpoint; choices on, off (default: off)
   PIRAL_UI_DISABLED: "off"
   # URL of the service's web management portal (default: value of PIRAL_PUBLIC_URL)
   # PIRAL_PORTAL_URL: "http://localhost:9000"
+  # Sets the key of the session ID field in the cookie (default: sid)
+  PIRAL_COOKIE_SESSION_KEY: "sid"
 
 # Extended configuration settings
 # Remark: unused settings for the portal config should be commented so that they are not set.