Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: advancedtelematic/aktualizr
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 9ae8adba8881787c19c3ea53d609a490522f3c4e
Choose a base ref
..
head repository: advancedtelematic/aktualizr
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 46a07c242ae566014a1a4063822d0bc44ab53b6e
Choose a head ref
Showing with 4,540 additions and 1,501 deletions.
  1. +1 −0 .gitignore
  2. +1 −1 docs/Doxyfile.in
  3. +0 −18 docs/INDEX.md
  4. +9 −28 docs/README.adoc
  5. +0 −39 docs/client-provisioning-methods.adoc
  6. +1 −0 docs/client-provisioning-methods.adoc
  7. +0 −169 docs/configuration.adoc
  8. +1 −0 docs/configuration.adoc
  9. +0 −49 docs/deb-package-install.adoc
  10. +1 −0 docs/deb-package-install.adoc
  11. +0 −183 docs/debugging-tips.adoc
  12. +1 −0 docs/debugging-tips.adoc
  13. +0 −153 docs/ecu_events.adoc
  14. +1 −0 docs/ecu_events.adoc
  15. +0 −67 docs/fault-injection.adoc
  16. +1 −0 docs/fault-injection.adoc
  17. +0 −14 docs/integrate-libaktualizr.adoc
  18. +1 −0 docs/integrate-libaktualizr.adoc
  19. +5 −0 docs/ota-client-guide/antora.yml
  20. +4 −0 docs/ota-client-guide/modules/ROOT/_attributes.adoc
  21. +4 −0 docs/ota-client-guide/modules/ROOT/assets/attachments/dual-bank-system-update-flow.svg
  22. +4 −0 docs/ota-client-guide/modules/ROOT/assets/attachments/ostree-update-flow.svg
  23. BIN docs/{ → ota-client-guide/modules/ROOT/assets/images}/clion-debugger.png
  24. +4 −0 docs/ota-client-guide/modules/ROOT/assets/images/dual-bank-system-update-flow.svg
  25. +4 −0 docs/ota-client-guide/modules/ROOT/assets/images/ostree-update-flow.svg
  26. BIN docs/ota-client-guide/modules/ROOT/assets/images/prov-diff-devices.png
  27. BIN docs/ota-client-guide/modules/ROOT/assets/images/prov-diff-infra.png
  28. BIN docs/ota-client-guide/modules/ROOT/assets/images/s1-prov.png
  29. BIN docs/ota-client-guide/modules/ROOT/assets/images/s5-install_device.png
  30. BIN docs/ota-client-guide/modules/ROOT/assets/images/screenshot_provisioning_key_2.png
  31. BIN docs/ota-client-guide/modules/ROOT/assets/images/security-channels.png
  32. +366 −0 docs/ota-client-guide/modules/ROOT/examples/start.sh
  33. +104 −0 docs/ota-client-guide/modules/ROOT/nav.adoc
  34. +2 −0 docs/ota-client-guide/modules/ROOT/pages/_attributes.adoc
  35. 0 docs/ota-client-guide/modules/ROOT/pages/_partials/build-ota-enabled-images.adoc
  36. +5 −0 docs/ota-client-guide/modules/ROOT/pages/_partials/how-prov-with-device-cred.adoc
  37. +48 −0 docs/ota-client-guide/modules/ROOT/pages/_partials/recommended-steps-brief.adoc
  38. +101 −0 docs/ota-client-guide/modules/ROOT/pages/_partials/recommended-steps.adoc
  39. +14 −0 docs/ota-client-guide/modules/ROOT/pages/_partials/why-different-prov-methods.adoc
  40. +11 −0 docs/ota-client-guide/modules/ROOT/pages/account-setup.adoc
  41. +68 −0 docs/ota-client-guide/modules/ROOT/pages/add-ota-functonality-existing-yocto-project.adoc
  42. +23 −0 docs/ota-client-guide/modules/ROOT/pages/adoc-test.adoc
  43. +175 −0 docs/ota-client-guide/modules/ROOT/pages/aktualizr-config-options.adoc
  44. +88 −0 docs/ota-client-guide/modules/ROOT/pages/aktualizr-runningmodes-finegrained-commandline-control.adoc
  45. +1 −0 docs/ota-client-guide/modules/ROOT/pages/build-agl.adoc
  46. +5 −0 docs/ota-client-guide/modules/ROOT/pages/build-images.adoc
  47. +12 −0 docs/ota-client-guide/modules/ROOT/pages/build-only-ostree.adoc
  48. +3 −0 docs/ota-client-guide/modules/ROOT/pages/build-ota-enabled-images.adoc
  49. +1 −0 docs/ota-client-guide/modules/ROOT/pages/build-quemu.adoc
  50. +2 −0 docs/ota-client-guide/modules/ROOT/pages/build-raspberry.adoc
  51. +72 −0 docs/ota-client-guide/modules/ROOT/pages/client-provisioning-methods.adoc
  52. +51 −0 docs/ota-client-guide/modules/ROOT/pages/cross-deploy-images.adoc
  53. +49 −0 docs/ota-client-guide/modules/ROOT/pages/deb-package-install.adoc
  54. +183 −0 docs/ota-client-guide/modules/ROOT/pages/debugging-tips.adoc
  55. +41 −0 docs/ota-client-guide/modules/ROOT/pages/deploy-checklist.adoc
  56. +64 −0 docs/ota-client-guide/modules/ROOT/pages/developer-tools.adoc
  57. +24 −0 docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-steps.adoc
  58. +23 −0 docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-teststeps.adoc
  59. +3 −0 docs/ota-client-guide/modules/ROOT/pages/download-prov-key.adoc
  60. +153 −0 docs/ota-client-guide/modules/ROOT/pages/ecu_events.adoc
  61. +127 −0 docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provisioning.adoc
  62. +126 −0 docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provtest.adoc
  63. +22 −0 docs/ota-client-guide/modules/ROOT/pages/enable-shared-cred-provisioning.adoc
  64. +40 −0 docs/ota-client-guide/modules/ROOT/pages/evaluation-to-prod.adoc
  65. +67 −0 docs/ota-client-guide/modules/ROOT/pages/fault-injection.adoc
  66. +66 −0 docs/ota-client-guide/modules/ROOT/pages/generate-devicecert.adoc
  67. +30 −0 docs/ota-client-guide/modules/ROOT/pages/generate-selfsigned-root.adoc
  68. +62 −0 docs/ota-client-guide/modules/ROOT/pages/generatetest-devicecert.adoc
  69. +19 −0 docs/ota-client-guide/modules/ROOT/pages/how-can-i-check-which-ostree-version-is-installed.adoc
  70. +28 −0 docs/ota-client-guide/modules/ROOT/pages/index.adoc
  71. +86 −0 docs/ota-client-guide/modules/ROOT/pages/install-garage-sign-deploy.adoc
  72. +5 −0 docs/ota-client-guide/modules/ROOT/pages/intro-evaluate.adoc
  73. +33 −0 docs/ota-client-guide/modules/ROOT/pages/intro-prep.adoc
  74. +38 −0 docs/ota-client-guide/modules/ROOT/pages/intro-prod.adoc
  75. +292 −0 docs/ota-client-guide/modules/ROOT/pages/libaktualizr-getstarted.adoc
  76. +8 −0 docs/ota-client-guide/modules/ROOT/pages/libaktualizr-integrate.adoc
  77. +109 −0 docs/ota-client-guide/modules/ROOT/pages/libaktualizr-update-secondary.adoc
  78. +25 −0 docs/ota-client-guide/modules/ROOT/pages/libaktualizr-why-use.adoc
  79. +32 −0 docs/ota-client-guide/modules/ROOT/pages/metadata-expiry.adoc
  80. +51 −0 docs/ota-client-guide/modules/ROOT/pages/ostree-and-treehub.adoc
  81. +36 −0 docs/ota-client-guide/modules/ROOT/pages/ostree-usage.adoc
  82. +30 −0 docs/ota-client-guide/modules/ROOT/pages/pki.adoc
  83. +199 −0 docs/ota-client-guide/modules/ROOT/pages/posix-secondaries-bitbaking.adoc
  84. +108 −0 docs/ota-client-guide/modules/ROOT/pages/posix-secondaries.adoc
  85. +15 −0 docs/ota-client-guide/modules/ROOT/pages/provide-root-cert.adoc
  86. +13 −0 docs/ota-client-guide/modules/ROOT/pages/provide-testroot-cert.adoc
  87. +54 −0 docs/ota-client-guide/modules/ROOT/pages/provisioning-methods-and-credentialszip.adoc
  88. +108 −0 docs/ota-client-guide/modules/ROOT/pages/pushing-updates.adoc
  89. +36 −0 docs/ota-client-guide/modules/ROOT/pages/recommended-clientconfig.adoc
  90. +60 −0 docs/ota-client-guide/modules/ROOT/pages/rollback.adoc
  91. +93 −0 docs/ota-client-guide/modules/ROOT/pages/rotating-signing-keys.adoc
  92. +19 −0 docs/ota-client-guide/modules/ROOT/pages/schema-migrations.adoc
  93. +11 −0 docs/ota-client-guide/modules/ROOT/pages/secure-software-updates-test.adoc
  94. +11 −0 docs/ota-client-guide/modules/ROOT/pages/secure-software-updates.adoc
  95. +39 −0 docs/ota-client-guide/modules/ROOT/pages/security.adoc
  96. +1 −0 docs/ota-client-guide/modules/ROOT/pages/simulate-device-basic.adoc
  97. +32 −0 docs/ota-client-guide/modules/ROOT/pages/simulate-device-cred-provtest.adoc
  98. +48 −0 docs/ota-client-guide/modules/ROOT/pages/software-management.adoc
  99. +29 −0 docs/ota-client-guide/modules/ROOT/pages/supported-boards.adoc
  100. +5 −0 docs/ota-client-guide/modules/ROOT/pages/supporting-technologies.adoc
  101. +87 −0 docs/ota-client-guide/modules/ROOT/pages/troubleshooting.adoc
  102. +14 −0 docs/ota-client-guide/modules/ROOT/pages/update-single-device.adoc
  103. +36 −0 docs/ota-client-guide/modules/ROOT/pages/update-your-client-configuration.adoc
  104. +117 −0 docs/ota-client-guide/modules/ROOT/pages/uptane-generator.adoc
  105. +59 −0 docs/ota-client-guide/modules/ROOT/pages/uptane.adoc
  106. +31 −0 docs/ota-client-guide/modules/ROOT/pages/use-your-own-deviceid.adoc
  107. +56 −0 docs/ota-client-guide/modules/ROOT/pages/useful-bitbake-commands.adoc
  108. +54 −0 docs/ota-client-guide/modules/ROOT/pages/workflow-overview.adoc
  109. +8 −0 docs/ota-client-guide/modules/ROOT/pages/yocto.adoc
  110. +106 −0 docs/ota-client-guide/modules/nav.adoc
  111. +0 −199 docs/posix-secondaries-bitbaking.adoc
  112. +1 −0 docs/posix-secondaries-bitbaking.adoc
  113. +0 −109 docs/posix-secondaries.adoc
  114. +1 −0 docs/posix-secondaries.adoc
  115. +0 −76 docs/provision-with-device-credentials.adoc
  116. +1 −0 docs/provision-with-device-credentials.adoc
  117. +0 −78 docs/provisioning-methods-and-credentialszip.adoc
  118. +1 −0 docs/provisioning-methods-and-credentialszip.adoc
  119. +0 −60 docs/rollback.adoc
  120. +1 −0 docs/rollback.adoc
  121. +0 −19 docs/schema-migrations.adoc
  122. +1 −0 docs/schema-migrations.adoc
  123. +0 −23 docs/security.adoc
  124. +1 −0 docs/security.adoc
  125. +0 −77 docs/selectively-triggering-aktualizr.adoc
  126. +1 −0 docs/selectively-triggering-aktualizr.adoc
  127. +0 −117 docs/uptane-generator.adoc
  128. +1 −0 docs/uptane-generator.adoc
  129. +11 −17 src/libaktualizr/package_manager/dockerappmanager.cc
  130. +3 −3 src/libaktualizr/package_manager/dockerappmanager.h
  131. +1 −2 src/libaktualizr/uptane/uptane_test.cc
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -45,3 +45,4 @@ __pycache__/

