feat(helm): add documentation for new content and adjust the old one

charts/managed-identity-wallet/README.md

@@ -1,6 +1,6 @@
 # managed-identity-wallet
 
-![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
+![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
 
 Managed Identity Wallet is supposed to supply a secure data source and data sink for Digital Identity Documents (DID), in order to enable Self-Sovereign Identity founding on those DIDs.
 And at the same it shall support an uninterrupted tracking and tracing and documenting the usage of those DIDs, e.g., within logistical supply chains.
@@ -55,21 +55,36 @@ See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command document
 | backup.database.storage.diskSize | string | `"10G"` | Disk size for backup content |
 | backup.database.storage.keepStorage | bool | `true` | Set to true, if the PV should stay even when the chart release is uninstalled |
 | backup.database.storage.storageClassName | string | `"-"` | storageClassName |
-| envs | object | `{}` | Parameters for the application (will be provided as plain environment variables) |
+| envs | object | `{"APPLICATION_ENVIRONMENT":"dev","AUTHORITY_WALLET_BPN":"","AUTHORITY_WALLET_DID":"","AUTHORITY_WALLET_NAME":"","AUTH_SERVER_URL":"","DB_POOL_SIZE":null,"KEYCLOAK_MIW_PUBLIC_CLIENT":"","KEYCLOAK_REALM":"","MANAGEMENT_PORT":null,"MIW_HOST_NAME":"localhost","USE_SSL":false,"VC_EXPIRY_DATE":"","VC_SCHEMA_LINK":""}` | Parameters for the application (will be provided as plain environment variables) |
 | fullnameOverride | string | `""` |  |
 | image | object | `{"pullPolicy":"Always","repository":"ghcr.io/catenax-ng/tx-managed-identity-wallets_miw_service","tag":""}` | Image of the main container |
 | image.pullPolicy | string | `"Always"` | PullPolicy |
 | image.repository | string | `"ghcr.io/catenax-ng/tx-managed-identity-wallets_miw_service"` | Image repository |
 | image.tag | string | `""` | Image tag (empty one will use "appVersion" value from chart definition) |
-| imagePullSecrets | list | `[{"name":"acr-credential"}]` | Credentials for a private repo |
+| imagePullSecrets | list | `[]` | Credentials name for private repos |
 | ingress | object | `{"annotations":{},"enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | Ingress configuration |
 | nameOverride | string | `""` |  |
 | nodeSelector | object | `{"kubernetes.io/os":"linux"}` | NodeSelector configuration |
 | podAnnotations | object | `{}` | PodAnnotation configuration |
 | podSecurityContext | object | `{}` | PodSecurityContext |
+| postgresql | object | `{"auth":{"database":"miw","username":"miw"},"external":{"auth":{"existingSecret":"","existingSecretKey":"password","password":"","username":""},"config":{"database":"","host":"","port":5432}},"internal":{"enabled":true}}` | Configuration of the Postgresql database (internal and external) |
+| postgresql.auth | object | `{"database":"miw","username":"miw"}` | Default settings for the primary database and user |
+| postgresql.auth.database | string | `"miw"` | MIW database name |
+| postgresql.auth.username | string | `"miw"` | username for MIW database |
+| postgresql.external | object | `{"auth":{"existingSecret":"","existingSecretKey":"password","password":"","username":""},"config":{"database":"","host":"","port":5432}}` | Configure own postgresql database |
+| postgresql.external.auth.existingSecret | string | `""` | Existing secret with provided password |
+| postgresql.external.auth.existingSecretKey | string | `"password"` | Key name of password in secret |
+| postgresql.external.auth.password | string | `""` | DB password |
+| postgresql.external.auth.username | string | `""` | DB username |
+| postgresql.external.config | object | `{"database":"","host":"","port":5432}` | General config |
+| postgresql.external.config.database | string | `""` | Existing database to use |
+| postgresql.external.config.host | string | `""` | Instance host or IP |
+| postgresql.external.config.port | int | `5432` | Instance port |
+| postgresql.internal | object | `{"enabled":true}` | Configure bundled postgresql |
+| postgresql.internal.enabled | bool | `true` | Enable bundled database |
 | replicaCount | int | `1` | The amount of replicas to run |
 | resources | object | `{"limits":{"cpu":4,"memory":"1Gi"},"requests":{"cpu":"250m","memory":"500Mi"}}` | Resource boundaries |
-| secrets | object | `{}` | Parameters for the application (will be stored as secrets - so, for passwords, ...) |
+| secrets | object | `{"ENCRYPTION_KEY":"","KEYCLOAK_CLIENT_ID":""}` | Parameters for the application (will be stored as secrets - so, for important values, ...) |
 | securityContext | object | `{"allowPrivilegeEscalation":false,"privileged":false,"runAsGroup":11111,"runAsNonRoot":true,"runAsUser":11111}` | Preconfigured SecurityContext |
 | service | object | `{"port":8080,"type":"ClusterIP"}` | Service configuration |
 | serviceAccount | object | `{"annotations":{},"create":true,"name":""}` | ServiceAccount configuration |

charts/managed-identity-wallet/values.yaml

@@ -35,10 +35,10 @@ imagePullSecrets: []
 nameOverride: ""
 fullnameOverride: ""
 
-# -- Parameters for the application (will be stored as secrets - so, for passwords, ...)
+# -- Parameters for the application (will be stored as secrets - so, for important values, ...)
 secrets:
   KEYCLOAK_CLIENT_ID: ""
-  ENCRYPTION_KEY: ""  # 64 chars
+  ENCRYPTION_KEY: ""  # 32 chars
 
 # -- Parameters for the application (will be provided as plain environment variables)
 envs:
@@ -131,21 +131,35 @@ backup:
       # -- storageClassName
       storageClassName: "-"
 
+# -- Configuration of the Postgresql database (internal and external)
 postgresql:
+  # -- Configure bundled postgresql
   internal:
+    # -- Enable bundled database
     enabled: true
+  # -- Configure own postgresql database
   external:
+    # -- General config
     config:
+      # -- Instance host or IP
       host: ""
+      # -- Instance port
       port: 5432
+      # -- Existing database to use
       database: ""
     auth:
+      # -- DB username
       username: ""
+      # -- DB password
       password: ""
+      # -- Existing secret with provided password
       existingSecret: ""
+      # -- Key name of password in secret
       existingSecretKey: password
 
-  # @ignored
+  # -- Default settings for the primary database and user
   auth:
+    # -- username for MIW database
     username: miw
+    # -- MIW database name
     database: miw