From 4e0d9d1ea923113191b494657dcb4449bb763c9b Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Thu, 25 Apr 2024 14:04:30 +0200 Subject: [PATCH 1/4] docs: add notes to avoid break of java args Signed-off-by: Amro Misbah --- charts/janssen/values.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/charts/janssen/values.yaml b/charts/janssen/values.yaml index 76953639bea..66b6dd7e137 100644 --- 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 pass java-arguments, so please use `Mi`. 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 pass java-arguments, so please use `Mi`. memory: 1000Mi requests: # -- CPU request. @@ -557,7 +557,7 @@ fido2: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. + # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. memory: 500Mi requests: # -- CPU request. @@ -665,7 +665,7 @@ casa: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. + # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. memory: 500Mi requests: # -- CPU request. @@ -1415,7 +1415,7 @@ scim: limits: # -- CPU limit. cpu: 1000m - # -- Memory limit. + # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. memory: 1000Mi requests: # -- CPU request. @@ -1524,7 +1524,7 @@ link: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. + # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. memory: 1000Mi requests: # -- CPU request. @@ -1631,7 +1631,7 @@ saml: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. + # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. memory: 1000Mi requests: # -- CPU request. From bfe31567ffdf8bffc537a62484c82fe9e2d9eb6c Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Thu, 25 Apr 2024 14:12:12 +0200 Subject: [PATCH 2/4] docs: fix sentence Signed-off-by: Amro Misbah --- .../charts/auth-server-key-rotation/templates/cronjobs.yaml | 2 +- charts/janssen/charts/auth-server/templates/deployment.yml | 2 +- charts/janssen/charts/casa/templates/deployment.yaml | 2 +- charts/janssen/charts/config-api/templates/deployment.yaml | 2 +- charts/janssen/charts/fido2/templates/deployment.yml | 2 +- charts/janssen/charts/link/templates/deployment.yaml | 2 +- charts/janssen/charts/saml/templates/deployment.yaml | 2 +- charts/janssen/charts/scim/templates/deployment.yml | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/charts/janssen/charts/auth-server-key-rotation/templates/cronjobs.yaml b/charts/janssen/charts/auth-server-key-rotation/templates/cronjobs.yaml index 26a00230ddc..8f8042d9d9e 100644 --- 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 index 09951ceae3c..398024788a3 100644 --- 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 index 3f132229a10..beef142ae6d 100644 --- 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 index f7047cbd822..151268fec3b 100644 --- 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 index 1c29be01a0c..70f9f6afdab 100644 --- 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 index f257ae7131c..044404617ce 100644 --- 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 index 8f6b22c3cf0..5551be7b68d 100644 --- 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 index 1b5b6edf124..9625597402d 100644 --- 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 }} From 8a6d2ae3ca1006d56ea4b1b2c07b42426049ca0d Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Mon, 29 Apr 2024 15:09:29 +0300 Subject: [PATCH 3/4] docs: update note Signed-off-by: Amro Misbah --- charts/janssen/values.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/charts/janssen/values.yaml b/charts/janssen/values.yaml index 66b6dd7e137..1be7b13bbc9 100644 --- a/charts/janssen/values.yaml +++ b/charts/janssen/values.yaml @@ -57,7 +57,7 @@ auth-server: limits: # -- CPU limit. cpu: 2500m - # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. @@ -1415,7 +1415,7 @@ scim: limits: # -- CPU limit. cpu: 1000m - # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. @@ -1524,7 +1524,7 @@ link: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. @@ -1631,7 +1631,7 @@ saml: limits: # -- CPU limit. cpu: 500m - # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. + # -- 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. From 5c29cdf2b1a8e9d7a8e6924f660be82cbd0d4efb Mon Sep 17 00:00:00 2001 From: Amro Misbah Date: Mon, 29 Apr 2024 21:17:16 +0300 Subject: [PATCH 4/4] docs: update README Signed-off-by: Amro Misbah --- charts/janssen/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/charts/janssen/README.md b/charts/janssen/README.md index 7886279140c..4b0ebbb7656 100644 --- a/charts/janssen/README.md +++ b/charts/janssen/README.md @@ -85,7 +85,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/ | @@ -115,7 +115,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/ | @@ -145,7 +145,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/ | @@ -262,7 +262,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. | @@ -452,7 +452,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/ | @@ -566,7 +566,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/ | @@ -595,7 +595,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. |