# QT Creator
CMakeLists.txt.user
/docs/ota-client-guide/modules/ROOT/pages/_junk
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
Original file line number Diff line number Diff line change
@@ -799,7 +799,6 @@ INPUT = @CMAKE_SOURCE_DIR@/docs \
@CMAKE_SOURCE_DIR@/tests \
@CMAKE_SOURCE_DIR@/src/aktualizr_info \
@CMAKE_SOURCE_DIR@/src/aktualizr_primary \
@CMAKE_SOURCE_DIR@/src/uptane_generator \
@CMAKE_SOURCE_DIR@/src/aktualizr_secondary \
@CMAKE_SOURCE_DIR@/src/cert_provider \
@CMAKE_SOURCE_DIR@/src/hmi_stub \
@@ -821,6 +820,7 @@ INPUT = @CMAKE_SOURCE_DIR@/docs \
@CMAKE_SOURCE_DIR@/src/libaktualizr/utilities \
@CMAKE_SOURCE_DIR@/src/load_tests \
@CMAKE_SOURCE_DIR@/src/sota_tools \
@CMAKE_SOURCE_DIR@/src/uptane-generator \
@CMAKE_SOURCE_DIR@/CONTRIBUTING.md \
@CMAKE_SOURCE_DIR@/CHANGELOG.md

