Artifact manager guide

To perform this action, you must have a user role that contains the Artifact manager permission.

Artifact Managers are typically firmware developers or software engineers who create and upload device update packages. They handle the software artifacts that are deployed to devices, making this role essential for maintaining and updating device functionality.

An artifact is a package that contains everything required to deploy and update to a device and can include software, firmware, metadata, and handling scripts. These scripts ensure that updates are deployed reliably across a fleet of devices, supporting features such as atomic updates and rollback capabilities to maintain device stability and security.

Suggerimento

Artifacts can be assigned to a specific division or made available at an account-wide level, providing flexibility in how updates are managed and deployed across different organizational structures.

Artifacts are created by developers and then combined into a release, which is used for deployments to specific device groups. Each artifact includes both the payload (the actual content of the update) and a manifest, which contains metadata about the artifact.

To learn more about artifacts, payloads, and manifests, see Artifact.

Create an artifact

Suggerimento

You can save your progress when creating an artifact and return to it later. Selecting Save draft and close lists the artifact in the Draft artifacts tab on the Artifacts page.

In the Device Trust Manager menu, go to Software updates > Artifacts.
Select Create Artifact.
On the General information step:
1. Enter an Artifact name and, optionally, a description.
2. Select the Division that can access and use this artifact.
3. Enter an Artifact version.
4. Select an Artifact type.
5. If this artifact depends on another, choose the artifact's dependency.
6. Select Next.
On the Artifact definition step:
1. Upload the artifact payload zip file.
2. Under Artifact handling, you can configure how TrustEdge agent will manage the artifact on the device. You can specify handling instructions for various deployment phases, each with detailed configuration options:
  - Install: Define the file to be executed for the installation phase, specify the file type or path, select a sub-type, and include any optional arguments to customize the process.
  - Pre-install: Set the file that will run before the installation starts, choose the file type, determine the sub-type, and provide any required arguments to prepare the device or environment.
  - Post-install: Configure the file that executes after the installation completes, specify the file type and sub-type, and add any arguments needed for post-installation tasks, such as cleanup or verification.
  - Rollback: Specify the file to handle the rollback process in case of installation failure, select the file type, define the sub-type, and provide arguments to revert the device to its prior state.
3. Optionally, select Add attribute to specify Target device attributes as key/value pairs. These attributes ensure the update is deployed only to devices with matching attributes.
4. Select Create artifact. The newly created artifact displays in the Artifacts table.

Disable and enable an artifact

Avvertimento

When you disable an artifact, you automatically disable its associated releases and abort any scheduled or active deployments. Ensure there are no active deployments on the associated releases and that no other enabled artifact depends on it before disabling.

Disable an artifact

In the Device Trust Manager menu, go to Software updates > Artifacts.
Select an Artifact to disable.
Click More actions > Disable.

Enable an artifact

In the Device Trust Manager menu, go to Software updates > Artifacts.
Select a Disabled artifact.
Click More actions > Enable.

In questa sezione: