Skip to content

Commit

Permalink
chore(helm): updated helm-docs again
Browse files Browse the repository at this point in the history
Signed-off-by: Sascha Isele <[email protected]>
  • Loading branch information
saschaisele-zf committed Nov 23, 2023
1 parent caa77a7 commit ff15a53
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 29 deletions.
12 changes: 2 additions & 10 deletions charts/tractusx-connector-azure-vault/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
# 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)

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:** <https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector>

## Setting up SSI
Expand All @@ -32,7 +28,6 @@ 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:
Expand All @@ -42,7 +37,6 @@ 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)
Expand All @@ -59,9 +53,6 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.
--set vault.azure.tenant=$AZURE_TENANT_ID
```




## Source Code

* <https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector>
Expand Down Expand Up @@ -287,4 +278,5 @@ 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)
12 changes: 2 additions & 10 deletions charts/tractusx-connector-memory/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# 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)

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!
Expand All @@ -25,7 +22,6 @@ 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:
Expand All @@ -35,7 +31,6 @@ 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)
Expand All @@ -49,14 +44,10 @@ helm install my-release tractusx-edc/tractusx-connector-memory --version 0.6.0-r
--set vault.secrets="client-secret:$YOUR_CLIENT_SECRET"
```



## Source Code

* <https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector-memory>



## Values

| Key | Type | Default | Description |
Expand Down Expand Up @@ -179,4 +170,5 @@ 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)
11 changes: 2 additions & 9 deletions charts/tractusx-connector/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
# 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)

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:** <https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector>

## Setting up SSI
Expand All @@ -29,7 +25,6 @@ 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:
Expand All @@ -39,7 +34,6 @@ 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)
Expand All @@ -52,8 +46,6 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.6.0-rc1 \
-f <path-to>/tractusx-connector-test.yaml
```



## Source Code

* <https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector>
Expand Down Expand Up @@ -291,4 +283,5 @@ 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)

0 comments on commit ff15a53

Please sign in to comment.