Skip to content

Commit

Permalink
Merge pull request #107 from tributech-solutions/feature/exchange_sta…
Browse files Browse the repository at this point in the history
…rter_page_v3.6.0_to_v4.0.0

fix mistakes and update start page 3.6.0 to 4.0.0
  • Loading branch information
AndAscher authored Aug 29, 2024
2 parents 4f580b5 + 1df3668 commit 0d6b2e7
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ module.exports = {
'@docusaurus/preset-classic',
{
docs: {
lastVersion: '3.6.0',
lastVersion: '4.0.0',
routeBasePath: '/',
disableVersioning: false,
includeCurrentVersion: false,
Expand Down
14 changes: 7 additions & 7 deletions versioned_docs/version-4.0.0/tributech_agent/requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ sidebar_position: 2
import CodeBlock from '@theme/CodeBlock';
import SourceDockerCompose from '!!raw-loader!./examples/agent/docker-compose-agent-integration.yml';

In the following section we describe the hard- and software requirements to run a [Tributech Agent](overview.md) and a [Tributech Source](source_integration.md) on a edge device. An edge device serves as an endpoint on the network, bridging the gap between the [Tributech Node](../tributech_node/overview.md) and the real world (here representated as Customer Data).
In the following section we describe the hard- and software requirements to run a [Tributech Agent](overview.md) and a [Tributech Source](source_integration.md) on a edge device. An edge device serves as an endpoint on the network, bridging the gap between the [Tributech Node](../tributech_node/overview.md) and the real world (here representated as Customer Data).

![Tributech Edge Device - Overview](./img/EdgeDeviceOverview.png)


We will show how to gain access to the private Tributech Docker Images and what requirements need to be satisfied to
We will show how to gain access to the private Tributech Docker Images and what requirements need to be satisfied to
send Customer Data to a running [Tributech Node](../tributech_node/overview.md).

:warning: ***Access to a running Tributech Node Instance is required***

If you have any questions regarding infrastructure requirements, please talk to your contact person at Tributech or create a support ticket.

## Edge Device Requirements
Expand Down Expand Up @@ -51,15 +51,15 @@ Dependended on the frequency of data processing the requirements will increase a
| File System | any suppoerted docker file system | The user/instance which runs the docker containers must have read and write permission for the volume where the docker containers are situated. |

#### Network requirements
In the following Table we provide an overview of the required port for the communication between
In the following Table we provide an overview of the required port for the communication between
Tributech Node (public network) to the Tributech Agent (private network) (see [Overview](../introduction.md)).
This communication will take place via a public accessable network.

:warning: All of this ports are required for a Tributech Agent

|Port|Protocol|From|To|direction|Information|
| :------ | :----------- | :----------- | :----------- |:----------- | :--------------------- |
|443|HTTPS|Tributech Agent/Source| Azure Container Registry | Outbound | Access to the private Azure Container Registry containing [Tributech Docker Images](#docker-login)|
|443|HTTPS|Tributech Agent/Source| Azure Container Registry | Outbound | Access to the private Azure Container Registry containing [Tributech Docker Images](#docker-login) and also used in in the [Agent Enrollment](./setup#authentication-certificates-enrollment)) process.|
|1883|MQTTS|Tributech Agent|Tributech Node|Outbound|Communication protocol used between Tributech Agent and Node. MQTTS is the secure version of the MQTT protocol using TLS.|

#### Tributech Agent Source Requirements
Expand All @@ -79,7 +79,7 @@ that those ports need only be exposed in a private network between the customer
|851|ADS|Customer|Tributech Source|Outbound|[Tributech ADS Source](./sources/ads_source.mdx)|

#### Container environment
In our examples we use the [**Docker Engine**](https://docs.docker.com/engine/) and [**Docker Compose**](https://docs.docker.com/compose/) for the management/orchestration of the Docker services on an Ubuntu x86 system, for other systems visit the [official docker documentation](https://docs.docker.com/engine/install).
In our examples we use the [**Docker Engine**](https://docs.docker.com/engine/) and [**Docker Compose**](https://docs.docker.com/compose/) for the management/orchestration of the Docker services on an Ubuntu x86 system, for other systems visit the [official docker documentation](https://docs.docker.com/engine/install).

The [Tributech Agent](overview.md) and [Tributech Sources](source_integration.md) support the following architectures
- ARM 32/64
Expand All @@ -96,4 +96,4 @@ and use the information provided in the `Docker Registry Token` to authenticate

In order to gain access to the Tributech Agent docker image we need to provide docker with the credentials to access the private Tributech Docker Registry (see [docker login](https://docs.docker.com/engine/reference/commandline/login/)). The authentication information can be found in the `Secrets` section of the Tributech Node.

![**"Tributech Node Secrets area**](./img/secrets-docker-registry.png)
![**"Tributech Node Secrets area**](./img/secrets-docker-registry.png)
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ Webhooks send by the Tributech Node are HTTP objects that contain default HTTP i
| x-tributech-correlationid | A trace id to track the data through our node | 00000000-0000-0000-0000-000000000000 |
| x-tributech-eventid | unique identifier through the node (guid) to identify the event | 49acaa7b-fa72-4863-ab4b-7933fedeb59a |
| x-tributech-event | event name to identify the type of event | ValueReceivedEvent |
| x-tributech-signaturetimestamp | creation timestamp utc of the signature | 06/16/2023 05:08:46 +00:00 |
| x-tributech-signaturetimestamp | creation timestamp utc of the signature (timestamp format: [ISO 8601](https://de.wikipedia.org/wiki/ISO_8601)) | 06/16/2023 05:08:46 +00:00 |
| x-tributech-signature | signature of the webhook event | sha256=0316443119ED851EE18AA6176E8281E6A28<br />D02A52EAF5DC85D45A6149173F412 |
| x-tributech-timestamp | event timestamp utc | 06/16/2023 05:08:43 +00:00 |
| x-tributech-timestamp | event timestamp utc (timestamp format: [ISO 8601](https://de.wikipedia.org/wiki/ISO_8601)) | 06/16/2023 05:08:43 +00:00 |

### Event Types {#event-types}
When creating a Webhook subscription, we can choose what type of events we want to receive. We will describe in the following section the Events based on type of information they are providing, e.g. Device, Proof, Stream,.. .
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Agents can be referenced either by name or Id, e.g. [searching for an agent](#se
![***Online Tributech Agent details get id***](./img/agents-details-getid.png)

## Get a Stream Id
Collected data is always bound to a data stream which is a collection of information that can be identified by the unique StreamId, i.e. a GUID (Globally Unique Identifier). The StreamId can be used to access values and proofs via the [Tributech Node API](../api_category/API_usage.md) and map data from [Webhook Events](../Webhook_integration.md).
We can access the StreamId either via
Collected data is always bound to a data stream which is a collection of information that can be identified by the unique StreamId, i.e. a GUID (Globally Unique Identifier). The StreamId can be used to access values and proofs via the [Tributech Node API](../api_category/API_usage.md) and map data from [Webhook Events](../Webhook_integration.md).
We can access the StreamId either via

agent details (can be access by clicking the agent entry in the *Agent section*) actions:
![***Online Tributech Agent details get stream id***](./img/agent-details-get-stream-id.png)
Expand All @@ -57,8 +57,8 @@ or by inspecting a specific stream

## Configuring an Agent
After activating an the Tributech Agent (see [Agent Management](./agent_management.mdx#activate-agent)) we can configure the settings of an Tributech Agent
by changes the Digital Twin. Those settings include properties of the Triubtech Agent like naming, merkle deepth etc or managing relationships and associated [Triubtech Sources](../../tributech_agent/source_integration.md) and Source settings. The starting point for all this operations is the
`Twin Workspace` and we show in this section how to make changes to the Digital Twin. Details on how to configure specific Sources can be found in the corresponding [Triubtech Sources](../../tributech_agent/source_integration.md) overview.
by changes the Digital Twin. Those settings include properties of the Triubtech Agent like naming, merkle deepth etc or managing relationships and associated [Triubtech Sources](../../tributech_agent/source_integration.md) and Source settings. The starting point for all this operations is the
`Twin Workspace` and we show in this section how to make changes to the Digital Twin. Details on how to configure specific Sources can be found in the corresponding [Triubtech Sources](../../tributech_agent/source_integration.md) overview.
We can access the `Twin Workspace` either via selecting `Configure Agent` in the `actions context menu`.
![***Online Tributech Agent***](./img/agent-bond-agents-overview.png)

Expand All @@ -70,18 +70,20 @@ In the `Twin Workspace` we see on the right side as first fixed setting of the `

![***Tributech Agent Id***](./img/agent-bond-config-agent-id.png)

However, we can give this Tribteuch Agent a new name which will be displayed in the Agent Overview and will make finding this agent easier.
However, we can give this Tribteuch Agent a new name which will be displayed in the Agent Overview and will make finding this agent easier.

![***Tributech Agent Config Name***](./img/agent-bond-config-name.png)

:warning: The changes only takes effect when click `SAVE IN WORKSPACE` followed by `APPLY CONFIGURATION`.

![***Tribuech Agent Config Save Workspace***](./img/agent-bond-config-save-workspace.png)

## Adding data to an Agent
After the initial connect of an Tribtech Agent only one entry exists in the left side of the `Twin Workspace` and is named per default `Edge`(`dtmi:io:tributech:device:edge;1`). This entry represents the Tribtech Agent and should not be deleted but we can add a data ingress to this agent by adding [Triubtech Sources](../../tributech_agent/source_integration.md). We show in the following steps how to add a [Simulated Tributech Source](../../tributech_agent/sources/simulated_source.mdx) which we set up in our [QuickStart](../../tributech_agent/quickstart.mdx) and [Setup](../../tributech_agent/setup.mdx) `docker-compose.yml` sample file. By right clicking the `dtmi:io:tributech:device:edge;1` entry on the left side of the Twin Workspace we get a list of all available [Triubtech Sources](../../tributech_agent/source_integration.md) and select [Simulated Tributech Source](../../tributech_agent/sources/simulated_source.mdx):

![***Online Tributech Agent***](./img/agent-bond-add-simulated.png)

We now made the Tributech Agent aware of a connection between itself and a [Simulated Tributech Source](../../tributech_agent/sources/simulated_source.mdx). This enables us to manage the configuration of the Triubtech Source and receive data from it.
We now made the Tributech Agent aware of a connection between itself and a [Simulated Tributech Source](../../tributech_agent/sources/simulated_source.mdx). This enables us to manage the configuration of the Triubtech Source and receive data from it.

![***Edge Device focus Source***](./img/EdgeDeviceOverviewFocusSimulatedSource.png)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0d6b2e7

Please sign in to comment.