From 98b44ce1e22ed03d167da31206dab13b54f9003b Mon Sep 17 00:00:00 2001 From: Sascha Isele Date: Thu, 23 Nov 2023 12:30:02 +0100 Subject: [PATCH] chore(helm): updated helm-docs Signed-off-by: Sascha Isele --- .../tractusx-connector-azure-vault/README.md | 22 ++++++++++++++++--- charts/tractusx-connector-memory/README.md | 18 ++++++++++++--- charts/tractusx-connector/README.md | 21 +++++++++++++++--- 3 files changed, 52 insertions(+), 9 deletions(-) diff --git a/charts/tractusx-connector-azure-vault/README.md b/charts/tractusx-connector-azure-vault/README.md index 90222879a..559131846 100644 --- a/charts/tractusx-connector-azure-vault/README.md +++ b/charts/tractusx-connector-azure-vault/README.md @@ -1,12 +1,16 @@ # tractusx-connector-azure-vault -![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) + + + +![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and Azure KeyVault are included. This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ Azure KeyVault. + **Homepage:** ## Setting up SSI @@ -28,6 +32,7 @@ This chart is intended for use with an _existing_ PostgreSQL database and an _ex ``` By default, Tractus-X EDC expects to find the secret under `client-secret`. + ### Configure the chart Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: @@ -37,6 +42,7 @@ Be sure to provide the following configuration entries to your Tractus-X EDC Hel - `controlplane.ssi.oauth.client.id`: client ID for KeyCloak - `controlplane.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. + ### Launching the application As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) @@ -53,6 +59,9 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. --set vault.azure.tenant=$AZURE_TENANT_ID ``` + + + ## Source Code * @@ -123,6 +132,8 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. | controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | | controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | | controlplane.initContainers | list | `[]` | | +| controlplane.limits.cpu | float | `1.5` | | +| controlplane.limits.memory | string | `"512Mi"` | | | controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | | controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | | controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | @@ -146,6 +157,8 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. | controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | | controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | | controlplane.replicaCount | int | `1` | | +| controlplane.requests.cpu | string | `"500m"` | | +| controlplane.requests.memory | string | `"128Mi"` | | | controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | | controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | | controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | @@ -207,6 +220,8 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. | dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | | dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | | dataplane.initContainers | list | `[]` | | +| dataplane.limits.cpu | float | `1.5` | | +| dataplane.limits.memory | string | `"1024Mi"` | | | dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | | dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | | dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | @@ -230,6 +245,8 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. | dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | | dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | | dataplane.replicaCount | int | `1` | | +| dataplane.requests.cpu | string | `"500m"` | | +| dataplane.requests.memory | string | `"128Mi"` | | | dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | | dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | | dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | @@ -270,5 +287,4 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0. | vault.secretNames.transferProxyTokenSignerPrivateKey | string | `nil` | | | vault.secretNames.transferProxyTokenSignerPublicKey | string | `nil` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) + diff --git a/charts/tractusx-connector-memory/README.md b/charts/tractusx-connector-memory/README.md index aec09e501..fdc69688c 100644 --- a/charts/tractusx-connector-memory/README.md +++ b/charts/tractusx-connector-memory/README.md @@ -1,6 +1,9 @@ # tractusx-connector-memory -![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) + + + +![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) A Helm chart for Tractus-X Eclipse Data Space Connector based on memory. Please only use this for development or testing purposes, never in production workloads! @@ -22,6 +25,7 @@ A Helm chart for Tractus-X Eclipse Data Space Connector based on memory. Please - store your KeyCloak client secret in the HashiCorp vault. The exact procedure will depend on your deployment of HashiCorp Vault and is out of scope of this document. But by default, Tractus-X EDC expects to find the secret under `secret/client-secret`. + ### Configure the chart Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: @@ -31,6 +35,7 @@ Be sure to provide the following configuration entries to your Tractus-X EDC Hel - `runtime.ssi.oauth.client.id`: client ID for KeyCloak - `runtime.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. + ### Launching the application As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) @@ -44,10 +49,14 @@ helm install my-release tractusx-edc/tractusx-connector-memory --version 0.6.0-r --set vault.secrets="client-secret:$YOUR_CLIENT_SECRET" ``` + + ## Source Code * + + ## Values | Key | Type | Default | Description | @@ -114,6 +123,8 @@ helm install my-release tractusx-edc/tractusx-connector-memory --version 0.6.0-r | runtime.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | | runtime.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | | runtime.initContainers | list | `[]` | | +| runtime.limits.cpu | float | `1.5` | | +| runtime.limits.memory | string | `"512Mi"` | | | runtime.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | | runtime.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | | runtime.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | @@ -136,6 +147,8 @@ helm install my-release tractusx-edc/tractusx-connector-memory --version 0.6.0-r | runtime.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | | runtime.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | | runtime.replicaCount | int | `1` | | +| runtime.requests.cpu | string | `"500m"` | | +| runtime.requests.memory | string | `"128Mi"` | | | runtime.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | | runtime.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | | runtime.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | @@ -166,5 +179,4 @@ helm install my-release tractusx-edc/tractusx-connector-memory --version 0.6.0-r | vault.secrets | string | `""` | | | vault.server.postStart | string | `""` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) + diff --git a/charts/tractusx-connector/README.md b/charts/tractusx-connector/README.md index 4d82d01f8..661bbf800 100644 --- a/charts/tractusx-connector/README.md +++ b/charts/tractusx-connector/README.md @@ -1,12 +1,16 @@ # tractusx-connector -![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) + + + +![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.0-rc1](https://img.shields.io/badge/AppVersion-0.6.0--rc1-informational?style=flat-square) A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and HashiCorp Vault are included. This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ HashiCorp Vault. + **Homepage:** ## Setting up SSI @@ -25,6 +29,7 @@ This chart is intended for use with an _existing_ PostgreSQL database and an _ex - store your KeyCloak client secret in the HashiCorp vault. The exact procedure will depend on your deployment of HashiCorp Vault and is out of scope of this document. But by default, Tractus-X EDC expects to find the secret under `secret/client-secret`. + ### Configure the chart Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: @@ -34,6 +39,7 @@ Be sure to provide the following configuration entries to your Tractus-X EDC Hel - `controlplane.ssi.oauth.client.id`: client ID for KeyCloak - `controlplane.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. + ### Launching the application As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) @@ -46,6 +52,8 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ -f /tractusx-connector-test.yaml ``` + + ## Source Code * @@ -117,6 +125,8 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ | controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | | controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | | controlplane.initContainers | list | `[]` | | +| controlplane.limits.cpu | float | `1.5` | | +| controlplane.limits.memory | string | `"512Mi"` | | | controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | | controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | | controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | @@ -140,6 +150,8 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ | controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | | controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | | controlplane.replicaCount | int | `1` | | +| controlplane.requests.cpu | string | `"500m"` | | +| controlplane.requests.memory | string | `"128Mi"` | | | controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | | controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | | controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | @@ -201,6 +213,8 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ | dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | | dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | | dataplane.initContainers | list | `[]` | | +| dataplane.limits.cpu | float | `1.5` | | +| dataplane.limits.memory | string | `"1024Mi"` | | | dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | | dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | | dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | @@ -224,6 +238,8 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ | dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | | dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | | dataplane.replicaCount | int | `1` | | +| dataplane.requests.cpu | string | `"500m"` | | +| dataplane.requests.memory | string | `"128Mi"` | | | dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | | dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | | dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | @@ -275,5 +291,4 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \ | vault.server.dev.enabled | bool | `true` | | | vault.server.postStart | string | `nil` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) +