Skip to content

Commit e4f40e9

Browse files
authoredFeb 2, 2023
Markdown linting
Signed-off-by: GitHub <noreply@github.com>
1 parent 766e06d commit e4f40e9

File tree

4 files changed

+50
-24
lines changed

4 files changed

+50
-24
lines changed
 

‎.markdownlint.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"MD033": false,
3+
"MD013": {
4+
"line_length": 160
5+
}
6+
}

‎content/en/docs/device-provisioning/container-management/_index.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ When one of the cloud connector components, such as leda-contrib-cloud-connector
3030
- `namespace` is `azure.edge` for Kanto's Azure Cloud Connector
3131
- `gatewayId` indicates the hostname of the Azure IoT Hub
3232
- `deviceId` is the identifier for the device, this can either be part of the Azure Connection String or part of the device authentication certificate (CN)
33-
- `<tenantId>` is a configuration setting in the cloud connector
33+
- `tenantId` is a configuration setting in the cloud connector
3434

3535
> **Note:** You can simulate the cloud connector trigger by issueing the MQTT message manually on command line:
36-
37-
mosquitto_pub -t 'edge/thing/response' -m '{"deviceId":"dummy-namespace:dummy-gateway:dummy-device-id","tenantId":"dummy-tenant-id"}'
36+
37+
```shell
38+
mosquitto_pub -t 'edge/thing/response' -m '{"deviceId":"dummy-namespace:dummy-gateway:dummy-device-id","tenantId":"dummy-tenant-id"}'
39+
```
3840

3941
3. Container Management responds with a list of containers in the topic `e/<tenantId>/<gatewayId>:<deviceId>:edge:containers`
4042

@@ -84,6 +86,7 @@ When one of the cloud connector components, such as leda-contrib-cloud-connector
8486
}
8587
}
8688
```
89+
8790
4. Container Management answers with an additional message for each container in the topic `e/<tenantId>/<gatewayId>:<deviceId>:edge:containers`
8891

8992
```json

