docs: add note on memory limit to avoid java args break (#8379)

JanssenProject · May 14, 2024 · a4787a1 · a4787a1
1 parent 4a6f061
commit a4787a1
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 22 deletions.
diff --git a/charts/janssen/README.md b/charts/janssen/README.md
@@ -86,7 +86,7 @@ Kubernetes: `>=v1.22.0-0`
 | auth-server.replicas | int | `1` | Service replica number. |
 | auth-server.resources | object | `{"limits":{"cpu":"2500m","memory":"2500Mi"},"requests":{"cpu":"2500m","memory":"2500Mi"}}` | Resource specs. |
 | auth-server.resources.limits.cpu | string | `"2500m"` | CPU limit. |
-| auth-server.resources.limits.memory | string | `"2500Mi"` | Memory limit. |
+| auth-server.resources.limits.memory | string | `"2500Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | auth-server.resources.requests.cpu | string | `"2500m"` | CPU request. |
 | auth-server.resources.requests.memory | string | `"2500Mi"` | Memory request. |
 | auth-server.topologySpreadConstraints | object | `{}` | Configure the topology spread constraints. Notice this is a map NOT a list as in the upstream API https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ |
@@ -116,7 +116,7 @@ Kubernetes: `>=v1.22.0-0`
 | casa.replicas | int | `1` | Service replica number. |
 | casa.resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"500m","memory":"500Mi"}}` | Resource specs. |
 | casa.resources.limits.cpu | string | `"500m"` | CPU limit. |
-| casa.resources.limits.memory | string | `"500Mi"` | Memory limit. |
+| casa.resources.limits.memory | string | `"500Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | casa.resources.requests.cpu | string | `"500m"` | CPU request. |
 | casa.resources.requests.memory | string | `"500Mi"` | Memory request. |
 | casa.topologySpreadConstraints | object | `{}` | Configure the topology spread constraints. Notice this is a map NOT a list as in the upstream API https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ |
@@ -146,7 +146,7 @@ Kubernetes: `>=v1.22.0-0`
 | config-api.replicas | int | `1` | Service replica number. |
 | config-api.resources | object | `{"limits":{"cpu":"1000m","memory":"1000Mi"},"requests":{"cpu":"1000m","memory":"1000Mi"}}` | Resource specs. |
 | config-api.resources.limits.cpu | string | `"1000m"` | CPU limit. |
-| config-api.resources.limits.memory | string | `"1000Mi"` | Memory limit. |
+| config-api.resources.limits.memory | string | `"1000Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | config-api.resources.requests.cpu | string | `"1000m"` | CPU request. |
 | config-api.resources.requests.memory | string | `"1000Mi"` | Memory request. |
 | config-api.topologySpreadConstraints | object | `{}` | Configure the topology spread constraints. Notice this is a map NOT a list as in the upstream API https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ |
@@ -263,7 +263,7 @@ Kubernetes: `>=v1.22.0-0`
 | fido2.replicas | int | `1` | Service replica number. |
 | fido2.resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"500m","memory":"500Mi"}}` | Resource specs. |
 | fido2.resources.limits.cpu | string | `"500m"` | CPU limit. |
-| fido2.resources.limits.memory | string | `"500Mi"` | Memory limit. |
+| fido2.resources.limits.memory | string | `"500Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | fido2.resources.requests.cpu | string | `"500m"` | CPU request. |
 | fido2.resources.requests.memory | string | `"500Mi"` | Memory request. |
 | fido2.service.name | string | `"http-fido2"` | The name of the fido2 port within the fido2 service. Please keep it as default. |
@@ -475,7 +475,7 @@ Kubernetes: `>=v1.22.0-0`
 | link.replicas | int | `1` | Service replica number. |
 | link.resources | object | `{"limits":{"cpu":"500m","memory":"1000Mi"},"requests":{"cpu":"500m","memory":"1000Mi"}}` | Resource specs. |
 | link.resources.limits.cpu | string | `"500m"` | CPU limit. |
