Skip to content

README.md

Latest commit

 

History

History
126 lines (93 loc) · 3.11 KB

README.md

File metadata and controls

126 lines (93 loc) · 3.11 KB

Dataspace Consumer Framework Helm Chart

This Helm chart deploys the Dataspace Consumer Framework on a Kubernetes cluster.

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.0+
  • PV provisioner support in the underlying infrastructure (for persistent storage)

Installing the Chart

To install the chart with the release name dataspace-consumer:

helm install dataspace-consumer ./deployment/helm

# Or with specific namespace 
helm install dataspace-consumer ./deployment/helm --namespace custom-namespace

This command deploys the Dataspace Consumer Framework on the Kubernetes cluster with the default configuration.

Uninstalling the Chart

To uninstall the dataspace-consumer deployment:

helm uninstall dataspace-consumer

This command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The chart can be customized by providing a values.yaml file or by using --set flags during installation. The following are some of the configurable parameters:

Application Configuration

The application configuration is defined in the config.application.yml section of values.yaml. This file is mounted as a ConfigMap and loaded by Spring Boot at startup.

config:
  application.yml: |
    # Custom config - Add your application configuration here
    spring:
      application:
        name: dataspace-consumer-framework 
        

    mx-port:
      - name: MX-Port1
        discovery:
          implementation: de.fraunhofer.iosb.ilt.dataspace_consumer.aas-dsp-discovery-extension
          config:
            aasServer: http://localhost:8080

See the application configuration documentation for details.

Add Extensions

To add extensions to the Dataspace Consumer Framework:

  1. Enable extensions by setting enabled: true:
extensions:
  enabled: true
  1. Configure the download source - the base URL where extensions are hosted: e.g., to download from GitHub Releases:
  source: "https://github.com/FraunhoferIOSB/dataspaceconsumer-framework/releases/download/v0.0.1"
  1. Add extension files with filename (local name) and url (path to append to source):
  files:
    - filename: "aas-dsp-discovery-extension.jar"
      url: "/aas-dsp-discovery-extension.jar"
    - filename: "console-adapter-extension.jar"
      url: "/console-adapter-extension.jar"

The init container will download each extension from source + url and save it as filename.

Install with custom values file

helm install dataspace-consumer ./deployment/helm -f custom-values.yaml

Upgrade the release

helm upgrade dataspace-consumer ./deployment/helm

Enable Ingress

ingress:
  enabled: true
  className: nginx
  hosts:
    - host: dataspace-consumer.example.com
      paths:
        - path: /
          pathType: Prefix
  tls:
    - secretName: dataspace-consumer-tls
      hosts:
        - dataspace-consumer.example.com

Configure Resources

resources:
  limits:
    cpu: 1000m
    memory: 1Gi
  requests:
    cpu: 500m
    memory: 512Mi