diff options
Diffstat (limited to 'docs/modules/ROOT/pages/sota-variables.adoc')
| -rw-r--r-- | docs/modules/ROOT/pages/sota-variables.adoc | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/docs/modules/ROOT/pages/sota-variables.adoc b/docs/modules/ROOT/pages/sota-variables.adoc deleted file mode 100644 index 7614a8a..0000000 --- a/docs/modules/ROOT/pages/sota-variables.adoc +++ /dev/null | |||
| @@ -1,44 +0,0 @@ | |||
| 1 | = Build Configuration Options | ||
| 2 | :page-partial: | ||
| 3 | // MC: Included in aktualizr/docs/ota-client-guide/modules/ROOT/pages/build-configuration.adoc | ||
| 4 | |||
| 5 | .OTA-related options for building disk images | ||
| 6 | [cols="1,2a",options="header"] | ||
| 7 | |==================== | ||
| 8 | | Option | Description | ||
| 9 | | `OSTREE_BRANCHNAME`|OSTree branch name. Defaults to `${SOTA_HARDWARE_ID}`. Particularly useful for grouping similar images. | ||
| 10 | | `OSTREE_REPO`|Path to your OSTree repository. Defaults to `$\{DEPLOY_DIR_IMAGE}/ostree_repo` | ||
| 11 | | `OSTREE_OSNAME`|OS deployment name on your target device. For more information about deployments and osnames see the https://ostree.readthedocs.io/en/latest/manual/deployment/[OSTree documentation]. Defaults to "poky". | ||
| 12 | | `OSTREE_COMMIT_BODY`|Message attached to OSTree commit. Empty by default. | ||
| 13 | | `OSTREE_COMMIT_SUBJECT`|Commit subject used by OSTree. Defaults to `Commit-id: ${IMAGE_NAME}` | ||
| 14 | | `OSTREE_UPDATE_SUMMARY`|Set this to '1' to update summary of OSTree repository on each commit. '0' by default. | ||
| 15 | | `OSTREE_DEPLOY_DEVICETREE`|Set this to '1' to include devicetree(s) to boot | ||
| 16 | | `GARAGE_SIGN_AUTOVERSION`|Set this to '1' to automatically fetch the last version of the garage tools installed by the aktualizr-native. Otherwise use the fixed version specified in the recipe. | ||
| 17 | | `GARAGE_TARGET_URL` | Sets the `--url` parameter of `garage-sign targets add`, which sets a custom URL for the Image repository targets. | ||
| 18 | | `GARAGE_TARGET_EXPIRES` | Sets the `--expires` parameter of `garage-sign targets sign`. Format is a UTC instant such as '2018-01-01T00:01:00Z'. | ||
| 19 | ifndef::env-github[] | ||
| 20 | [NOTE] | ||
| 21 | ==== | ||
| 22 | Currently, this only works when using the master branch of meta-updater. | ||
| 23 | ==== | ||
| 24 | endif::[] | ||
| 25 | | `GARAGE_TARGET_EXPIRE_AFTER` | Sets the `--expire-after` parameter of `garage-sign targets sign`. Format is in years, months, and days (each optional, but in that order), such as '1Y3M5D'. | ||
| 26 | ifndef::env-github[] | ||
| 27 | [NOTE] | ||
| 28 | ==== | ||
| 29 | Currently, this only works when using the master branch of meta-updater. | ||
| 30 | ==== | ||
| 31 | endif::[] | ||
| 32 | | `INITRAMFS_IMAGE`|The initramfs/initrd image that is used as a proxy while booting into OSTree deployment. Do not change this setting unless you are sure that your initramfs can serve as such a proxy. | ||
| 33 | | `SOTA_PACKED_CREDENTIALS`|When set, your ostree commit will be pushed to a remote repo as a bitbake step. This should be the path to a zipped credentials file in xref:dev@ota-build::provisioning-methods-and-credentialszip.adoc[the format accepted by garage-push]. | ||
| 34 | | `SOTA_DEPLOY_CREDENTIALS`|When set to '1' (default value), deploys credentials to the built image. Override it in `local.conf` to built a generic image that can be provisioned manually after the build. | ||
| 35 | | `SOTA_CLIENT_PROV`|Which provisioning method to use. Valid options are `aktualizr-shared-prov`, `aktualizr-device-prov`, and `aktualizr-device-prov-hsm`. For more information on these provisioning methods, see the xref:dev@ota-client::client-provisioning-methods.adoc[OTA Connect documentation]. The default is `aktualizr-shared-prov`. This can also be set to an empty string to avoid using a provisioning recipe. | ||
| 36 | | `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). | ||
| 37 | | `SOTA_SECONDARY_CONFIG`|A file containing JSON configuration for secondaries. It will be installed into `/etc/sota/ecus` on the device and automatically provided to aktualizr. See xref:dev@ota-client::posix-secondaries-bitbaking.adoc[here] for more details. | ||
| 38 | | `SOTA_HARDWARE_ID`|A custom hardware ID that will be written to the aktualizr config. Defaults to MACHINE if not set. | ||
| 39 | | `SOTA_MAIN_DTB`|The 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. | ||
| 40 | | `SOTA_DT_OVERLAYS`|A whitespace-separated list of used device tree overlays for FIT image. This list is OSTree-updateable as well. | ||
| 41 | | `SOTA_EXTRA_CONF_FRAGS`|Extra https://lxr.missinglinkelectronics.com/uboot/doc/uImage.FIT/overlay-fdt-boot.txt[configuration fragments] for FIT image. | ||
| 42 | | `RESOURCE_xxx_pn-aktualizr`|Controls maximum resource usage of the aktualizr service, when `aktualizr-resource-control` is installed on the image. See xref:dev@ota-build::meta-updater-usage.adoc#_aktualizr_service_resource_control[aktualizr service resource control] for details. | ||
| 43 | | `SOTA_POLLING_SEC`|Sets polling interval for aktualizr to check for updates if aktualizr-polling-interval is included in the image. | ||
| 44 | |==================== \ No newline at end of file | ||