Skip to content

Commit

Permalink
Merge pull request #53 from eclipse-tractusx/chore/add-dataprovider-c…
Browse files Browse the repository at this point in the history
…harts

chore: add dataprovider charts
  • Loading branch information
ds-jhartmann authored Apr 22, 2024
2 parents cb58054 + c5fac71 commit 67e69c2
Show file tree
Hide file tree
Showing 16 changed files with 5,399 additions and 183 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/helm-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,12 @@ jobs:
- name: Install chart and run tests (simple-data-backend)
run: ct install --charts charts/simple-data-backend --target-branch ${{ github.event.repository.default_branch }} --helm-extra-set-args "--set image.repository=kind-registry:5000/simple-data-backend --set image.tag=testing"

- name: Install chart and run tests (tx-data-provider)
run: ct install --charts charts/tx-data-provider --target-branch ${{ github.event.repository.default_branch }}

- name: Install chart and run tests (umbrella)
run: |
helm install umbrella charts/umbrella -f charts/values-test.yaml --namespace install --create-namespace --debug
helm install umbrella charts/umbrella -f charts/values-test.yaml --namespace install --create-namespace --debug --timeout 10m
helm uninstall umbrella --namespace install
## Skip upgrade for now until a working chart is released
Expand Down
47 changes: 47 additions & 0 deletions charts/tx-data-provider/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# #############################################################################
# Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2021,2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# SPDX-License-Identifier: Apache-2.0
# #############################################################################

# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/

# Ignore ENV specific values at release
values?*.yaml
values?*.yml
45 changes: 45 additions & 0 deletions charts/tx-data-provider/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# #############################################################################
# Copyright (c) 2022,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2021,2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# SPDX-License-Identifier: Apache-2.0
# #############################################################################
---
apiVersion: v2
name: tx-data-provider
description: A Helm chart for Kubernetes

type: application
version: 0.0.1
appVersion: 0.0.1

dependencies:
- name: digital-twin-registry
version: 0.4.5
repository: https://eclipse-tractusx.github.io/charts/dev
condition: digital-twin-registry.enabled
- name: simple-data-backend
repository: https://eclipse-tractusx.github.io/charts/dev
version: 0.1.0
condition: simple-data-backend.enabled
- name: tractusx-connector
repository: https://eclipse-tractusx.github.io/charts/dev
version: 0.5.3
condition: tractusx-connector.enabled
- name: vault
version: 0.20.0
repository: https://helm.releases.hashicorp.com
condition: vault.enabled
46 changes: 46 additions & 0 deletions charts/tx-data-provider/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Dataprovider Helm Chart

This chart includes EDC, Digital Twin Registry and a Submodel Server.
The Submodel Server images is based on an older Catena-X demo (catenax at home) since this is what we were using in our
testing environments.

## Prerequisites

- Running Kubernetes cluster
- Helm is installed

Example for local usage:

- [Minikube](https://minikube.sigs.k8s.io/docs/start/)
- [Minikube ingress addon](https://minikube.sigs.k8s.io/docs/handbook/addons/ingress-dns/)

## Installing

Run the Chart with

```shell
helm dependency update
helm install dataprovider . --timeout 10m0s
```

Remove the chart by running

```shell
helm uninstall dataprovider
```
## Configuration

For Configuration of digital twin registry see [sldt-digital-twin-registry/tree/main/charts/registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/tree/main/charts/registry)

Configuration of EDC see [tractusx-edc/tree/main/charts/tractusx-connecto](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector)

EDC requires connection to HashiCorp Vault and Manage Identity Wallet. These have to be configured for the dataprovider to be operative.

The Chart can be used as dataprovider by setting `simple-data-backend.enabled`, `digital-twin-registry.enabled` and `seedTestdata` to `false`.

## Testdata seeding

After the installation, a Post-Install Helm Hook will be started which initiates the seeding of testdata. The Hook executes a python script which uploads a provided test dataset to the dataprovider. Documentation to the python script can be found here [README](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/local/testing/testdata/README.md)

Test data set and upload script are stored in [resources/](resources) and provided to the hook as config map.
A custom config map can be used to provided e.g. `testdataConfigMap: my-custom-testdata-configmap`.
Loading

0 comments on commit 67e69c2

Please sign in to comment.