1616 - [ Run the agent] ( #run-the-agent )
1717 - [ Test the agent] ( #test-the-agent )
1818- [ Debian package (DEB)] ( #debian-package-deb )
19+
1920</details >
2021
2122## Overview
3132The agent supports MQTT for communication with cloud services.
3233
3334There are two supported cloud services:
34- - [ Azure IoT Central] ( ../../docs/In-Band%20Manageability%20User%20Guide%20-%20Azure.md )
35- - [ ThingsBoard] ( ../../docs/In-Band%20Manageability%20User%20Guide%20-%20ThingsBoard.md )
35+
36+ - [ Azure IoT Central] ( ../../docs/In-Band%20Manageability%20User%20Guide%20-%20Azure.md )
37+ - [ ThingsBoard] ( ../../docs/In-Band%20Manageability%20User%20Guide%20-%20ThingsBoard.md )
3638
3739### Intel Manageability
3840
3941The agent uses MQTT for communication with other agents.
4042
4143#### Publish channels
44+
4245The agent publishes to the following topics:
43- - cloudadapter-agent state: ` cloudadapter/state ` when dead/running
44- - Manifest install requests: ` manageability/request/ `
46+
47+ - cloudadapter-agent state: ` cloudadapter/state ` when dead/running
48+ - Manifest install requests: ` manageability/request/ `
4549
4650#### Subscribe channels
51+
4752The agent subscribes to the following topics:
48- - Agent states: ` +/state `
49- - Agent events: ` manageability/event `
50- - Responses: ` manageability/response `
51- - Device telemetry: ` manageability/telemetry `
52- - Update from scheduled requests: ` manageability/nodeupdate `
53+
54+ - Agent states: ` +/state `
55+ - Agent events: ` manageability/event `
56+ - Responses: ` manageability/response `
57+ - Device telemetry: ` manageability/telemetry `
58+ - Update from scheduled requests: ` manageability/nodeupdate `
5359
5460❗` + ` is a wild-card indicating single level thus matching ` diagnostic/state ` or ` <another-agent>/state `
5561
5662Events or responses sent to the agent are logged or published to the cloud as-is.
5763
5864Device telemetry sent to the agent should have the following schema:
65+
5966``` json
6067{
6168 "type" : " object" ,
@@ -79,7 +86,9 @@ Device telemetry sent to the agent should have the following schema:
7986 }
8087}
8188```
89+
8290For example:
91+
8392``` json
8493{
8594 "type" : " dynamic_telementry" ,
@@ -91,46 +100,51 @@ For example:
91100```
92101
93102## Install from Source
94- ❗ Use a Python version greater than 3.12 is installed
103+
104+ ❗ Use a Python version greater than 3.13 is installed
95105
96106- [ Build INBM] ( #../../README.md#build-instructions )
97107- [ Install INBM] ( #../../docs/In-Band%20Manageability%20Installation%20Guide%20Ubuntu.md )
98108
99109## Usage
110+
100111❗Ensure Mosquitto broker is installed and configured for Intel(R) In-Band Manageability.
101112❗Some commands will require root privileges (sudo)
102113❗Run commands in the ` inbm/cloudadapter-agent ` directory
103114
115+ ### Setup
104116
105- ### Setup:
106117- Run: ` make config `
107118- Refer to the following documents for cloud setup:
108119 - [ Azure] ( #../../docs/In-Band%20Manageability%20User%20Guide%20-%20Azure.md )
109120 - [ Thingsboard] ( #../../docs/In-Band%20Manageability%20User%20Guide%20-%20ThingsBoard.md )
110121
111- ### Changing the logging level:
122+ ### Changing the logging level
112123
113124- Run: ` make logging LEVEL=DEBUG `
114125- Valid values for ` LEVEL ` :
115126 - ` DEBUG `
116127 - ` ERROR `
117128 - ` INFO `
118129
119- ### Run the agent:
130+ ### Run the agent
120131
121132- Run: ` make run `
122133
123- ### Test the agent:
134+ ### Test the agent
124135
125136- Run: ` make tests `
126137
127138## Debian package (DEB)
128139
129140### Install (For Ubuntu)
141+
130142After building the above package, if you only want to install the cloudadpater-agent, you can do so by following these steps:
143+
131144- ` cd dist/inbm `
132145- Unzip package: ` sudo tar -xvf Intel-Manageability.preview.tar.gz `
133146- Install package: ` dpkg -i cloudadapter-agent<latest>.deb `
134147
135148### Uninstall (For Ubuntu)
149+
136150- ` dpkg --purge cloudadapter-agent `
0 commit comments