diff --git a/charts/account-operator-crds/README.md b/charts/account-operator-crds/README.md index 2f54e9ca1..266763f9c 100644 --- a/charts/account-operator-crds/README.md +++ b/charts/account-operator-crds/README.md @@ -4,9 +4,9 @@ A Helm chart for Kubernetes ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| kcp.enabled | bool | `false` | Enable KCP | +| Key | Type | Default | Description | +| ----------- | ---- | ------- | ----------- | +| kcp.enabled | bool | `false` | Enable KCP | ## Overriding Values @@ -17,12 +17,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/account-operator/README.md b/charts/account-operator/README.md index 600b57574..4e00f3d78 100644 --- a/charts/account-operator/README.md +++ b/charts/account-operator/README.md @@ -6,35 +6,35 @@ A Helm chart to deploy OpenMFP Account-Operator ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| -| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)| +| Repository | Name | Description | Sources | +| ----------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) | +| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| crds.enabled | bool | `true` | Enable CRDs | -| deployment.specTemplate.annotations | object | `{}` | The annotations for the deployment | -| deployment.specTemplate.labels | object | `{}` | The labels for the deployment | -| image.name | string | `"ghcr.io/openmfp/account-operator"` | The image repository | -| image.tag | string | `"latest"` | The image tag | -| kcp | object | `{"enabled":false,"virtualWorkspaceUrl":""}` | The KCP configuration | -| kcp.enabled | bool | `false` | Enable KCP | -| kcp.virtualWorkspaceUrl | string | `""` | The URL for the virtual workspace | -| kubeconfigSecret | string | `""` | The secret for kubeconfig | -| logLevel | string | `"warn"` | The log level | -| security.mountServiceAccountToken | bool | `false` | Mount the service account token | -| subroutines.extension.enabled | bool | `true` | Enable extension subroutines | -| subroutines.extensionReady.enabled | bool | `true` | Enable extension ready subroutines | -| subroutines.fga.creatorRelation | string | `"owner"` | The creator relation for FGA | -| subroutines.fga.enabled | bool | `true` | Enable FGA subroutines | -| subroutines.fga.grpcAddr | string | `""` | The gRPC address for FGA | -| subroutines.fga.objectType | string | `"account"` | The object type for FGA | -| subroutines.fga.parentRelation | string | `"parent"` | The parent relation for FGA | -| subroutines.fga.rootNamespace | string | `"openmfp-root"` | The root namespace for FGA | -| subroutines.namespace.enabled | bool | `true` | Enable namespace subroutines | -| webhooks.certDir | string | `"/certs"` | The directory for webhook certificates | -| webhooks.enabled | bool | `false` | Enable webhooks | +| Key | Type | Default | Description | +| ----------------------------------- | ------ | -------------------------------------------- | -------------------------------------- | +| crds.enabled | bool | `true` | Enable CRDs | +| deployment.specTemplate.annotations | object | `{}` | The annotations for the deployment | +| deployment.specTemplate.labels | object | `{}` | The labels for the deployment | +| image.name | string | `"ghcr.io/openmfp/account-operator"` | The image repository | +| image.tag | string | `"latest"` | The image tag | +| kcp | object | `{"enabled":false,"virtualWorkspaceUrl":""}` | The KCP configuration | +| kcp.enabled | bool | `false` | Enable KCP | +| kcp.virtualWorkspaceUrl | string | `""` | The URL for the virtual workspace | +| kubeconfigSecret | string | `""` | The secret for kubeconfig | +| logLevel | string | `"warn"` | The log level | +| security.mountServiceAccountToken | bool | `false` | Mount the service account token | +| subroutines.extension.enabled | bool | `true` | Enable extension subroutines | +| subroutines.extensionReady.enabled | bool | `true` | Enable extension ready subroutines | +| subroutines.fga.creatorRelation | string | `"owner"` | The creator relation for FGA | +| subroutines.fga.enabled | bool | `true` | Enable FGA subroutines | +| subroutines.fga.grpcAddr | string | `""` | The gRPC address for FGA | +| subroutines.fga.objectType | string | `"account"` | The object type for FGA | +| subroutines.fga.parentRelation | string | `"parent"` | The parent relation for FGA | +| subroutines.fga.rootNamespace | string | `"openmfp-root"` | The root namespace for FGA | +| subroutines.namespace.enabled | bool | `true` | Enable namespace subroutines | +| webhooks.certDir | string | `"/certs"` | The directory for webhook certificates | +| webhooks.enabled | bool | `false` | Enable webhooks | ## Overriding Values @@ -45,12 +45,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/common/README.md b/charts/common/README.md index d6cce4b2d..7c8cfdffc 100644 --- a/charts/common/README.md +++ b/charts/common/README.md @@ -4,31 +4,31 @@ A Helm chart containing reuse templates ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager | -| defaults.deployment.maxSurge | int | `5` | maxSurge | -| defaults.deployment.maxUnavailable | int | `0` | maxUnavailable | -| defaults.deployment.resources.limits | object | `{"cpu":"100m","memory":"512Mi"}` | cpu and memory limits for the deployment | -| defaults.deployment.resources.requests | object | `{"cpu":"40m","memory":"50Mi"}` | cpu and memory requests for the deployment | -| defaults.deployment.revisionHistoryLimit | int | `3` | deployment revision history limit | -| defaults.deployment.strategy | string | `"RollingUpdate"` | deployment strategy | -| defaults.externalSecrets.enabled | bool | `true` | toggle to enable/disable external-secrets | -| defaults.fga.enabled | bool | `false` | toggle to enable/disable experimental FGA features | -| defaults.health.liveness | object | `{"failureThreshold":1,"path":"/healthz"}` | liveness probe parameters | -| defaults.health.periodSeconds | int | `10` | health period | -| defaults.health.port | int | `8081` | health port | -| defaults.health.readiness | object | `{"initialDelaySeconds":5,"path":"/readyz","periodSeconds":10}` | readiness probe parameters | -| defaults.health.startup | object | `{"failureThreshold":30,"path":"/readyz"}` | startup probe parameters | -| defaults.imagePullPolicy | string | `"Always"` | imagePullPolicy is the policy to use when pulling images for all charts | -| defaults.imagePullSecret | string | `"github"` | imagePullSecret is the name of the secret that holds the docker registry credentials | -| defaults.istio.enabled | bool | `false` | toggle to enable/disable istio | -| defaults.istio.gateway.name | string | `"gateway"` | name of the gateway | -| defaults.metrics.port | int | `8080` | metrics port | -| defaults.port | int | `8080` | service port | -| defaults.securityContext.fsGroup | int | `2000` | fsGroup id to run the container | -| defaults.securityContext.runAsGroup | int | `3000` | group id to run the container | -| defaults.securityContext.runAsUser | int | `1000` | user id to run the container | +| Key | Type | Default | Description | +| ---------------------------------------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager | +| defaults.deployment.maxSurge | int | `5` | maxSurge | +| defaults.deployment.maxUnavailable | int | `0` | maxUnavailable | +| defaults.deployment.resources.limits | object | `{"cpu":"100m","memory":"512Mi"}` | cpu and memory limits for the deployment | +| defaults.deployment.resources.requests | object | `{"cpu":"40m","memory":"50Mi"}` | cpu and memory requests for the deployment | +| defaults.deployment.revisionHistoryLimit | int | `3` | deployment revision history limit | +| defaults.deployment.strategy | string | `"RollingUpdate"` | deployment strategy | +| defaults.externalSecrets.enabled | bool | `true` | toggle to enable/disable external-secrets | +| defaults.fga.enabled | bool | `false` | toggle to enable/disable experimental FGA features | +| defaults.health.liveness | object | `{"failureThreshold":1,"path":"/healthz"}` | liveness probe parameters | +| defaults.health.periodSeconds | int | `10` | health period | +| defaults.health.port | int | `8081` | health port | +| defaults.health.readiness | object | `{"initialDelaySeconds":5,"path":"/readyz","periodSeconds":10}` | readiness probe parameters | +| defaults.health.startup | object | `{"failureThreshold":30,"path":"/readyz"}` | startup probe parameters | +| defaults.imagePullPolicy | string | `"Always"` | imagePullPolicy is the policy to use when pulling images for all charts | +| defaults.imagePullSecret | string | `"github"` | imagePullSecret is the name of the secret that holds the docker registry credentials | +| defaults.istio.enabled | bool | `false` | toggle to enable/disable istio | +| defaults.istio.gateway.name | string | `"gateway"` | name of the gateway | +| defaults.metrics.port | int | `8080` | metrics port | +| defaults.port | int | `8080` | service port | +| defaults.securityContext.fsGroup | int | `2000` | fsGroup id to run the container | +| defaults.securityContext.runAsGroup | int | `3000` | group id to run the container | +| defaults.securityContext.runAsUser | int | `1000` | user id to run the container | ## Overriding Values @@ -39,12 +39,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/example-content/README.md b/charts/example-content/README.md index 1bad735fa..890256d13 100644 --- a/charts/example-content/README.md +++ b/charts/example-content/README.md @@ -4,17 +4,17 @@ Helm Chart for the openmfp Portal ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| +| Repository | Name | Description | Sources | +| ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| contentConfigurations.home | bool | `true` | This content configuration enables a basic homepage in the portal | -| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name | -| istio.virtualService.hosts[0] | string | `"your-host.com"` | | -| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` | | -| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` | | +| Key | Type | Default | Description | +| ---------------------------------------------------- | ------ | ----------------------------------- | ----------------------------------------------------------------- | +| contentConfigurations.home | bool | `true` | This content configuration enables a basic homepage in the portal | +| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name | +| istio.virtualService.hosts[0] | string | `"your-host.com"` | | +| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` | | +| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` | | ## Overriding Values @@ -25,12 +25,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/extension-manager-operator-crds/README.md b/charts/extension-manager-operator-crds/README.md index b055b416e..a74aa7966 100644 --- a/charts/extension-manager-operator-crds/README.md +++ b/charts/extension-manager-operator-crds/README.md @@ -5,7 +5,7 @@ A Helm chart for Kubernetes ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ## Values | Key | Type | Default | Description | -|-----|------|---------|-------------| +| --- | ---- | ------- | ----------- | ## Overriding Values @@ -16,12 +16,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/infra/README.md b/charts/infra/README.md index cf28d2a04..28c39e506 100644 --- a/charts/infra/README.md +++ b/charts/infra/README.md @@ -6,21 +6,21 @@ The infra openmfp chart configures a number of common infrastructure components ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| +| Repository | Name | Description | Sources | +| ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| fga.stores | list | `[]` | The list of FGA stores to be created | -| istio.gateway.annotations | object | `{}` | Annotations to be applied to the istio gateway | -| istio.gateway.apiVersion | string | `nil` | The istio apiVersion of the gateway resource eg, networking.istio.io/v1, networking.istio.io/v1beta1 | -| istio.gateway.name | string | `"gateway"` | The name of the istio gateway resource | -| istio.gateway.selector.istio | string | `"gateway"` | The istio ingress gateway selector | -| istio.gateway.servers | list | `[{"hosts":["*"],"port":{"name":"http","number":8080,"protocol":"HTTP"}}]` | The "servers" section of the istio gateway. By default it is configured for a local kind setup. Adjust to be a https port for productive deployments | -| istio.networking.apiVersion | string | `"networking.istio.io/v1"` | The istio apiVersion used for networking resources in this chart eg. networking.istio.io/v1, networking.istio.io/v1beta1 | -| istio.serviceEntries.https.enabled | bool | `false` | A toggle to enable the service entries for external https communication | -| istio.serviceEntries.https.hosts | list | `[]` | The list of hosts to be added to the service entry | +| Key | Type | Default | Description | +| ---------------------------------- | ------ | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| fga.stores | list | `[]` | The list of FGA stores to be created | +| istio.gateway.annotations | object | `{}` | Annotations to be applied to the istio gateway | +| istio.gateway.apiVersion | string | `nil` | The istio apiVersion of the gateway resource eg, networking.istio.io/v1, networking.istio.io/v1beta1 | +| istio.gateway.name | string | `"gateway"` | The name of the istio gateway resource | +| istio.gateway.selector.istio | string | `"gateway"` | The istio ingress gateway selector | +| istio.gateway.servers | list | `[{"hosts":["*"],"port":{"name":"http","number":8080,"protocol":"HTTP"}}]` | The "servers" section of the istio gateway. By default it is configured for a local kind setup. Adjust to be a https port for productive deployments | +| istio.networking.apiVersion | string | `"networking.istio.io/v1"` | The istio apiVersion used for networking resources in this chart eg. networking.istio.io/v1, networking.istio.io/v1beta1 | +| istio.serviceEntries.https.enabled | bool | `false` | A toggle to enable the service entries for external https communication | +| istio.serviceEntries.https.hosts | list | `[]` | The list of hosts to be added to the service entry | ## Overriding Values @@ -31,12 +31,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/keycloak/README.md b/charts/keycloak/README.md index f9979d0b1..c0a9aae38 100644 --- a/charts/keycloak/README.md +++ b/charts/keycloak/README.md @@ -6,72 +6,72 @@ A Helm chart to deploy keycloak as OIDC provider in openmfp ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://registry-1.docker.io/bitnamicharts` | `keycloak` | The open source bitnami keycloak chart to deploy keycloak. | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | -| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| +| Repository | Name | Description | Sources | +| ------------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| `oci://registry-1.docker.io/bitnamicharts` | `keycloak` | The open source bitnami keycloak chart to deploy keycloak. | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | +| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| crossplane.clients.openmfp.name | string | `"OpenMFP"` | name of the client | -| crossplane.clients.openmfp.validRedirectUris | list | `["http://localhost:8000/callback*"]` | valid redirect uris for the client | -| crossplane.clients.openmfp.validRedirectUris[0] | string | `"http://localhost:8000/callback*"` | keycloak callback url | -| crossplane.enabled | bool | `false` | toggle to enable/disable crossplane | -| crossplane.identityProviders | object | `{"sap":{"authorizationUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize","clientId":"82b4c72c-ff99-4df6-ba4f-fb634d1fc491","clientSecretRef":{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"},"clientSecretRemoteRef":"dxp-core-team/manual-secrets/sap-client-secret","issuer":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0","tokenUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"}}` | crossplane identity providers config | -| crossplane.identityProviders.sap | object | `{"authorizationUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize","clientId":"82b4c72c-ff99-4df6-ba4f-fb634d1fc491","clientSecretRef":{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"},"clientSecretRemoteRef":"dxp-core-team/manual-secrets/sap-client-secret","issuer":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0","tokenUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"}` | sap IDP | -| crossplane.identityProviders.sap.authorizationUrl | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize"` | authorization URL | -| crossplane.identityProviders.sap.clientId | string | `"82b4c72c-ff99-4df6-ba4f-fb634d1fc491"` | client id | -| crossplane.identityProviders.sap.clientSecretRef | object | `{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"}` | client secret | -| crossplane.identityProviders.sap.clientSecretRef.key | string | `"client-secret"` | secret key | -| crossplane.identityProviders.sap.clientSecretRef.name | string | `"sap-client-secret"` | secret name | -| crossplane.identityProviders.sap.clientSecretRef.namespace | string | `"openmfp-system"` | secret namespace | -| crossplane.identityProviders.sap.clientSecretRemoteRef | string | `"dxp-core-team/manual-secrets/sap-client-secret"` | user info URL | -| crossplane.identityProviders.sap.issuer | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0"` | user info URL | -| crossplane.identityProviders.sap.tokenUrl | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"` | token URL | -| crossplane.providerConfig | object | `{"name":"keycloak-provider-config","namespace":"openmfp-system"}` | crossplane provider config | -| crossplane.providerConfig.name | string | `"keycloak-provider-config"` | name of the client | -| crossplane.providerConfig.namespace | string | `"openmfp-system"` | client namespace | -| crossplane.realm | object | `{"displayName":"OpenMFP","name":"openmfp","registrationAllowed":false}` | crossplane realm config | -| crossplane.realm.displayName | string | `"OpenMFP"` | realm display name | -| crossplane.realm.name | string | `"openmfp"` | realm name | -| crossplane.realm.registrationAllowed | bool | `false` | realm registration allowed | -| debug | bool | `false` | debug mode | -| domain | object | `{"name":"openmfp.org","pathPrefix":""}` | domain configuration | -| domain.name | string | `"openmfp.org"` | domain name | -| domain.pathPrefix | string | `""` | path prefix | -| externalSecrets | object | `{"keycloakAdminRemoteRef":"dxp-core-team/manual-secrets/keycloak-admin","postgres-adminRemoteRef":"dxp-core-team/manual-secrets/postgres-admin-password"}` | external secrets configuration | -| externalSecrets.keycloakAdminRemoteRef | string | `"dxp-core-team/manual-secrets/keycloak-admin"` | keycloak admin secret | -| externalSecrets.postgres-adminRemoteRef | string | `"dxp-core-team/manual-secrets/postgres-admin-password"` | postgres admin secret | -| istio.virtualservice.hosts | list | `["auth.openmfp.org"]` | istio virtual service hosts | -| job | object | `{"annotations":{"argocd.argoproj.io/hook":"PostSync"},"serviceAccount":"keycloak-client-creation"}` | job configuration | -| job.annotations | object | `{"argocd.argoproj.io/hook":"PostSync"}` | custom job annotations | -| job.serviceAccount | string | `"keycloak-client-creation"` | job ServiceAccount name | -| keycloak | object | `{"extraEnvVars":"- name: KEYCLOAK_USER\n value: keycloak-admin\n- name: KEYCLOAK_PASSWORD\n valueFrom:\n secretKeyRef:\n name: keycloak-admin\n key: secret\n","postgresql":{"auth":{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}}}` | configuration passed to the child 'keyclaok' chart https://github.com/bitnami/charts/tree/main/bitnami/keycloak | -| keycloak.extraEnvVars | string | `"- name: KEYCLOAK_USER\n value: keycloak-admin\n- name: KEYCLOAK_PASSWORD\n valueFrom:\n secretKeyRef:\n name: keycloak-admin\n key: secret\n"` | keycloak environment variables (raw) | -| keycloak.postgresql | object | `{"auth":{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}}` | configuration for the postgresql sub-chart | -| keycloak.postgresql.auth | object | `{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}` | authorization configuration | -| keycloak.postgresql.auth.existingSecret | string | `""` | existing secret name | -| keycloak.postgresql.auth.secretKeys.adminPasswordKey | string | `"password"` | admin password key | -| keycloak.postgresql.auth.secretKeys.userPasswordKey | string | `"password"` | user password key | -| keycloakConfig.admin | object | `{"password":{"valueFrom":{"secretKeyRef":{"key":"secret","name":"keycloak-admin"}}},"username":{"value":"keycloak-admin"}}` | admin user configuration | -| keycloakConfig.admin.password | object | `{"valueFrom":{"secretKeyRef":{"key":"secret","name":"keycloak-admin"}}}` | admin password | -| keycloakConfig.admin.password.valueFrom.secretKeyRef.key | string | `"secret"` | key of the password in the secret | -| keycloakConfig.admin.password.valueFrom.secretKeyRef.name | string | `"keycloak-admin"` | name of the secret containing the password | -| keycloakConfig.admin.username.value | string | `"keycloak-admin"` | username | -| keycloakConfig.client | object | `{"name":"openmfp","targetSecret":{"name":"portal-client-secret-openmfp","namespace":"openmfp-system"},"tokenLifespan":3600}` | client configuration | -| keycloakConfig.client.name | string | `"openmfp"` | client name | -| keycloakConfig.client.targetSecret | object | `{"name":"portal-client-secret-openmfp","namespace":"openmfp-system"}` | target secret options | -| keycloakConfig.client.targetSecret.name | string | `"portal-client-secret-openmfp"` | secret name | -| keycloakConfig.client.targetSecret.namespace | string | `"openmfp-system"` | secret namespace | -| keycloakConfig.client.tokenLifespan | int | `3600` | token lifespan | -| keycloakConfig.realm | object | `{"name":"master"}` | realm configuration | -| keycloakConfig.realm.name | string | `"master"` | realm name | -| keycloakConfig.redirectUrls | list | `[]` | redirect urls | -| keycloakConfig.url | string | `"http://keycloak-http.openmfp-system.svc.cluster.local:8080"` | url of the keycloak server | -| keycloakConfig.userRegistration.enabled | bool | `true` | toggle to enable/disable user registration | -| service | object | `{"name":"keycloak","port":8080}` | service configuration | -| service.name | string | `"keycloak"` | service name | -| service.port | int | `8080` | service port | +| Key | Type | Default | Description | +| ---------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| crossplane.clients.openmfp.name | string | `"OpenMFP"` | name of the client | +| crossplane.clients.openmfp.validRedirectUris | list | `["http://localhost:8000/callback*"]` | valid redirect uris for the client | +| crossplane.clients.openmfp.validRedirectUris[0] | string | `"http://localhost:8000/callback*"` | keycloak callback url | +| crossplane.enabled | bool | `false` | toggle to enable/disable crossplane | +| crossplane.identityProviders | object | `{"sap":{"authorizationUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize","clientId":"82b4c72c-ff99-4df6-ba4f-fb634d1fc491","clientSecretRef":{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"},"clientSecretRemoteRef":"dxp-core-team/manual-secrets/sap-client-secret","issuer":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0","tokenUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"}}` | crossplane identity providers config | +| crossplane.identityProviders.sap | object | `{"authorizationUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize","clientId":"82b4c72c-ff99-4df6-ba4f-fb634d1fc491","clientSecretRef":{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"},"clientSecretRemoteRef":"dxp-core-team/manual-secrets/sap-client-secret","issuer":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0","tokenUrl":"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"}` | sap IDP | +| crossplane.identityProviders.sap.authorizationUrl | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/authorize"` | authorization URL | +| crossplane.identityProviders.sap.clientId | string | `"82b4c72c-ff99-4df6-ba4f-fb634d1fc491"` | client id | +| crossplane.identityProviders.sap.clientSecretRef | object | `{"key":"client-secret","name":"sap-client-secret","namespace":"openmfp-system"}` | client secret | +| crossplane.identityProviders.sap.clientSecretRef.key | string | `"client-secret"` | secret key | +| crossplane.identityProviders.sap.clientSecretRef.name | string | `"sap-client-secret"` | secret name | +| crossplane.identityProviders.sap.clientSecretRef.namespace | string | `"openmfp-system"` | secret namespace | +| crossplane.identityProviders.sap.clientSecretRemoteRef | string | `"dxp-core-team/manual-secrets/sap-client-secret"` | user info URL | +| crossplane.identityProviders.sap.issuer | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/v2.0"` | user info URL | +| crossplane.identityProviders.sap.tokenUrl | string | `"https://login.microsoftonline.com/42f7676c-f455-423c-82f6-dc2d99791af7/oauth2/v2.0/token"` | token URL | +| crossplane.providerConfig | object | `{"name":"keycloak-provider-config","namespace":"openmfp-system"}` | crossplane provider config | +| crossplane.providerConfig.name | string | `"keycloak-provider-config"` | name of the client | +| crossplane.providerConfig.namespace | string | `"openmfp-system"` | client namespace | +| crossplane.realm | object | `{"displayName":"OpenMFP","name":"openmfp","registrationAllowed":false}` | crossplane realm config | +| crossplane.realm.displayName | string | `"OpenMFP"` | realm display name | +| crossplane.realm.name | string | `"openmfp"` | realm name | +| crossplane.realm.registrationAllowed | bool | `false` | realm registration allowed | +| debug | bool | `false` | debug mode | +| domain | object | `{"name":"openmfp.org","pathPrefix":""}` | domain configuration | +| domain.name | string | `"openmfp.org"` | domain name | +| domain.pathPrefix | string | `""` | path prefix | +| externalSecrets | object | `{"keycloakAdminRemoteRef":"dxp-core-team/manual-secrets/keycloak-admin","postgres-adminRemoteRef":"dxp-core-team/manual-secrets/postgres-admin-password"}` | external secrets configuration | +| externalSecrets.keycloakAdminRemoteRef | string | `"dxp-core-team/manual-secrets/keycloak-admin"` | keycloak admin secret | +| externalSecrets.postgres-adminRemoteRef | string | `"dxp-core-team/manual-secrets/postgres-admin-password"` | postgres admin secret | +| istio.virtualservice.hosts | list | `["auth.openmfp.org"]` | istio virtual service hosts | +| job | object | `{"annotations":{"argocd.argoproj.io/hook":"PostSync"},"serviceAccount":"keycloak-client-creation"}` | job configuration | +| job.annotations | object | `{"argocd.argoproj.io/hook":"PostSync"}` | custom job annotations | +| job.serviceAccount | string | `"keycloak-client-creation"` | job ServiceAccount name | +| keycloak | object | `{"extraEnvVars":"- name: KEYCLOAK_USER\n value: keycloak-admin\n- name: KEYCLOAK_PASSWORD\n valueFrom:\n secretKeyRef:\n name: keycloak-admin\n key: secret\n","postgresql":{"auth":{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}}}` | configuration passed to the child 'keyclaok' chart https://github.com/bitnami/charts/tree/main/bitnami/keycloak | +| keycloak.extraEnvVars | string | `"- name: KEYCLOAK_USER\n value: keycloak-admin\n- name: KEYCLOAK_PASSWORD\n valueFrom:\n secretKeyRef:\n name: keycloak-admin\n key: secret\n"` | keycloak environment variables (raw) | +| keycloak.postgresql | object | `{"auth":{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}}` | configuration for the postgresql sub-chart | +| keycloak.postgresql.auth | object | `{"existingSecret":"","secretKeys":{"adminPasswordKey":"password","userPasswordKey":"password"}}` | authorization configuration | +| keycloak.postgresql.auth.existingSecret | string | `""` | existing secret name | +| keycloak.postgresql.auth.secretKeys.adminPasswordKey | string | `"password"` | admin password key | +| keycloak.postgresql.auth.secretKeys.userPasswordKey | string | `"password"` | user password key | +| keycloakConfig.admin | object | `{"password":{"valueFrom":{"secretKeyRef":{"key":"secret","name":"keycloak-admin"}}},"username":{"value":"keycloak-admin"}}` | admin user configuration | +| keycloakConfig.admin.password | object | `{"valueFrom":{"secretKeyRef":{"key":"secret","name":"keycloak-admin"}}}` | admin password | +| keycloakConfig.admin.password.valueFrom.secretKeyRef.key | string | `"secret"` | key of the password in the secret | +| keycloakConfig.admin.password.valueFrom.secretKeyRef.name | string | `"keycloak-admin"` | name of the secret containing the password | +| keycloakConfig.admin.username.value | string | `"keycloak-admin"` | username | +| keycloakConfig.client | object | `{"name":"openmfp","targetSecret":{"name":"portal-client-secret-openmfp","namespace":"openmfp-system"},"tokenLifespan":3600}` | client configuration | +| keycloakConfig.client.name | string | `"openmfp"` | client name | +| keycloakConfig.client.targetSecret | object | `{"name":"portal-client-secret-openmfp","namespace":"openmfp-system"}` | target secret options | +| keycloakConfig.client.targetSecret.name | string | `"portal-client-secret-openmfp"` | secret name | +| keycloakConfig.client.targetSecret.namespace | string | `"openmfp-system"` | secret namespace | +| keycloakConfig.client.tokenLifespan | int | `3600` | token lifespan | +| keycloakConfig.realm | object | `{"name":"master"}` | realm configuration | +| keycloakConfig.realm.name | string | `"master"` | realm name | +| keycloakConfig.redirectUrls | list | `[]` | redirect urls | +| keycloakConfig.url | string | `"http://keycloak-http.openmfp-system.svc.cluster.local:8080"` | url of the keycloak server | +| keycloakConfig.userRegistration.enabled | bool | `true` | toggle to enable/disable user registration | +| service | object | `{"name":"keycloak","port":8080}` | service configuration | +| service.name | string | `"keycloak"` | service name | +| service.port | int | `8080` | service port | ## Overriding Values @@ -82,12 +82,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/openmfp-crds/README.md b/charts/openmfp-crds/README.md index 5afedda8a..19dc88338 100644 --- a/charts/openmfp-crds/README.md +++ b/charts/openmfp-crds/README.md @@ -6,16 +6,16 @@ A chart containing CRD Definitions for OpenMFP ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The openmfp account-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)| -| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator-crds` | The openmfp extension-manager-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds)| +| Repository | Name | Description | Sources | +| ----------------------------------- | --------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The openmfp account-operator-crds chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds) | +| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator-crds` | The openmfp extension-manager-operator-crds chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| account-operator-crds.enabled | bool | `true` | | -| extension-manager-operator-crds.enabled | bool | `true` | | +| Key | Type | Default | Description | +| --------------------------------------- | ---- | ------- | ----------- | +| account-operator-crds.enabled | bool | `true` | | +| extension-manager-operator-crds.enabled | bool | `true` | | ## Overriding Values @@ -26,12 +26,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/openmfp/README.md b/charts/openmfp/README.md index e48fdf098..63c84e832 100644 --- a/charts/openmfp/README.md +++ b/charts/openmfp/README.md @@ -6,20 +6,20 @@ The OpenMFP chart for Kubernetes ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `portal` | The openmfp portal chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/portal)| -| `oci://ghcr.io/openmfp/helm-charts` | `example-content` | The openmfp example-content chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/example-content)| -| `oci://ghcr.io/openmfp/helm-charts` | `infra` | The openmfp infra chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/infra)| -| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator` | The openmfp extension-manager-operator chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator)| +| Repository | Name | Description | Sources | +| ----------------------------------- | ---------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `oci://ghcr.io/openmfp/helm-charts` | `portal` | The openmfp portal chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/portal) | +| `oci://ghcr.io/openmfp/helm-charts` | `example-content` | The openmfp example-content chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/example-content) | +| `oci://ghcr.io/openmfp/helm-charts` | `infra` | The openmfp infra chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/infra) | +| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator` | The openmfp extension-manager-operator chart. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| components.example-content.enabled | bool | `false` | enable example-content component | -| components.extension-manager-operator.enabled | bool | `true` | enable extension-manager-operator component | -| components.infra.enabled | bool | `true` | enable infra component | -| components.portal.enabled | bool | `true` | enable portal component | +| Key | Type | Default | Description | +| --------------------------------------------- | ---- | ------- | ------------------------------------------- | +| components.example-content.enabled | bool | `false` | enable example-content component | +| components.extension-manager-operator.enabled | bool | `true` | enable extension-manager-operator component | +| components.infra.enabled | bool | `true` | enable infra component | +| components.portal.enabled | bool | `true` | enable portal component | ## Overriding Values @@ -30,12 +30,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/charts/portal/README.md b/charts/portal/README.md index 8bde371af..8b87c4adc 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -4,31 +4,31 @@ Helm Chart for the openmfp Portal ## Requirements -| Repository | Name | Description | Sources | -|------------|------|-------------|---------| -| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| +| Repository | Name | Description | Sources | +| ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) | ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| baseDomains[0] | string | `"localhost"` | base domains for VirtualService | -| cookieDomain | string | `"localhost"` | cookie domain | -| developmentLandcsape | string | `"true"` | development landscape toggle | -| environment | string | `"local"` | environment | -| featureToggles | string | `"enableSessionAutoRefresh=true"` | | -| frontendPort | int | `8000` | frontend port | -| http.protocol | string | `"http"` | protocol | -| image.name | string | `"ghcr.io/openmfp/portal"` | | -| image.pullPolicyOverride | string | `"IfNotPresent"` | | -| importContent | bool | `false` | import content toggle | -| trust.openmfp.authDomain | string | `"http://localhost:8000/keycloak/realms/openmfp/protocol/openid-connect/auth"` | auth domain (if discoveryEndpoint is not specified) | -| trust.openmfp.baseDomains | string | `"localhost"` | base domains | -| trust.openmfp.discoveryEndpoint | string | `""` | discovery endpoint. If specified (different than ""), authDomain and tokenUrl are not required | -| trust.openmfp.loginAudience | string | `"openmfp"` | login audience | -| trust.openmfp.oidcClientSecretName | string | `"openmfp-client"` | oidc client secret name | -| trust.openmfp.secretKeyRef | string | `"attribute.client_secret"` | secret key reference | -| trust.openmfp.tokenUrl | string | `"http://keycloak/keycloak/realms/openmfp/protocol/openid-connect/token"` | token url (if discoveryEndpoint is not specified) | -| validWebcomponentUrls | string | `".?"` | | -| virtualService.hosts | list | `["*"]` | virtual service hosts | +| Key | Type | Default | Description | +| ---------------------------------- | ------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | +| baseDomains[0] | string | `"localhost"` | base domains for VirtualService | +| cookieDomain | string | `"localhost"` | cookie domain | +| developmentLandcsape | string | `"true"` | development landscape toggle | +| environment | string | `"local"` | environment | +| featureToggles | string | `"enableSessionAutoRefresh=true"` | | +| frontendPort | int | `8000` | frontend port | +| http.protocol | string | `"http"` | protocol | +| image.name | string | `"ghcr.io/openmfp/portal"` | | +| image.pullPolicyOverride | string | `"IfNotPresent"` | | +| importContent | bool | `false` | import content toggle | +| trust.openmfp.authDomain | string | `"http://localhost:8000/keycloak/realms/openmfp/protocol/openid-connect/auth"` | auth domain (if discoveryEndpoint is not specified) | +| trust.openmfp.baseDomains | string | `"localhost"` | base domains | +| trust.openmfp.discoveryEndpoint | string | `""` | discovery endpoint. If specified (different than ""), authDomain and tokenUrl are not required | +| trust.openmfp.loginAudience | string | `"openmfp"` | login audience | +| trust.openmfp.oidcClientSecretName | string | `"openmfp-client"` | oidc client secret name | +| trust.openmfp.secretKeyRef | string | `"attribute.client_secret"` | secret key reference | +| trust.openmfp.tokenUrl | string | `"http://keycloak/keycloak/realms/openmfp/protocol/openid-connect/token"` | token url (if discoveryEndpoint is not specified) | +| validWebcomponentUrls | string | `".?"` | | +| virtualService.hosts | list | `["*"]` | virtual service hosts | ## Overriding Values @@ -39,12 +39,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/docs-templates/footer.md.gotmpl b/docs-templates/footer.md.gotmpl index 2993d7f7e..56937c813 100644 --- a/docs-templates/footer.md.gotmpl +++ b/docs-templates/footer.md.gotmpl @@ -10,12 +10,12 @@ The values in the `defaults:` section can be reused from other charts by using t 3. Uses the `key` in the chart's values.yaml 4. Uses the `common.defaults.key` value from the table below. -1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. +1 has precedence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally. Example ``` -1) .Values.deployment.resources.limits.memoryOveride = 4096MB -2) .Values.global.deployment.resources.limits.memory = 2048MB -3) .Values.deployment.resources.limits.memory = 1024MB +1) .Values.deployment.resources.limits.memoryOverride = 4096MB +2) .Values.global.deployment.resources.limits.memory = 2048MB +3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` diff --git a/local-setup/scripts/start.sh b/local-setup/scripts/start.sh index 099c171f9..1a5dc7f72 100755 --- a/local-setup/scripts/start.sh +++ b/local-setup/scripts/start.sh @@ -17,7 +17,7 @@ fi ghUser="" if [ -z "${GH_USER}" ]; then if ! command -v gh &> /dev/null; then - echo "gh CLI could not be found. Please install the GitHub CLI or set the 'GH_USER' environment variable with your GitHub username." + echo "gh CLI could not be found. Either install the gh cli or set the GH_USER environment variable with our GitHub username." exit 1 else ghUser=$(gh api user --jq '.login')