From c819e09d6e7d30070532c26dab8ae704ed1df6b6 Mon Sep 17 00:00:00 2001 From: iromli Date: Thu, 9 Jan 2025 02:37:01 +0700 Subject: [PATCH] docs(charts): mention about empty configuration key Signed-off-by: iromli --- charts/janssen-all-in-one/README.md | 4 ++-- charts/janssen-all-in-one/values.yaml | 4 ++-- charts/janssen/README.md | 4 ++-- charts/janssen/values.yaml | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/charts/janssen-all-in-one/README.md b/charts/janssen-all-in-one/README.md index 177de3bf98e..493ac3fbb3c 100644 --- a/charts/janssen-all-in-one/README.md +++ b/charts/janssen-all-in-one/README.md @@ -134,8 +134,8 @@ Kubernetes: `>=v1.22.0-0` | cnConfiguratorCustomSchema | object | `{"secretName":""}` | Use custom configuration schema in existing secrets. Note, the secrets has to contain the key configuration.json or any basename as specified in cnConfiguratorConfigurationFile. | | cnConfiguratorCustomSchema.secretName | string | `""` | The name of the secrets used for storing custom configuration schema. | | cnConfiguratorDumpFile | string | `"/etc/jans/conf/configuration.out.json"` | Path to dumped configuration schema file | -| cnConfiguratorKey | string | `""` | Key to encrypt/decrypt configuration schema file | -| cnConfiguratorKeyFile | string | `"/etc/jans/conf/configuration.key"` | Path to file contains key to encrypt/decrypt configuration schema file | +| cnConfiguratorKey | string | `""` | Key to encrypt/decrypt configuration schema file (if empty, encryption/decryption will be skipped). | +| cnConfiguratorKeyFile | string | `"/etc/jans/conf/configuration.key"` | Path to file contains key to encrypt/decrypt configuration schema file. | | cnDocumentStoreType | string | `"DB"` | Document store type to use for shibboleth files DB. | | cnGoogleApplicationCredentials | string | `"/etc/jans/conf/google-credentials.json"` | Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets. Leave as this is a sensible default. | | cnPersistenceType | string | `"sql"` | Persistence backend to run Janssen with hybrid|sql. | diff --git a/charts/janssen-all-in-one/values.yaml b/charts/janssen-all-in-one/values.yaml index a85b87bec4c..b0b14678663 100644 --- a/charts/janssen-all-in-one/values.yaml +++ b/charts/janssen-all-in-one/values.yaml @@ -573,9 +573,9 @@ cnConfiguratorDumpFile: /etc/jans/conf/configuration.out.json cnConfiguratorCustomSchema: # -- The name of the secrets used for storing custom configuration schema. secretName: "" -# -- Key to encrypt/decrypt configuration schema file +# -- Key to encrypt/decrypt configuration schema file (if empty, encryption/decryption will be skipped). cnConfiguratorKey: "" -# -- Path to file contains key to encrypt/decrypt configuration schema file +# -- Path to file contains key to encrypt/decrypt configuration schema file. cnConfiguratorKeyFile: /etc/jans/conf/configuration.key # ingress properties diff --git a/charts/janssen/README.md b/charts/janssen/README.md index dace5dfbef5..698cb34c0cd 100644 --- a/charts/janssen/README.md +++ b/charts/janssen/README.md @@ -344,8 +344,8 @@ Kubernetes: `>=v1.22.0-0` | global.cnConfiguratorCustomSchema | object | `{"secretName":""}` | Use custom configuration schema in existing secrets. Note, the secrets has to contain the key configuration.json or any basename as specified in cnConfiguratorConfigurationFile. | | global.cnConfiguratorCustomSchema.secretName | string | `""` | The name of the secrets used for storing custom configuration schema. | | global.cnConfiguratorDumpFile | string | `"/etc/jans/conf/configuration.out.json"` | Path to dumped configuration schema file | -| global.cnConfiguratorKey | string | `""` | Key to encrypt/decrypt configuration schema file | -| global.cnConfiguratorKeyFile | string | `"/etc/jans/conf/configuration.key"` | Path to file contains key to encrypt/decrypt configuration schema file | +| global.cnConfiguratorKey | string | `""` | Key to encrypt/decrypt configuration schema file (if empty, encryption/decryption will be skipped). | +| global.cnConfiguratorKeyFile | string | `"/etc/jans/conf/configuration.key"` | Path to file contains key to encrypt/decrypt configuration schema file. | | global.cnDocumentStoreType | string | `"DB"` | Document store type to use for shibboleth files DB. | | global.cnGoogleApplicationCredentials | string | `"/etc/jans/conf/google-credentials.json"` | Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets. Leave as this is a sensible default. | | global.cnPersistenceType | string | `"sql"` | Persistence backend to run Janssen with hybrid|sql | diff --git a/charts/janssen/values.yaml b/charts/janssen/values.yaml index 6d4e38d7b69..01b380daa57 100644 --- a/charts/janssen/values.yaml +++ b/charts/janssen/values.yaml @@ -1203,9 +1203,9 @@ global: cnConfiguratorCustomSchema: # -- The name of the secrets used for storing custom configuration schema. secretName: "" - # -- Key to encrypt/decrypt configuration schema file + # -- Key to encrypt/decrypt configuration schema file (if empty, encryption/decryption will be skipped). cnConfiguratorKey: "" - # -- Path to file contains key to encrypt/decrypt configuration schema file + # -- Path to file contains key to encrypt/decrypt configuration schema file. cnConfiguratorKeyFile: /etc/jans/conf/configuration.key # -- Nginx ingress definitions chart