Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
re-structure the connectivity section
* moved protocol bindings in there * moved websocket binding into httpapi section * adjusted arc image * fixed broken links Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch-si.com>
- Loading branch information
Showing
20 changed files
with
114 additions
and
54 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
Binary file modified
BIN
-6.92 KB
(73%)
documentation/src/main/resources/images/pages/architecture/context-overview.png
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
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
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
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
52 changes: 52 additions & 0 deletions
52
documentation/src/main/resources/pages/ditto/connectivity-manage-connections.md
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 @@ | ||
--- | ||
title: Manage connections in connectivity | ||
keywords: | ||
tags: [connectivity] | ||
permalink: connectivity-manage-connections.html | ||
--- | ||
|
||
In order to manage (CRUD) connections in Ditto [DevOps commands](installation-operating.html#connectivity-service-commands) | ||
have to be used. There is no separate HTTP API for managing the connections as this is not a task for a developer using | ||
the digital twin APIs but more for a "devops engineer" creating new connections to external systems very seldom. | ||
|
||
TODO move the example from the DevOps commands page to here - only describe the concept of piggyback commands there. | ||
|
||
## CRUD commands | ||
|
||
The following commands are available in order to manage connections: | ||
* [create](#create-connection) | ||
* [retrieve](#retrieve-connection) | ||
* [delete](#delete-connection) | ||
|
||
A "modify" is currently not available, use delete + create in order to modify existing connections. | ||
|
||
### Create connection | ||
|
||
TODO describe command | ||
|
||
### Retrieve connection | ||
|
||
TODO describe command | ||
|
||
### Delete connection | ||
|
||
TODO describe command | ||
|
||
## Helper commands | ||
|
||
The following commands are available in help creating connections + retrieve the status of existing connections: | ||
* [test](#test-connection) | ||
* [retrieve desired connection status](#retrieve-connection-status) | ||
* [retrieve actual connection status + metrics](#retrieve-connection-metrics) | ||
|
||
### Test connection | ||
|
||
TODO describe command | ||
|
||
### Retrieve connection status | ||
|
||
TODO describe command | ||
|
||
### Retrieve connection metrics | ||
|
||
TODO describe command |
2 changes: 1 addition & 1 deletion
2
documentation/src/main/resources/pages/ditto/connectivity-mapping.md
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
20 changes: 10 additions & 10 deletions
20
.../pages/ditto/protocol-bindings-amqp091.md → ...connectivity-protocol-bindings-amqp091.md
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 |
---|---|---|
@@ -1,39 +1,39 @@ | ||
--- | ||
title: AMQP 0.9.1 protocol binding | ||
keywords: binding, protocol, amqp, amqp10 | ||
tags: [protocol] | ||
permalink: protocol-bindings-amqp091.html | ||
keywords: binding, protocol, amqp, amqp091, rabbitmq | ||
tags: [protocol, connectivity] | ||
permalink: connectivity-protocol-bindings-amqp091.html | ||
--- | ||
|
||
The Ditto Protocol message can be sent *as is* as **AMQP 1.0** message. | ||
The Ditto Protocol message can be sent *as is* as **AMQP 0.9.1** message. | ||
The Ditto Protocol JSON must be sent as `UTF-8` encoded String payload. | ||
|
||
The `content-type` of AMQP 1.0 messages must be set to: | ||
The `content-type` of AMQP 0.9.1 messages must be set to: | ||
|
||
``` | ||
application/vnd.eclipse.ditto+json | ||
``` | ||
|
||
## AMQP 1.0 properties | ||
## AMQP 0.9.1 properties | ||
|
||
Supported AMQP 1.0 properties which are interpreted in a specific way are: | ||
Supported AMQP 0.9.1 properties which are interpreted in a specific way are: | ||
|
||
* `content-type`: for defining the Ditto Protocol content-type | ||
* `correlation-id`: for correlating request messages to responses | ||
|
||
|
||
## Establishing connecting to an AMQP 1.0 endpoint | ||
## Establishing connecting to an AMQP 0.9.1 endpoint | ||
|
||
Ditto's [Connectivity service](architecture-services-connectivity.html) is responsible for creating new and managing | ||
existing connections. | ||
|
||
This can be done dynamically at runtime without the need to restart any microservice using a | ||
[Ditto operations command](installation-operating.html#create-a-new-amqp-bridge-connection). | ||
[Ditto operations command](installation-operating.html#connectivity-service-commands). | ||
|
||
|
||
## Messages | ||
|
||
Messages consumed via the AMQP 1.0 binding are treated similar to the [WebSocket binding](protocol-bindings-websocket.html) | ||
Messages consumed via the AMQP 1.0 binding are treated similar to the [WebSocket binding](httpapi-protocol-bindings-websocket.html) | ||
meaning that the messages are expected to be [Ditto Protocol](protocol-overview.html) messages serialized as JSON (as | ||
shown for example in the [protocol examples](protocol-examples.html)). | ||
|
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
8 changes: 4 additions & 4 deletions
8
...ages/ditto/protocol-bindings-websocket.md → ...to/httpapi-protocol-bindings-websocket.md
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
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