..
 # SPDX-FileCopyrightText: Copyright (c) 2025, Linaro Limited.
 #
 # SPDX-License-Identifier: MIT

.. _mender_capsule_update_label:

*********************
Mender Capsule Update
*********************

Once the Mender server is running and the Device Under Test
(DUT) is provisioned, the next step is to deliver your
update payloads to the server for performing capsule update on DUT

  .. note::
    There is only mender capsule fetch test performed as
    a proof of concept, there is no firmware update.

Requirements:

  * :ref:`Mender artifact <build_with_mender_support_label>`
  * :ref:`Artifacts are uploaded <artifact_upload_label>`
  * :ref:`Running Mender server <setup_mender_server_label>`
  * :ref:`Device Under Test (DUT) is provisioned <dut_provisioning_label>`
  * :ref:`Copy artifact key on DUT <copy_artifact_key_label>`

This section covers two different scenarios.

 * Compatible capsule for secure deployment.
 * Incompatible capsule to demonstrate failure deployment.

* **Update module**

  Copy the update module to perform an update on DUT. The module defines set of
  actions to be performed.

  .. code-block:: console

    scp -o "StrictHostKeyChecking no" ${HOST_MACHINE_USER}@${MENDER_SERVER_IP}:${MENDER_SERVER_DIR}/mender-capsule-fetch ${MENDER_DUT_TEST_DIR}

  Install the update module to perform set of actions when mender capsule is received from mender server.

  .. code-block:: console

    cp ${MENDER_DUT_TEST_DIR}/mender-capsule-fetch /usr/share/mender/modules/v3/
    chmod +x /usr/share/mender/modules/v3/mender-capsule-fetch

* **Deploying Updates** :

  To trigger an **compatible capsule update**, we deploy a compatible-capsule-fetch.

  .. code-block:: console

    create_artifact_deployment "compatible-capsule-fetch"
    check_for_capsule_fetch "compatible-capsule-fetch"

  Expected outcome:

    * The mender capsule passes signature validation.
    * The DUT downloads by checking the compatibility.
    * The DUT uses the update module to perform necessary actions.

  To trigger a **incompatible capsule update**, we deploy a incompatible-capsule-fetch.

  .. code-block:: console

    create_artifact_deployment "incompatible-capsule-fetch"
    check_for_capsule_fetch "incompatible-capsule-fetch"

  Expected outcome:

    * The mender capsule passes signature validation.
    * The DUT rejects the capsule due to incompatibility.