18 changes: 0 additions & 18 deletions docs/INDEX.md

This file was deleted.

37 changes: 9 additions & 28 deletions docs/README.adoc
Original file line number Diff line number Diff line change
@@ -1,34 +1,15 @@
= Aktualizr reference docs
= OTA Connect Developer Guide

This directory contains developer-focused documentation on various specialized aktualizr topics.
This directory contains the source of our **OTA Connect Developer Guide** which is published to our https://docs.ota.here.com[documentation portal].

link:./client-provisioning-methods.adoc[client-provisioning-methods.adoc] - Describes how aktualizr handles provisioning with either shared credentials or device credentials.
You can also read the source files for this guide. To read this guide locally or in GitHub, start with the xref:ota-client-guide/modules/ROOT/nav.adoc[table of contents].

link:./configuration.adoc[configuration.adoc] - A reference for aktualizr's TOML config files.

link:./provisioning-methods-and-credentialszip.adoc[provisioning-methods-and-credentialszip.adoc] - An explanation of the format of credentials.zip, a bundle generated by HERE OTA Connect/OTA Community Edition containing necessary credentials and config for aktualizr and meta-updater.

link:./deb-package-install.adoc[deb-package-install.adoc] - The https://github.com/advancedtelematic/aktualizr/releases[releases] page includes a .deb package for aktualizr. This isn't likely useful for most production use cases, but it can be handy for testing. This document guides you through how to use the .deb.

