diff options
-rw-r--r-- | README.adoc | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc index 434c04c..01159a0 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -91,6 +91,7 @@ Your images will also need network connectivity to be able to reach an actual OT | |||
91 | * `SOTA_CLIENT_FEATURES` - extensions to aktualizr. The only valid options are `hsm` (to build with HSM support) and `secondary-network` (to set up a simulated 'in-vehicle' network with support for a primary node with a DHCP server and a secondary node with a DHCP client). | 91 | * `SOTA_CLIENT_FEATURES` - extensions to aktualizr. The only valid options are `hsm` (to build with HSM support) and `secondary-network` (to set up a simulated 'in-vehicle' network with support for a primary node with a DHCP server and a secondary node with a DHCP client). |
92 | * `SOTA_SECONDARY_CONFIG_DIR` - a directory containing JSON configuration files for virtual secondaries on the host. These will be installed into `/etc/sota/ecus` on the device and automatically provided to aktualizr. | 92 | * `SOTA_SECONDARY_CONFIG_DIR` - a directory containing JSON configuration files for virtual secondaries on the host. These will be installed into `/etc/sota/ecus` on the device and automatically provided to aktualizr. |
93 | * `SOTA_HARDWARE_ID` - a custom hardware ID that will be written to the aktualizr config. Defaults to MACHINE if not set. | 93 | * `SOTA_HARDWARE_ID` - a custom hardware ID that will be written to the aktualizr config. Defaults to MACHINE if not set. |
94 | * `RESOURCE_xxx_pn-aktualizr` - controls maximum resource usage of the aktualizr service, when `aktualizr-resource-control` is installed on the image. See <<aktualizr service resource control>> for details. | ||
94 | 95 | ||
95 | == Usage | 96 | == Usage |
96 | 97 | ||
@@ -156,6 +157,19 @@ Second, you can write recipes to install additional config files with customized | |||
156 | 157 | ||
157 | To use these recipes, you will need to add them to your image with a line such as `IMAGE_INSTALL_append = " aktualizr-log-debug "` in your `local.conf`. | 158 | To use these recipes, you will need to add them to your image with a line such as `IMAGE_INSTALL_append = " aktualizr-log-debug "` in your `local.conf`. |
158 | 159 | ||
160 | === aktualizr service resource control | ||
161 | |||
162 | With systemd based images, it is possible to set resource policies for the aktualizr service. The main use case is to provide a safeguard against resource exhaustion during an unforeseen failure scenario. | ||
163 | |||
164 | To enable it, install `aktualizr-resource-control` on the target image and optionally override the default resource limits set in link:recipes-sota/aktualizr/aktualizr_git.bb[aktualizr_git.bb], from your `local.conf`. | ||
165 | |||
166 | For example: | ||
167 | |||
168 | .... | ||
169 | IMAGE_INSTALL_append += " aktualizr-resource-control " | ||
170 | RESOURCE_CPU_WEIGHT_pn-aktualizr = "50" | ||
171 | .... | ||
172 | |||
159 | == Development configuration | 173 | == Development configuration |
160 | 174 | ||
161 | There are a few settings that can be controlled in `local.conf` to simplify the development process: | 175 | There are a few settings that can be controlled in `local.conf` to simplify the development process: |