update readme

Author: andrewazores

charts/cryostat/README.md

@@ -194,7 +194,7 @@ certificate issuance and rotation.
 | `storage.buckets.names.eventTemplates`            | the name of the storage bucket containing Custom Event Templates                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | `eventtemplates`                    |
 | `storage.buckets.names.jmcAgentProbeTemplates`    | the name of the storage bucket containing JMC Agent Probe Templates                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | `probes`                            |
 | `storage.buckets.names.metadata`                  | the name of the storage bucket containing files' metadata. Only used if storage.provider.metadata.storageMode is set to 'bucket'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `metadata`                          |
-| `storage.encryption.enabled`                      | Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security                                                                                                                                                                                                                                                                                                                                                                                                                         | `true`                              |
+| `storage.encryption.enabled`                      | Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security. This is only used for the managed cryostat-storage instance and will have no effect if an external, unmanaged storage provider is configured.                                                                                                                                                                                                                                                                          | `true`                              |
 | `storage.podAnnotations`                          | Annotations to be applied to the Storage Pods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `{}`                                |
 | `storage.service.type`                            | Type of Service to create for the object storage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | `ClusterIP`                         |
 | `storage.service.port`                            | Port number to expose on the Service                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | `8333`                              |

charts/cryostat/values.schema.json

@@ -778,7 +778,7 @@
                     "properties": {
                         "enabled": {
                             "type": "boolean",
-                            "description": "Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security",
+                            "description": "Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security. This is only used for the managed cryostat-storage instance and will have no effect if an external, unmanaged storage provider is configured.",
                             "default": true
                         }
                     }

charts/cryostat/values.yaml

@@ -303,7 +303,7 @@ storage:
       ## @param storage.buckets.names.metadata the name of the storage bucket containing files' metadata. Only used if storage.provider.metadata.storageMode is set to 'bucket'.
       metadata: metadata
   encryption:
-    ## @param storage.encryption.enabled Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security
+    ## @param storage.encryption.enabled Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security. This is only used for the managed cryostat-storage instance and will have no effect if an external, unmanaged storage provider is configured.
     enabled: true
   ## @param storage.podAnnotations [object] Annotations to be applied to the Storage Pods
   podAnnotations: {}