‎content/en/docs/device-provisioning/self-update/rauc-integration.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ Leda integrates [RAUC](https://rauc.io/) as a reference implementation and examp
1010

1111
Get the current RAUC boot status:
1212

13-
rauc status
14-
13+
```shell
14+
rauc status
15+
```
1516

1617
Example output:
17-
```
18+
19+
```shell
1820
root@qemux86-64:~# rauc status
1921
=== System Info ===
2022
Compatible: Eclipse Leda qemu86-64
@@ -40,7 +42,7 @@ x [rootfs.0] (/dev/sda4, ext4, booted)
4042

4143
To manually force the device to boot into another slot, mark the current booted slot as *bad*, mark the other partitions as *active* and perform a reboot:
4244

43-
```
45+
```shell
4446
rauc status mark-bad booted
4547
rauc status mark-active other
4648
reboot now
@@ -50,14 +52,15 @@ reboot now
5052

5153
By marking both root slots as bad, the bootloader is supposed to boot the rescue system:
5254

53-
```
55+
```shell
5456
rauc status mark-bad rootfs.0
5557
rauc status mark-bad rootfs.1
5658
reboot now
5759
```
5860

5961
Example output of rauc:
60-
```
62+
63+
```shell
6164
o [rootfs.1] (/dev/sda5, ext4, inactive)
6265
bootname: B
6366
boot status: bad
@@ -78,10 +81,11 @@ The configurations can be customized by applying or patching the following files
7881

7982
## RAUC System Configuration
8083

81-
The [RAUC System Configuration ](https://rauc.readthedocs.io/en/latest/integration.html#rauc-system-configuration) is the central configuration of the RAUC Update system.
84+
The [RAUC System Configuration](https://rauc.readthedocs.io/en/latest/integration.html#rauc-system-configuration) is the central configuration of the RAUC Update system.
8285

8386
Example:
84-
```
87+
88+
```shell
8589
[system]
8690
compatible=Eclipse Leda qemu86-64
8791
bootloader=grub
@@ -120,7 +124,8 @@ The GRUB bootloader has a configuration file which describes which partitions ar
120124
The configuration also contains **RAUC specific logic and variables required for a proper integration**. Please see the full `grub.cfg` in the source repository and [RAUC Documentation - Integration - GRUB](https://rauc.readthedocs.io/en/latest/integration.html#grub) for details.
121125

122126
Excerpt:
123-
```
127+
128+
```text
124129
...
125130
126131
menuentry "SDV Slot A (OK=$SDV_A_OK TRY=$SDV_A_TRY)" {
@@ -152,8 +157,9 @@ These disk images are machine specific and the structure of the partitions are c
152157

153158
### Excerpt `qemux86-grub-efi.wks`
154159

155-
*Note: The excerpt is exemplary, please see the sources for a full representation and documentation.*
156-
```
160+
*Note: The excerpt is exemplary, please see the sources for a full representation and documentation.*
161+
162+
```text
157163
bootloader --ptable gpt
158164
159165
part --fixed-size 50M --source rawcopy --sourceparams="file=efi-boot.vfat" --fstype=vfat --label boot --active

‎content/en/docs/device-provisioning/self-update/self-update-tutorial.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,41 @@ weight: 1
66

77
This chapter describes the steps necessary to perform a local (without cloud) self update of the operating system.
88

9-
![](../self-update-arch.png)
9+
![Self Update Architecture](../self-update-arch.png)
1010

1111
## Self-Update using RAUC Update Bundles
1212

1313
- On host: Update bundle `sdv-rauc-bundle-qemux86-64.raucb` is in current folder
1414

15-
*Note: In the development environment, the update RAUC Update Bundle is located in the BitBake machine-specific output folder, for example `tmp/deploy/images/qemux86-64`*
15+
*Note: In the development environment, the update RAUC Update Bundle is located in the BitBake machine-specific output folder
16+
Example location is `tmp/deploy/images/qemux86-64`*
17+
1618
- On host: Start a dummy web server for serving the update file
1719

18-
python3 -m http.server --bind 192.168.7.1
20+
```shell
21+
python3 -m http.server --bind 192.168.7.1
22+
```
1923

2024
- On host: open two new terminals - one for monitoring and one for triggering the self-update
2125

22-
- Terminal 1: To view the progress, watch the MQTT topics `selfupdate/desiredstate` and `selfupdate/desiredstatefeedback`:
26+
- Terminal 1: To view the progress, watch the MQTT topics `selfupdate/desiredstate` and `selfupdate/desiredstatefeedback`:
2327

24-
mosquitto_sub -h 192.168.7.2 -p 1883 -t "selfupdate/#"
28+
```shell
29+
mosquitto_sub -h 192.168.7.2 -p 1883 -t "selfupdate/#"
30+
```
2531

26-
- Terminal 2: Trigger the actual self update process by publishing an MQTT message to `selfupdate/desiredstate`:
32+
- Terminal 2: Trigger the actual self update process by publishing an MQTT message to `selfupdate/desiredstate`:
2733

28-
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate" -f start-update-example.json
34+
```shell
35+
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate" -f start-update-example.json
36+
```
2937

3038
- Switch to a terminal in the guest
3139
- On guest: After the self update process completed, check the status:
3240

33-
rauc status --detailed
41+
```shell
42+
rauc status --detailed
43+
```
3444

3545
## Self-Update Trigger Message
3646

@@ -45,6 +55,7 @@ This chapter describes the steps necessary to perform a local (without cloud) se
4555
1. Initial response message on startup from self update agent in topic `selfupdate/currentstate`, or upon request by sending message to `selfupdate/currentstate/get`
4656

4757
Request:
58+
4859
```json
4960
{
5061
"activityId": "<uuid>",
@@ -53,6 +64,7 @@ This chapter describes the steps necessary to perform a local (without cloud) se
5364
```
5465

5566
Response:
67+
5668
```json
5769
{
5870
"activityId": "<uuid>",
@@ -73,7 +85,6 @@ This chapter describes the steps necessary to perform a local (without cloud) se
7385
}
7486
```
7587

76-
7788
### Desired State
7889

7990
1. External trigger to update via desired state on topic `selfupdate/desiredstate`:
@@ -212,4 +223,4 @@ This chapter describes the steps necessary to perform a local (without cloud) se
212223
]
213224
}
214225
}
215-
```
226+
```

0 commit comments

Comments
 (0)