diff --git a/README.md b/README.md index 53010ed..fb7e7c6 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Tractus-X Knowledge Agents AAS Bridges (KA-AAS) is a product of the [Tractus-X K * See the [User Documentation](docs/README.md) * See the [Architecture](docs/architecture/Arc42.md) * See the [Knowledge Agents OpenAPI](https://github.com/eclipse-tractusx/knowledge-agents/blob/main/docs/api/openAPI.yaml) and the [Asset Administration Shell OpenAPI](https://github.com/admin-shell-io/aas-specs-api/blob/main/Entire-API-Collection/V3.0.yaml) +* See the [Administration Guide](docs/admin/README.md) * See the [Authors](AUTHORS.md) * See the [Changelog](CHANGELOG.md) * See the [Code of Conduct](CODE_OF_CONDUCT.md) @@ -81,16 +82,6 @@ To update the [DEPENDENCIES](./DEPENDENCIES) declarations ./mvnw org.eclipse.dash:license-tool-plugin:license-check ``` -### Deployment - -Deployment can be done -* via [JAR libraries](https://github.com/orgs/eclipse-tractusx/packages?repo_name=knowledge-agents-aas-bridge&ecosystem=maven) copied into your Java runtime -* via [Docker images](https://hub.docker.com/r/tractusx) -* via [Helm Charts (Stable Versions)](https://eclipse-tractusx.github.io/charts/stable) or [Helm Charts (Dev Versions)](https://eclipse-tractusx.github.io/charts/stable) - -See the individual bridge documentations for more detailed deployment information -* [Knowledge Agents Sparql-To-AAS Bridge (KA-AAS-SPARQL)](sparql-aas/README.md) - #### Setup using Helm/Kind In order to run KA-RI applications via helm on your local machine, please make sure the following @@ -118,7 +109,6 @@ kind load docker-image docker.io/tractusx/aas-bridge:1.14.24-SNAPSHOT --name ka ct install --charts charts/aas-bridge ``` - ### Notice for Docker Images * [Notice for Knowledge Agents Sparql-To-AAS Bridge (KA-AAS-SPARQL)](sparql-aas/README.md#notice-for-docker-images) diff --git a/docs/README.md b/docs/README.md index a02777a..3d4fa9e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ +# Tractus-X Knowledge Agents AAS Bridges (KA-AAS) Administration Guide + +## Deployment + +Deployment can be done +* via [JAR libraries](https://github.com/orgs/eclipse-tractusx/packages?repo_name=knowledge-agents-aas-bridge&ecosystem=maven) copied into your Java runtime +* via [Docker images](https://hub.docker.com/r/tractusx) +* via [Helm Charts (Stable Versions)](https://eclipse-tractusx.github.io/charts/stable) or [Helm Charts (Dev Versions)](https://eclipse-tractusx.github.io/charts/stable) + + +## Helm Chart for Sparql-To-AAS Bridge + +A helm chart for deploying the bridge can be found under [this folder](../../charts/aas-bridge). + +It can be added to your umbrella chart.yaml by the following snippet + +```console +dependencies: + - name: aas-bridge + repository: https://eclipse-tractusx.github.io/charts/dev + version: 1.14.24-SNAPSHOT + alias: my-aas-bridge +``` + +and then installed using + +```console +helm dependency update +``` + +In your values.yml, you configure your specific instance of the conforming agent like this + +```console +aas-bridge: + aas: + persistence: + # -- The sparql server + sparql: http://oem-provider-agent:8082/sparql + endpoints: + default: + path: "/" + ingresses: + - enabled: true + hostname: *oemAasHost + annotations: + nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" +# nginx.ingress.kubernetes.io/ssl-passthrough: "true" +# nginx.ingress.kubernetes.io/ssl-redirect: "true" + endpoints: + - default + tls: + enabled: true + certManager: + clusterIssuer: *clusterIssuer +``` + + + diff --git a/sparql-aas/README.md b/sparql-aas/README.md index fca9926..9e9398a 100644 --- a/sparql-aas/README.md +++ b/sparql-aas/README.md @@ -116,7 +116,6 @@ Project home: https://projects.eclipse.org/projects/automotive.tractusx Dockerfile: https://github.com/eclipse-tractusx/knowledge-agents-aas-bridge/blob/main/sparql-aas/src/main/docker/Dockerfile Project license: Apache License, Version 2.0 - **Used base image** - [eclipse-temurin:23-jre-alpine](https://github.com/adoptium/containers)