README.md

tractusx-connector

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

Preconditions

• the Managed Identity Walled (MIW) must be running and reachable via network
• the necessary set of VerifiableCredentials for this participant must be pushed to MIW. This is typically done by the Portal during participant onboarding
• KeyCloak must be running and reachable via network
• an account with KeyCloak must be created for this BPN and the connector must be able to obtain access tokens
• the client ID and client secret corresponding to that account must be known

Preparatory work

• 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:

• controlplane.ssi.miw.url: the URL
• controlplane.ssi.miw.authorityId: the BPN of the issuer authority
• controlplane.ssi.oauth.tokenurl: the URL (of KeyCloak), where access tokens can be obtained
• 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 to launch the application. The configuration values mentioned above (controlplane.ssi.*) will have to be adapted manually. Combined, run this shell command to start the in-memory Tractus-X EDC runtime:

helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev
helm install my-release tractusx-edc/tractusx-connector --version 0.6.0 \
     -f <path-to>/tractusx-connector-test.yaml

Source Code

• https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector

Requirements

Repository	Name	Version
https://charts.bitnami.com/bitnami	postgresql(postgresql)	12.11.2
https://helm.releases.hashicorp.com	vault(vault)	0.20.0

Values

Key	Type	Default	Description
backendService.httpProxyTokenReceiverUrl	string	"https://example.com"	Specifies a backend service which will receive the EDR
controlplane.affinity	object	{}
controlplane.autoscaling.enabled	bool	false	Enables horizontal pod autoscaling
controlplane.autoscaling.maxReplicas	int	100	Maximum replicas if resource consumption exceeds resource threshholds
controlplane.autoscaling.minReplicas	int	1	Minimal replicas if resource consumption falls below resource threshholds
controlplane.autoscaling.targetCPUUtilizationPercentage	int	80	targetAverageUtilization of cpu provided to a pod
controlplane.autoscaling.targetMemoryUtilizationPercentage	int	80	targetAverageUtilization of memory provided to a pod
controlplane.businessPartnerValidation.log.agreementValidation	bool	true
controlplane.debug.enabled	bool	false
controlplane.debug.port	int	1044
controlplane.debug.suspendOnStart	bool	false
controlplane.edr.transferProxyTokenValidity	string	"2592000"
controlplane.endpoints	object	{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"password","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"protocol":{"path":"/api/v1/dsp","port":8084}}	endpoints of the control plane
controlplane.endpoints.control	object	{"path":"/control","port":8083}	control api, used for internal control calls. can be added to the internal ingress, but should probably not
controlplane.endpoints.control.path	string	"/control"	path for incoming api calls
controlplane.endpoints.control.port	int	8083	port for incoming api calls
controlplane.endpoints.default	object	{"path":"/api","port":8080}	default api for health checks, should not be added to any ingress
controlplane.endpoints.default.path	string	"/api"	path for incoming api calls
controlplane.endpoints.default.port	int	8080	port for incoming api calls
controlplane.endpoints.management	object	{"authKey":"password","path":"/management","port":8081}	data management api, used by internal users, can be added to an ingress and must not be internet facing
controlplane.endpoints.management.authKey	string	"password"	authentication key, must be attached to each 'X-Api-Key' request header
controlplane.endpoints.management.path	string	"/management"	path for incoming api calls
controlplane.endpoints.management.port	int	8081	port for incoming api calls
controlplane.endpoints.metrics	object	{"path":"/metrics","port":9090}	metrics api, used for application metrics, must not be internet facing
controlplane.endpoints.metrics.path	string	"/metrics"	path for incoming api calls
controlplane.endpoints.metrics.port	int	9090	port for incoming api calls
controlplane.endpoints.protocol	object	{"path":"/api/v1/dsp","port":8084}	dsp api, used for inter connector communication and must be internet facing
controlplane.endpoints.protocol.path	string	"/api/v1/dsp"	path for incoming api calls
controlplane.endpoints.protocol.port	int	8084	port for incoming api calls
controlplane.env	object	{}
controlplane.envConfigMapNames	list	[]
controlplane.envSecretNames	list	[]
controlplane.envValueFrom	object	{}
controlplane.image.pullPolicy	string	"IfNotPresent"	Kubernetes image pull policy to use
controlplane.image.repository	string	""	Which derivate of the control plane to use. when left empty the deployment will select the correct image automatically
controlplane.image.tag	string	""	Overrides the image tag whose default is the chart appVersion
controlplane.ingresses[0].annotations	object	{}	Additional ingress annotations to add
controlplane.ingresses[0].certManager.clusterIssuer	string	""	If preset enables certificate generation via cert-manager cluster-wide issuer
controlplane.ingresses[0].certManager.issuer	string	""	If preset enables certificate generation via cert-manager namespace scoped issuer
controlplane.ingresses[0].className	string	""	Defines the ingress class to use
controlplane.ingresses[0].enabled	bool	false
controlplane.ingresses[0].endpoints	list	["protocol"]	EDC endpoints exposed by this ingress resource
controlplane.ingresses[0].hostname	string	"edc-control.local"	The hostname to be used to precisely map incoming traffic onto the underlying network service
controlplane.ingresses[0].tls	object	{"enabled":false,"secretName":""}	TLS tls class applied to the ingress resource
controlplane.ingresses[0].tls.enabled	bool	false	Enables TLS on the ingress resource
controlplane.ingresses[0].tls.secretName	string	""	If present overwrites the default secret name
controlplane.ingresses[1].annotations	object	{}	Additional ingress annotations to add
controlplane.ingresses[1].certManager.clusterIssuer	string	""	If preset enables certificate generation via cert-manager cluster-wide issuer
controlplane.ingresses[1].certManager.issuer	string	""	If preset enables certificate generation via cert-manager namespace scoped issuer
controlplane.ingresses[1].className	string	""	Defines the ingress class to use
controlplane.ingresses[1].enabled	bool	false
controlplane.ingresses[1].endpoints	list	["management","control"]	EDC endpoints exposed by this ingress resource
controlplane.ingresses[1].hostname	string	"edc-control.intranet"	The hostname to be used to precisely map incoming traffic onto the underlying network service
controlplane.ingresses[1].tls	object	{"enabled":false,"secretName":""}	TLS tls class applied to the ingress resource
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
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
controlplane.livenessProbe.periodSeconds	int	10	this fields specifies that kubernetes should perform a liveness check every 10 seconds
controlplane.livenessProbe.successThreshold	int	1	number of consecutive successes for the probe to be considered successful after having failed
controlplane.livenessProbe.timeoutSeconds	int	5	number of seconds after which the probe times out
controlplane.logging	string	".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"	configuration of the Java Util Logging Facade
controlplane.nodeSelector	object	{}
controlplane.opentelemetry	string	"otel.javaagent.enabled=false\notel.javaagent.debug=false"	configuration of the Open Telemetry Agent to collect and expose metrics
controlplane.podAnnotations	object	{}	additional annotations for the pod
controlplane.podLabels	object	{}	additional labels for the pod
controlplane.podSecurityContext	object	{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}	The pod security context defines privilege and access control settings for a Pod within the deployment
controlplane.podSecurityContext.fsGroup	int	10001	The owner for volumes and any files created within volumes will belong to this guid
controlplane.podSecurityContext.runAsGroup	int	10001	Processes within a pod will belong to this guid
controlplane.podSecurityContext.runAsUser	int	10001	Runs all processes within a pod with a special uid
controlplane.podSecurityContext.seccompProfile.type	string	"RuntimeDefault"	Restrict a Container's Syscalls with seccomp
controlplane.readinessProbe.enabled	bool	true	Whether to enable kubernetes readiness-probes
controlplane.readinessProbe.failureThreshold	int	6	when a probe fails kubernetes will try 6 times before giving up
controlplane.readinessProbe.initialDelaySeconds	int	30	seconds to wait before performing the first readiness check
controlplane.readinessProbe.periodSeconds	int	10	this fields specifies that kubernetes should perform a readiness check every 10 seconds
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 for the container
controlplane.securityContext.allowPrivilegeEscalation	bool	false	Controls Privilege Escalation enabling setuid binaries changing the effective user ID
controlplane.securityContext.capabilities.add	list	[]	Specifies which capabilities to add to issue specialized syscalls
controlplane.securityContext.capabilities.drop	list	["ALL"]	Specifies which capabilities to drop to reduce syscall attack surface
controlplane.securityContext.readOnlyRootFilesystem	bool	true	Whether the root filesystem is mounted in read-only mode
controlplane.securityContext.runAsNonRoot	bool	true	Requires the container to run without root privileges
controlplane.securityContext.runAsUser	int	10001	The container's process will run with the specified uid
controlplane.service.annotations	object	{}
controlplane.service.type	string	"ClusterIP"	Service type to expose the running application on a set of Pods as a network service.
controlplane.ssi.miw.authorityId	string	""	The BPN of the issuer authority
controlplane.ssi.miw.url	string	""	MIW URL
controlplane.ssi.oauth.client.id	string	""	The client ID for KeyCloak
controlplane.ssi.oauth.client.secretAlias	string	"client-secret"	The alias under which the client secret is stored in the vault.
controlplane.ssi.oauth.tokenurl	string	""	The URL (of KeyCloak), where access tokens can be obtained
controlplane.tolerations	list	[]
controlplane.url.protocol	string	""	Explicitly declared url for reaching the dsp api (e.g. if ingresses not used)
controlplane.volumeMounts	string	nil	declare where to mount volumes into the container
controlplane.volumes	string	nil	volume directories
customCaCerts	object	{}	Add custom ca certificates to the truststore
customLabels	object	{}	To add some custom labels
dataplane.affinity	object	{}
dataplane.autoscaling.enabled	bool	false	Enables horizontal pod autoscaling
dataplane.autoscaling.maxReplicas	int	100	Maximum replicas if resource consumption exceeds resource threshholds
dataplane.autoscaling.minReplicas	int	1	Minimal replicas if resource consumption falls below resource threshholds
dataplane.autoscaling.targetCPUUtilizationPercentage	int	80	targetAverageUtilization of cpu provided to a pod
dataplane.autoscaling.targetMemoryUtilizationPercentage	int	80	targetAverageUtilization of memory provided to a pod
dataplane.aws.accessKeyId	string	""
dataplane.aws.endpointOverride	string	""
dataplane.aws.secretAccessKey	string	""
dataplane.debug.enabled	bool	false
dataplane.debug.port	int	1044
dataplane.debug.suspendOnStart	bool	false
dataplane.endpoints.control.path	string	"/api/dataplane/control"
dataplane.endpoints.control.port	int	8083
dataplane.endpoints.default.path	string	"/api"
dataplane.endpoints.default.port	int	8080
dataplane.endpoints.metrics.path	string	"/metrics"
dataplane.endpoints.metrics.port	int	9090
dataplane.endpoints.proxy.authKey	string	"password"
dataplane.endpoints.proxy.path	string	"/proxy"
dataplane.endpoints.proxy.port	int	8186
dataplane.endpoints.public.path	string	"/api/public"
dataplane.endpoints.public.port	int	8081
dataplane.env	object	{}
dataplane.envConfigMapNames	list	[]
dataplane.envSecretNames	list	[]
dataplane.envValueFrom	object	{}
dataplane.image.pullPolicy	string	"IfNotPresent"	Kubernetes image pull policy to use
dataplane.image.repository	string	""	Which derivate of the data plane to use. when left empty the deployment will select the correct image automatically
dataplane.image.tag	string	""	Overrides the image tag whose default is the chart appVersion
dataplane.ingresses[0].annotations	object	{}	Additional ingress annotations to add
dataplane.ingresses[0].certManager.clusterIssuer	string	""	If preset enables certificate generation via cert-manager cluster-wide issuer
dataplane.ingresses[0].certManager.issuer	string	""	If preset enables certificate generation via cert-manager namespace scoped issuer
dataplane.ingresses[0].className	string	""	Defines the ingress class to use
dataplane.ingresses[0].enabled	bool	false
dataplane.ingresses[0].endpoints	list	["public"]	EDC endpoints exposed by this ingress resource
dataplane.ingresses[0].hostname	string	"edc-data.local"	The hostname to be used to precisely map incoming traffic onto the underlying network service
dataplane.ingresses[0].tls	object	{"enabled":false,"secretName":""}	TLS tls class applied to the ingress resource
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
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
dataplane.livenessProbe.periodSeconds	int	10	this fields specifies that kubernetes should perform a liveness check every 10 seconds
dataplane.livenessProbe.successThreshold	int	1	number of consecutive successes for the probe to be considered successful after having failed
dataplane.livenessProbe.timeoutSeconds	int	5	number of seconds after which the probe times out
dataplane.logging	string	".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"	configuration of the Java Util Logging Facade
dataplane.nodeSelector	object	{}
dataplane.opentelemetry	string	"otel.javaagent.enabled=false\notel.javaagent.debug=false"	configuration of the Open Telemetry Agent to collect and expose metrics
dataplane.podAnnotations	object	{}	additional annotations for the pod
dataplane.podLabels	object	{}	additional labels for the pod
dataplane.podSecurityContext	object	{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}	The pod security context defines privilege and access control settings for a Pod within the deployment
dataplane.podSecurityContext.fsGroup	int	10001	The owner for volumes and any files created within volumes will belong to this guid
dataplane.podSecurityContext.runAsGroup	int	10001	Processes within a pod will belong to this guid
dataplane.podSecurityContext.runAsUser	int	10001	Runs all processes within a pod with a special uid
dataplane.podSecurityContext.seccompProfile.type	string	"RuntimeDefault"	Restrict a Container's Syscalls with seccomp
dataplane.readinessProbe.enabled	bool	true	Whether to enable kubernetes readiness-probes
dataplane.readinessProbe.failureThreshold	int	6	when a probe fails kubernetes will try 6 times before giving up
dataplane.readinessProbe.initialDelaySeconds	int	30	seconds to wait before performing the first readiness check
dataplane.readinessProbe.periodSeconds	int	10	this fields specifies that kubernetes should perform a liveness check every 10 seconds
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 for the container
dataplane.securityContext.allowPrivilegeEscalation	bool	false	Controls Privilege Escalation enabling setuid binaries changing the effective user ID
dataplane.securityContext.capabilities.add	list	[]	Specifies which capabilities to add to issue specialized syscalls
dataplane.securityContext.capabilities.drop	list	["ALL"]	Specifies which capabilities to drop to reduce syscall attack surface
dataplane.securityContext.readOnlyRootFilesystem	bool	true	Whether the root filesystem is mounted in read-only mode
dataplane.securityContext.runAsNonRoot	bool	true	Requires the container to run without root privileges
dataplane.securityContext.runAsUser	int	10001	The container's process will run with the specified uid
dataplane.service.port	int	80
dataplane.service.type	string	"ClusterIP"	Service type to expose the running application on a set of Pods as a network service.
dataplane.tolerations	list	[]
dataplane.url.public	string	""	Explicitly declared url for reaching the public api (e.g. if ingresses not used)
dataplane.volumeMounts	string	nil	declare where to mount volumes into the container
dataplane.volumes	string	nil	volume directories
fullnameOverride	string	""
imagePullSecrets	list	[]	Existing image pull secret to use to obtain the container image from private registries
install.postgresql	bool	true
install.vault	bool	true
nameOverride	string	""
networkPolicy.controlplane	object	{"from":[{"namespaceSelector":{}}]}	Configuration of the controlplane component
networkPolicy.controlplane.from	list	[{"namespaceSelector":{}}]	Specify from rule network policy for cp (defaults to all namespaces)
networkPolicy.dataplane	object	{"from":[{"namespaceSelector":{}}]}	Configuration of the dataplane component
networkPolicy.dataplane.from	list	[{"namespaceSelector":{}}]	Specify from rule network policy for dp (defaults to all namespaces)
networkPolicy.enabled	bool	false	If true network policy will be created to restrict access to control- and dataplane
participant.id	string	"BPNLCHANGEME"	BPN Number
postgresql.auth.database	string	"edc"
postgresql.auth.password	string	"password"
postgresql.auth.username	string	"user"
postgresql.jdbcUrl	string	"jdbc:postgresql://{{ .Release.Name }}-postgresql:5432/edc"
postgresql.primary.persistence.enabled	bool	false
postgresql.readReplicas.persistence.enabled	bool	false
serviceAccount.annotations	object	{}
serviceAccount.create	bool	true
serviceAccount.imagePullSecrets	list	[]	Existing image pull secret bound to the service account to use to obtain the container image from private registries
serviceAccount.name	string	""
tests	object	{"hookDeletePolicy":"before-hook-creation,hook-succeeded"}	Configurations for Helm tests
tests.hookDeletePolicy	string	"before-hook-creation,hook-succeeded"	Configure the hook-delete-policy for Helm tests
vault.hashicorp.healthCheck.enabled	bool	true
vault.hashicorp.healthCheck.standbyOk	bool	true
vault.hashicorp.paths.health	string	"/v1/sys/health"
vault.hashicorp.paths.secret	string	"/v1/secret"
vault.hashicorp.timeout	int	30
vault.hashicorp.token	string	"root"
vault.hashicorp.url	string	"http://{{ .Release.Name }}-vault:8200"
vault.injector.enabled	bool	false
vault.secretNames.transferProxyTokenEncryptionAesKey	string	"transfer-proxy-token-encryption-aes-key"
vault.secretNames.transferProxyTokenSignerPrivateKey	string	nil
vault.secretNames.transferProxyTokenSignerPublicKey	string	nil
vault.server.dev.devRootToken	string	"root"
vault.server.dev.enabled	bool	true
vault.server.postStart	string	nil

---

Autogenerated from chart metadata using helm-docs v1.10.0