NOISSUE - Update magistrala messaging #188
Open
Conversation
This file contains hidden or 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
Signed-off-by: nyagamunene <[email protected]>
Signed-off-by: nyagamunene <[email protected]>
Signed-off-by: nyagamunene <[email protected]>
Signed-off-by: nyagamunene <[email protected]>
Signed-off-by: nyagamunene <[email protected]>
Signed-off-by: nyagamunene <[email protected]>
felixgateru
requested changes
May 22, 2024
|
|
||
| Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols. | ||
| Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols, with the examples being shown without TLS, with TLS, and with mTLS. | ||
| > While using MTLS the `thing.crt` and `thing.crt` can be genarated by running `make thing_cert` while in the `docker/ssl` folder |
There was a problem hiding this comment.
thing.key and thing crt.
|
|
||
| Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols. | ||
| Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols, with the examples being shown without TLS, with TLS, and with mTLS. | ||
| > While using MTLS the `thing.crt` and `thing.crt` can be genarated by running `make thing_cert` while in the `docker/ssl` folder |
There was a problem hiding this comment.
Also as it is mtls would it be more appropriate to have magistrala-client.key and magistrala-client.crt
docs/messaging.md
Outdated
| ## HTTP | ||
|
|
||
| To publish message over channel, thing should send following request: | ||
| The following environmental variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file. |
There was a problem hiding this comment.
Suggested change
| The following environmental variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file. | |
| The following environment variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file. |
docs/messaging.md
Outdated
|
|
||
| ### Without TLS | ||
|
|
||
| To use magistala HTTP without TLS, comment out all of the listed environment variables provided above. To publish message over channel, thing should send following request: |
There was a problem hiding this comment.
You can also mention or provide an example for subscribing.
| ## MQTT | ||
|
|
||
| To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket. | ||
| The following environmental variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`. |
There was a problem hiding this comment.
Suggested change
| The following environmental variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`. | |
| The following environment variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`. |
rodneyosodo
requested changes
May 22, 2024
| panic(token.Error()) | ||
| } | ||
| } | ||
|
|
| } | ||
| return []byte{}, nil | ||
| } | ||
|
|
| To use magistala HTTP without TLS, comment out all of the listed environment variables provided above. To publish message over channel, thing should send following request: | ||
|
|
||
| ```bash | ||
| curl -s -S -i -X POST -H "Content-Type: application/senml+json" -H "Authorization: Thing <thing_secret>" http://localhost/http/channels/<channel_id>/messages -d '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]' |
There was a problem hiding this comment.
For all examples add expected outputs
felixgateru
requested changes
May 22, 2024
docs/messaging.md
Outdated
|
|
||
| ### With TLS | ||
|
|
||
| Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates. |
There was a problem hiding this comment.
Suggested change
| Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates. | |
| Uncomment the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates. |
JeffMboya
requested changes
May 22, 2024
|
|
||
| ## MQTT | ||
|
|
||
| To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket. |
There was a problem hiding this comment.
Suggested change
| To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket. | |
| To send and receive messages over MQTT, you can use [Mosquitto tools][mosquitto]. If you prefer to use MQTT over WebSocket, you can use [Paho][paho]. |
Signed-off-by: nyagamunene <[email protected]>
|
@nyagamunene @JeffMboya What's the status of this PR? |
It was placed on hold because it is dependant on this PR |
|
@nyagamunene What's the status of this PR? |
This is not ready it related to mtls and tls messaging |
|
This PR is related to absmach/supermq#2126 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do?
It updated Magistrala messaging docs. It provides examples of how to do it.
List any changes that modify/break current functionality
It adds the functionality of running Magistrala with TLS and MTLS.
Have you included tests for your changes?
Yes.
Did you document any new/modified functionality?
Yes
Notes