summaryrefslogtreecommitdiffstats
path: root/README.adoc
diff options
context:
space:
mode:
authorLaurent Bonnans <laurent.bonnans@here.com>2019-03-12 11:29:04 +0100
committerLaurent Bonnans <laurent.bonnans@here.com>2019-03-13 15:36:37 +0100
commitececedcbd58a7cd04eea0a7faf7b04939536a555 (patch)
tree0c3b83559948a5c073dc482083cc69818bb24b71 /README.adoc
parent8e3886a8ae5c292d0c0ac8245f72ec55ef27bf6c (diff)
downloadmeta-updater-ececedcbd58a7cd04eea0a7faf7b04939536a555.tar.gz
Document aktualizr-resource-control
Signed-off-by: Laurent Bonnans <laurent.bonnans@here.com>
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index f3aef45..0ce1069 100644
--- a/README.adoc
+++ b/README.adoc
@@ -95,6 +95,7 @@ Your images will also need network connectivity to be able to reach an actual OT
95* `SOTA_MAIN_DTB` - base device tree to use with the kernel. Used together with FIT images. You can change it, and the device tree will also be changed after the update. 95* `SOTA_MAIN_DTB` - base device tree to use with the kernel. Used together with FIT images. You can change it, and the device tree will also be changed after the update.
96* `SOTA_DT_OVERLAYS` - whitespace-separated list of used device tree overlays for FIT image. This list is OSTree-updateable as well. 96* `SOTA_DT_OVERLAYS` - whitespace-separated list of used device tree overlays for FIT image. This list is OSTree-updateable as well.
97* `SOTA_EXTRA_CONF_FRAGS` - extra https://lxr.missinglinkelectronics.com/uboot/doc/uImage.FIT/overlay-fdt-boot.txt[configuration fragments] for FIT image. 97* `SOTA_EXTRA_CONF_FRAGS` - extra https://lxr.missinglinkelectronics.com/uboot/doc/uImage.FIT/overlay-fdt-boot.txt[configuration fragments] for FIT image.
98* `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.
98 99
99== Usage 100== Usage
100 101
@@ -160,6 +161,19 @@ Second, you can write recipes to install additional config files with customized
160 161
161To 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`. 162To 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`.
162 163
164=== aktualizr service resource control
165
166With 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.
167
168To 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`.
169
170For example:
171
172....
173IMAGE_INSTALL_append += " aktualizr-resource-control "
174RESOURCE_CPU_WEIGHT_pn-aktualizr = "50"
175....
176
163== Development configuration 177== Development configuration
164 178
165There are a few settings that can be controlled in `local.conf` to simplify the development process: 179There are a few settings that can be controlled in `local.conf` to simplify the development process: