Skip to content

Commit cd9ebef

Browse files
committed
feat: update values documentation
1 parent c791f2a commit cd9ebef

File tree

5 files changed

+14
-7
lines changed

5 files changed

+14
-7
lines changed

charts/cloudprem/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,9 @@ Portal and Console v3 are no longer sharing Oauth clients and cookies. The cooki
289289
290290
- `.global.platform.cookie` has been moved to `.global.platform.portal.oauth.cookie`
291291
- `.global.platform.membership.oauthClient` has been moved to `.global.platform.portal.oauth.client` for console backward compatibility but can be different when using console-v3.
292+
- `.console.enabled` -> `.global.platform.console.enabled`
293+
- `.membership.enabled` -> `.global.platform.membership.enabled`
294+
- `.portal.enabled` -> `.global.platform.portal.enabled`
292295

293296
## Additions
294297

@@ -422,7 +425,7 @@ Dex:
422425
| global.postgresql.host | string | `""` | Host for PostgreSQL (overrides included postgreql `host`) |
423426
| global.postgresql.service.ports.postgresql | int | `5432` | PostgreSQL service port (overrides `service.ports.postgresql`) |
424427
| global.serviceHost | string | `""` | is the base domain for portal and console |
425-
| console-v3.config.cookie.encryptionKey | string | `"changeMe00"` | is used to encrypt a cookie that share authentication between platform services (console, portal, ...),is used to store the current state organizationId-stackId |
428+
| console-v3.config.cookie.encryptionKey | string | `"changeMe00"` | is used to encrypt a cookie value |
426429
| console-v3.config.cookie.existingSecret | string | `""` | is the name of the secret |
427430
| console-v3.config.cookie.secretKeys | object | `{"encryptionKey":""}` | is the key contained within the secret |
428431
| membership.config.migration.postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials (overrides `auth.existingSecret`). |
@@ -566,7 +569,7 @@ Dex:
566569
| console-v3.ingress.annotations | object | `{}` | ingress annotations |
567570
| console-v3.ingress.className | string | `""` | ingress class name |
568571
| console-v3.ingress.enabled | bool | `true` | ingress enabled |
569-
| console-v3.ingress.hosts[0].host | string | `"{{ tpl .Values.global.platform.consoleV3.host $ }}"` | ingress host |
572+
| console-v3.ingress.hosts[0] | object | `{"host":"{{ tpl .Values.global.platform.consoleV3.host $ }}","paths":[{"path":"/","pathType":"Prefix"}]}` | ingress host |
570573
| console-v3.ingress.hosts[0].paths[0] | object | `{"path":"/","pathType":"Prefix"}` | ingress path |
571574
| console-v3.ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | ingress path type |
572575
| console-v3.ingress.tls | list | `[]` | ingress tls |

charts/cloudprem/README.md.gotmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,9 @@ Portal and Console v3 are no longer sharing Oauth clients and cookies. The cooki
291291

292292
- `.global.platform.cookie` has been moved to `.global.platform.portal.oauth.cookie`
293293
- `.global.platform.membership.oauthClient` has been moved to `.global.platform.portal.oauth.client` for console backward compatibility but can be different when using console-v3.
294+
- `.console.enabled` -> `.global.platform.console.enabled`
295+
- `.membership.enabled` -> `.global.platform.membership.enabled`
296+
- `.portal.enabled` -> `.global.platform.portal.enabled`
294297

295298
## Additions
296299

charts/console-v3/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Kubernetes: `>=1.14.0-0`
5757
| global.platform.portal.host | string | `"portal.{{ .Values.global.serviceHost }}"` | is the host for the portal |
5858
| global.platform.portal.scheme | string | `"https"` | is the scheme for the portal |
5959
| global.serviceHost | string | `""` | is the base domain for portal and console |
60-
| config.cookie.encryptionKey | string | `"changeMe00"` | is used to encrypt a cookie that share authentication between platform services (console, portal, ...),is used to store the current state organizationId-stackId |
60+
| config.cookie.encryptionKey | string | `"changeMe00"` | is used to encrypt a cookie value |
6161
| config.cookie.existingSecret | string | `""` | is the name of the secret |
6262
| config.cookie.secretKeys | object | `{"encryptionKey":""}` | is the key contained within the secret |
6363

@@ -91,7 +91,7 @@ Kubernetes: `>=1.14.0-0`
9191
| ingress.annotations | object | `{}` | ingress annotations |
9292
| ingress.className | string | `""` | ingress class name |
9393
| ingress.enabled | bool | `true` | ingress enabled |
94-
| ingress.hosts[0].host | string | `"{{ tpl .Values.global.platform.consoleV3.host $ }}"` | ingress host |
94+
| ingress.hosts[0] | object | `{"host":"{{ tpl .Values.global.platform.consoleV3.host $ }}","paths":[{"path":"/","pathType":"Prefix"}]}` | ingress host |
9595
| ingress.hosts[0].paths[0] | object | `{"path":"/","pathType":"Prefix"}` | ingress path |
9696
| ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | ingress path type |
9797
| ingress.tls | list | `[]` | ingress tls |

charts/console-v3/values.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,8 @@ ingress:
174174
# -- ingress annotations
175175
annotations: {}
176176
hosts:
177-
- # -- ingress host
178-
host: "{{ tpl .Values.global.platform.consoleV3.host $ }}"
177+
# -- ingress host
178+
- host: "{{ tpl .Values.global.platform.consoleV3.host $ }}"
179179
paths:
180180
# -- ingress path
181181
- path: /
@@ -206,7 +206,7 @@ affinity: {}
206206

207207
config:
208208
cookie:
209-
# -- is used to encrypt a cookie that share authentication between platform services (console, portal, ...),is used to store the current state organizationId-stackId
209+
# -- is used to encrypt a cookie value
210210
# @section -- Global configuration
211211
encryptionKey: "changeMe00"
212212
# -- is the name of the secret

charts/portal/values.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ global:
5151
# @section -- Global configuration
5252
host: "portal.{{ .Values.global.serviceHost }}"
5353
oauth:
54+
# Deprecated with console-v3
5455
cookie:
5556
# -- is used to encrypt a cookie that store authentication between console-v2 and portal
5657
# @section -- Global configuration

0 commit comments

Comments
 (0)