-| link.resources.limits.memory | string | `"1000Mi"` | Memory limit. |
+| link.resources.limits.memory | string | `"1000Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | link.resources.requests.cpu | string | `"500m"` | CPU request. |
 | link.resources.requests.memory | string | `"1000Mi"` | Memory request. |
 | link.topologySpreadConstraints | object | `{}` | Configure the topology spread constraints. Notice this is a map NOT a list as in the upstream API https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ |
@@ -589,7 +589,7 @@ Kubernetes: `>=v1.22.0-0`
 | saml.replicas | int | `1` | Service replica number. |
 | saml.resources | object | `{"limits":{"cpu":"500m","memory":"1000Mi"},"requests":{"cpu":"500m","memory":"1000Mi"}}` | Resource specs. |
 | saml.resources.limits.cpu | string | `"500m"` | CPU limit. |
-| saml.resources.limits.memory | string | `"1000Mi"` | Memory limit. |
+| saml.resources.limits.memory | string | `"1000Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | saml.resources.requests.cpu | string | `"500m"` | CPU request. |
 | saml.resources.requests.memory | string | `"1000Mi"` | Memory request. |
 | saml.topologySpreadConstraints | object | `{}` | Configure the topology spread constraints. Notice this is a map NOT a list as in the upstream API https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ |
@@ -618,7 +618,7 @@ Kubernetes: `>=v1.22.0-0`
 | scim.readinessProbe.httpGet.path | string | `"/jans-scim/sys/health-check"` | http readiness probe endpoint |
 | scim.replicas | int | `1` | Service replica number. |
 | scim.resources.limits.cpu | string | `"1000m"` | CPU limit. |
-| scim.resources.limits.memory | string | `"1000Mi"` | Memory limit. |
+| scim.resources.limits.memory | string | `"1000Mi"` | Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. |
 | scim.resources.requests.cpu | string | `"1000m"` | CPU request. |
 | scim.resources.requests.memory | string | `"1000Mi"` | Memory request. |
 | scim.service.name | string | `"http-scim"` | The name of the scim port within the scim service. Please keep it as default. |

diff --git a/charts/janssen/charts/auth-server-key-rotation/templates/cronjobs.yaml b/charts/janssen/charts/auth-server-key-rotation/templates/cronjobs.yaml
@@ -169,7 +169,7 @@ spec:
               secret:
                 secretName: {{ .Release.Name }}-cb-pass
                 items:
-                  # we are mostly need non-superuser couchbase password file here
+                  # we mostly need non-superuser couchbase password file here
                   - key: couchbase_password
                     path: couchbase_password
           {{- end }}

diff --git a/charts/janssen/charts/auth-server/templates/deployment.yml b/charts/janssen/charts/auth-server/templates/deployment.yml
@@ -209,7 +209,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/casa/templates/deployment.yaml b/charts/janssen/charts/casa/templates/deployment.yaml
@@ -208,7 +208,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/config-api/templates/deployment.yaml b/charts/janssen/charts/config-api/templates/deployment.yaml
@@ -195,7 +195,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/fido2/templates/deployment.yml b/charts/janssen/charts/fido2/templates/deployment.yml
@@ -210,7 +210,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/link/templates/deployment.yaml b/charts/janssen/charts/link/templates/deployment.yaml
@@ -195,7 +195,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/saml/templates/deployment.yaml b/charts/janssen/charts/saml/templates/deployment.yaml
@@ -215,7 +215,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/charts/scim/templates/deployment.yml b/charts/janssen/charts/scim/templates/deployment.yml
@@ -209,7 +209,7 @@ spec:
           secret:
             secretName: {{ .Release.Name }}-cb-pass
             items:
-              # we are mostly need non-superuser couchbase password file here
+              # we mostly need non-superuser couchbase password file here
               - key: couchbase_password
                 path: couchbase_password
       {{- end }}

diff --git a/charts/janssen/values.yaml b/charts/janssen/values.yaml
@@ -57,7 +57,7 @@ auth-server:
     limits:
       # -- CPU limit.
       cpu: 2500m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 2500Mi
     requests:
       # -- CPU request.
@@ -454,7 +454,7 @@ config-api:
     limits:
       # -- CPU limit.
       cpu: 1000m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 1000Mi
     requests:
       # -- CPU request.
@@ -557,7 +557,7 @@ fido2:
     limits:
       # -- CPU limit.
       cpu: 500m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 500Mi
     requests:
       # -- CPU request.
@@ -665,7 +665,7 @@ casa:
     limits:
       # -- CPU limit.
       cpu: 500m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 500Mi
     requests:
       # -- CPU request.
@@ -1418,7 +1418,7 @@ scim:
     limits:
       # -- CPU limit.
       cpu: 1000m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 1000Mi
     requests:
       # -- CPU request.
@@ -1527,7 +1527,7 @@ link:
     limits:
       # -- CPU limit.
       cpu: 500m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 1000Mi
     requests:
       # -- CPU request.
@@ -1634,7 +1634,7 @@ saml:
     limits:
       # -- CPU limit.
       cpu: 500m
-      # -- Memory limit.
+      # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units.
       memory: 1000Mi
     requests:
       # -- CPU request.