link:./debugging-tips.adoc[debugging-tips.adoc] - Useful debugging info, mostly targeted at people contributing to the development of aktualizr.

link:./fault-injection.adoc[fault-injection.adoc] - How to inject faults during aktualizr runs, to help test failure cases of the system.

link:./provision-with-device-credentials.adoc[provision-with-device-credentials.adoc] - Provisioning with device credentials is a more secure way of provisioning devices. Unlike shared-credentials provisioning, each image is required to have some credentials side-loaded that are unique to the device which receives the image. This topic also explains of aktualizr's approach to using a hardware security module for provisioning with device credentials.

link:./integrate-libaktualizr.adoc[integrate-libaktualizr.adoc] - How to use Aktualizr as a library ('libaktualizr') to implement custom software update clients. This can be used to integrate Aktualizr with a user interface or to deliver updates to a custom package manager.

link:./linux-secondaries.adoc[linux-secondaries.adoc] - A quick how-to demonstrating aktualizr on a secondary ECU, using two QEMU devices.

link:./rollback.adoc[rollback.adoc] - Developer documentation on how aktualizr, OSTree, and u-boot can be used to implement automatic rollback of a failed update.

link:./schema-migrations.adoc[schema-migrations.adoc] - aktualizr uses a SQLite database for storing some config information and keys. This describes the steps needed for migrating the DB schema. Only useful for aktualizr developers.

link:./security.adoc[security.adoc] - A brief description of properties a system running aktualizr must have to conform with the Uptane security model.

link:./selectively-triggering-aktualizr.adoc[selectively-triggering-aktualizr.adoc] - Aktualizr normally runs as a service, polling for updates periodically. However, it can also be triggered externally--for example, in response to a shoulder-tap, or in response to user interaction on an HMI. This document describes how to do that.
[NOTE]
====
Content includes, such as code snippets or reused text snippets will not render correctly in Github.
====

== Developer documentation
== Reference documentation

Additional documentation intended for developers that may need to use the libaktualizr API should refer to link:https://advancedtelematic.github.io/aktualizr/index.html[this doc]:
[NOTE]
@@ -76,4 +57,4 @@ make doxygen
1. In the second repo, make a directory for the tag or commit you wish to add, i.e. `mkdir 2018.63`.
1. Copy the contents of `<build_dir>/docs/html` into the directory you just created. (Something like `cp -a <build_dir>/docs/html/* <second_repo>/2018.63`.)
1. In the second repo, run `git add 2018.63`, `git commit -as`, and `git push`.
1. Wait a minute or two for github to refresh and render the files.
1. Wait a minute or two for github to refresh and render the files.
39 changes: 0 additions & 39 deletions docs/client-provisioning-methods.adoc

This file was deleted.

1 change: 1 addition & 0 deletions docs/client-provisioning-methods.adoc
Loading