Skip to content

Commit

Permalink
Revert changes introduced for republishing v94
Browse files Browse the repository at this point in the history
Changes made to enable the republishing of v94 have been reverted back;
this path was considered easier than dealing with more complex git
usage.

Built HTML, ran linkcheck and linter.

This commit addresses FFTK-3544, "Re-release v94 docs…"

Signed-off-by: Katrina Prosise <[email protected]>
  • Loading branch information
kprosise committed Nov 11, 2024
1 parent 5fb5f08 commit 3aa4f76
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions source/user-guide/custom-sota-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is not always the desired operation. There are a couple ways to control thi

#. Callbacks
#. Custom Update Agent
#. Command Line Interface - CLI (Aktualizr-lite Manual Mode) **Available in future release, v95**
#. Command Line Interface - CLI (Aktualizr-lite Manual Mode)

Callbacks
---------
Expand Down Expand Up @@ -56,7 +56,7 @@ Later, this can serve as an example to copy/paste into a Factory specific recipe
https://github.com/foundriesio/meta-lmp/tree/main/meta-lmp-base/recipes-sota/custom-sota-client

.. _SOTA client:
https://github.com/foundriesio/aktualizr-lite/tree/v94/examples/custom-client-cxx
https://github.com/foundriesio/sotactl

Users can build this custom client into their LmP image with a small addition to ``meta-subscriber-overrides.git``:

Expand All @@ -72,15 +72,12 @@ Forking the Custom SOTA Client
Producing a factory-specific SOTA client can be done by:

#. Creating a Git repository for your custom code.
Copying the `examples/custom-client-cxx`_ directory is a good place to start.
Cloning the `sotactl`_ repository and adding your repository as the remote is a good place to start.

#. Copying the `custom-sota-client`_ recipe from ``meta-lmp`` into ``meta-subscriber-overrides/recipes-sota``.

#. Changing the ``custom-sota-client_git.bb`` Git references (``SRC_URI``, ``BRANCH``, ``SRCREV``) to point at your new sources.

.. _examples/custom-client-cxx:
https://github.com/foundriesio/aktualizr-lite/tree/v94/examples/custom-client-cxx

.. _sotactl:
https://github.com/foundriesio/sotactl

Expand All @@ -89,12 +86,13 @@ Producing a factory-specific SOTA client can be done by:

Custom SOTA Client Work Modes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default, the example `SOTA client`_ works as a daemon updating a device to the latest version once it becomes available.
In addition to the default daemon mode, users can run it as a CLI utility and perform specific steps of the update process separately.

.. prompt:: bash

/build-custom/custom-sota-client --help
sotactl --help
Usage:
sotactl [cmd] [options]
Supported commands: check install run pull daemon
Expand All @@ -109,10 +107,6 @@ In addition to the default daemon mode, users can run it as a CLI utility and pe
Command Line Interface - CLI (Aktualizr-lite Manual Mode)
---------------------------------------------------------

.. attention::
The Aktualizr-lite CLI feature will be available for v95.
The content below is a preview.

The ``aktualizr-lite`` executable can be invoked to perform individual operations allowing more control over the update flow.

.. warning:: The Command Line Interface is in beta stage,
Expand Down

0 comments on commit 3aa4f76

Please sign in to comment.