diff --git a/README.md b/README.md index 5bb4f1e9e22420664ffe37529acbc729f9aca31d..62f64419835666252c691d58d17aab3c42fa4afd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # nmaas -  +  GÉANT Network Management as a Service Helm chart for Kubernetes @@ -103,6 +103,11 @@ GÉANT Network Management as a Service Helm chart for Kubernetes | platform.properties.helm.useLocalCharts | bool | `false` | | | platform.properties.helm.username | string | `"helm"` | | | platform.properties.helm.version | string | `"v3"` | | +| platform.properties.jwt.resetKey.literal | string | `""` | leave empty to use existing secret | +| platform.properties.jwt.resetKey.secret.key | string | `nil` | | +| platform.properties.jwt.secretName | string | `"nmaas-jwt"` | | +| platform.properties.jwt.signingKey.literal | string | `""` | leave empty to use existing secret | +| platform.properties.jwt.signingKey.secret.key | string | `nil` | | | platform.properties.k8s.deployment.defaultNamespace | string | `"default"` | parameter used only if USE_DEFAULT_NAMESPACE option is set | | platform.properties.k8s.deployment.defaultStorageClass | string | `nil` | should be left blank if default storage class was defined defined at cluster should be used | | platform.properties.k8s.deployment.namespaceConfigOption | string | `"USE_DOMAIN_NAMESPACE"` | two options possible: USE_DOMAIN_NAMESPACE or USE_DEFAULT_NAMESPACE | @@ -117,6 +122,12 @@ GÉANT Network Management as a Service Helm chart for Kubernetes | platform.properties.k8s.ingress.controller.tlsSupported | bool | `true` | flag indicating if ingress controller(s) support TLS | | platform.properties.maintenance | bool | `false` | | | platform.properties.nmaasMetricsEnabled | bool | `true` | expose Prometheus metrics | +| platform.properties.oidc.clientId | string | `""` | | +| platform.properties.oidc.clientSecret.literal | string | `""` | leave empty to use existing secret | +| platform.properties.oidc.clientSecret.secret.key | string | `"oidcClientSecret"` | | +| platform.properties.oidc.enabled | bool | `false` | | +| platform.properties.oidc.issuerUri | string | `"https://auth.example.com/realms/master"` | | +| platform.properties.oidc.secretName | string | `"nmaas-oidc"` | | | platform.properties.postgresql | object | `{"database":"nmaas","hostname":"nmaas-postgresql","password":{"literal":"","secret":{"key":"secret","name":"nmaas-postgresql-secret"}},"port":5432,"username":"nmaas"}` | only required if an external postgresql instance is used (when postgresql.install is false) | | platform.properties.postgresql.password.literal | string | `""` | leave empty to use existing secret specified below | | platform.properties.sendAppInstanceFailureEmails | bool | `false` | | @@ -129,13 +140,6 @@ GÉANT Network Management as a Service Helm chart for Kubernetes | platform.properties.smtp.defaultDomain | string | `"example.com"` | exposed as SMTP_FROM_DEFAULT_DOMAIN in global deployment parameters | | platform.properties.smtp.from | string | `""` | override default SMTP from value | | platform.properties.smtp.host | string | `"nmaas-postfix"` | | -| platform.properties.sso.enabled | bool | `false` | | -| platform.properties.sso.encryptionSecret.literal | string | `""` | leave empty to use existing secret specified below | -| platform.properties.sso.encryptionSecret.secret.key | string | `"secret"` | | -| platform.properties.sso.encryptionSecret.secret.name | string | `"nmaas-sp-secret"` | must be created manually if literal is empty | -| platform.properties.sso.timeout | int | `15` | | -| platform.properties.sso.urlLogin | string | `""` | | -| platform.properties.sso.urlLogout | string | `""` | | | platform.properties.testInstance | bool | `false` | | | platform.readinessProbe.failureThreshold | int | `10` | | | platform.readinessProbe.httpGet.path | string | `"/actuator/health"` | | @@ -179,22 +183,6 @@ GÉANT Network Management as a Service Helm chart for Kubernetes | postfix.type | string | `"ClusterIP"` | | | postgresql | object | `{"install":true,"persistence":{"enabled":true,"size":"8Gi"},"postgresqlDatabase":"nmaas","postgresqlPassword":"nmaas","postgresqlUsername":"nmaas"}` | settings for in-cluster postgresql | | replicaCount | int | `1` | | -| sp.enabled | bool | `false` | | -| sp.image.pullPolicy | string | `"Always"` | | -| sp.image.repository | string | `"artifactory.software.geant.org/nmaas-docker-local/nmaas-sp"` | | -| sp.image.tag | string | `"1.6.3"` | | -| sp.ingress.className | string | `""` | defaults to .Values.platform.properties.k8s.ingress.controller.ingressClass if not set | -| sp.name | string | `"nmaas-sp"` | | -| sp.port | int | `443` | | -| sp.properties.idp.entityId | string | `"https://keycloak.example.com/realms/master"` | | -| sp.properties.idp.metadataUrl | string | `"https://keycloak.example.com/realms/master/protocol/saml/descriptor"` | | -| sp.properties.idp.name | string | `"edugain"` | | -| sp.properties.idp.remoteUser | string | `"email"` | | -| sp.properties.idp.uri | string | `"https://login.terena.org/wayf/saml2/idp/metadata.php"` | | -| sp.properties.idp.userId | string | `"uid"` | | -| sp.targetPort | int | `80` | | -| sp.tls | bool | `true` | | -| sp.type | string | `"ClusterIP"` | | ---------------------------------------------- Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)