Skip to main content

Artifact

Tip

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.

Artifact types

When creating an artifact, DigiCert® Device Trust Manager provides options for selecting the appropriate type of update. Each update type is designed for specific tasks and ensures that the correct modifications are applied to the target devices.

Table 1. Artifact update types

Update type

Description

Example update

Application update

Targets the application layer, such as individual software components or packages, without affecting the entire system.

Containers, packages (.deb), files, directories

Device configuration

Changes settings or parameters that control how a device operates or to adapt to new requirements. These modifications do not alter the core software of the device.

Network credentials, language preference, time zone, security settings


Artifact payload

The artifact payload refers to the content being delivered to the device. This can vary based on the nature of the update, such as:

  • Software packages or binaries

  • Configuration files

  • System images

  • Scripts

Note

The payload is what gets applied to the device during the update process.

Artifact manifest

When creating an artifact, Device Trust Manager automatically generates a manifest based on the inputs provided. This manifest contains metadata and other critical information to ensure that the artifact is properly applied to the right devices.

Table 2. Manifest contents

Manifest element

Description

Manifest version

Version of the manifest format used.

Artifact name

Name of the artifact.

Artifact version

Version of the artifact itself.

Artifact description

A description of what the artifact does.

Update type

Specifies the type of update (application or device configuration).

Handling actions

Defines actions such as Pre-install, Install, Post-install, or Rollback.

Matching device attributes

Lists attributes required for the device to apply the update (e.g., firmware version, OS platform).

Provides and DependsOn

Specifies the dependencies or requirements for the artifact and other artifacts it may depend on.

Checksum or signature

A SHA-256 checksum or signature used to verify the integrity of the artifact.


Artifact handling

Handling scripts are an essential part of an artifact, ensuring updates are rolled out in a controlled manner. They allow for processes such as atomic updates (where an update is only considered successful if every part of it is completed) and rollback capabilities (which revert a device to its previous state if an update fails). This ensures the stability and security of the devices during the deployment process.