-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #123 from big-data-spaces/feature/lacking-document…
…ation-trgs docs: lacking documentation trgs
- Loading branch information
Showing
7 changed files
with
286 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <!-- | ||
| * Copyright (c) 2022,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 | ||
| --> | ||
|
|
||
| # Tractus-X Knowledge Agents AAS Bridges (KA-AAS) Documentation | ||
|
|
||
| In the [Knowledge Agent Architecture](architecture/Arc42.md), an Agent is any component which speaks and/or enacts a Semantic Web protocol, such as SPARQL. | ||
|
|
||
| According to AAS Part 1 & 2, an "Asset Administration Shell" (Server, Registry) is a component that allows to represent and query a source using a predefined REST Api. | ||
|
|
||
| Both Knowledge Agents as well as AAS components are expected to be compatible to the [Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc) connector. | ||
|
|
||
| A Bridge is a component which adapts the interface of one technology/standard (such as AAS) into the interface of the other (Knowledge Agent/Semantic Web). | ||
|
|
||
| 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) for reference. | ||
|
|
||
| ## How it works | ||
|
|
||
| ### KA AAS Bridge | ||
|
|
||
|  | ||
|
|
||
| Currently we provide an AAS server/AAS registry interface that is backed by a one or several agents where the agents themselves could be Binding Agents or even Matchmaking Agents - see the [Knowledge Agent Architecture](architecture/Arc42.md) | ||
|
|
||
| ## Deployment | ||
|
|
||
| See the [Administration Guide](admin/README.md) | ||
|
|
||
| ## NOTICE | ||
|
|
||
| This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). | ||
|
|
||
| - SPDX-License-Identifier: Apache-2.0 | ||
| - SPDX-FileCopyrightText: 2022,2023 T-Systems International GmbH | ||
| - SPDX-FileCopyrightText: 2022,2023 Contributors to the Eclipse Foundation | ||
| - Source URL: https://github.com/eclipse-tractusx/knowledge-agents |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| <!-- | ||
| * Copyright (c) 2022,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 | ||
| --> | ||
| # 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 | ||
| ``` | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.