Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare docs for re-publishing of v94 #766

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Prepare docs for re-publishing of v94 #766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions source/user-guide/custom-sota-client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

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

Check warning on line 14 in source/user-guide/custom-sota-client.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.em-dash] Did you mean to you use an em dash '—'?

Raw Output:
{"message": "[Fio-docs.em-dash] Did you mean to you use an em dash '—'?", "location": {"path": "source/user-guide/custom-sota-client.rst", "range": {"start": {"line": 14, "column": 26}}}, "severity": "WARNING"}

Callbacks
---------
Expand Down Expand Up @@ -56,7 +56,7 @@
https://github.com/foundriesio/meta-lmp/tree/main/meta-lmp-base/recipes-sota/custom-sota-client

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

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

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

#. Creating a Git repository for your custom code.
Cloning the `sotactl`_ repository and adding your repository as the remote is a good place to start.
Copying the `examples/custom-client-cxx`_ directory 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 @@ -91,7 +94,7 @@

.. prompt:: bash

sotactl --help
/build-custom/custom-sota-client --help
Usage:
sotactl [cmd] [options]
Supported commands: check install run pull daemon
Expand All @@ -106,10 +109,14 @@
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,
and is subject to change over the next releases.
and is subject to change over the following releases.

.. note:: In order to use the run individual `aktualizr-lite` commands,
the ``aktualizr-lite`` service needs to be stopped with ``sudo systemctl stop aktualizr-lite``
Expand Down
Loading