Binaries
Binaries record the content you wish to distribute to devices.
Once you've created an artifact version, you can create binaries for it.
For field-level information and requirements, see the Admin API's create-a-binary endpoint.
Content Versus Record
When referring to binaries there are two distinct concepts: a binary's content and a binary's record.
A binary's record is the meta information Peridio stores regarding a binary, e.g., its description, what artifact version it is associated with, its hash, etc. A binary's content is the literal data, e.g., a firmware image, a machine learning model, etc.
This distinction is important because a binary's content and record are stored independently from each other for a variety of reasons including the efficient distribution of content to devices and the efficient queryability of records. It is especially relevant to destroyed binaries.
Targets and Compatibility
Binaries may indicate their intended compatibility via their target field. The value of this field is expected to be a target triplet like arm-linux-androidabi.
An artifact version can have zero to many binaries associated with it as long as each binary has a unique target.
Destroyed binaries do not count towards this conflict.
Lifecycle
A binary's lifecycle is tracked and managed by its state field.
States
A binary's possible states include:
- Uploadable
- Hashable
- Hashing
- Signable
- Signed
- Destroyed
Uploadable
The initial state that every binary is created in. The binary is awaiting data to be uploaded via binary parts.
If the binary storage backend has an initial step, like is typical in multipart upload scenarios, it is performed as part of this step.
When you create a binary in the web console, it will be in the uploadable state. Note that successful upload of a file via the web console will automatically transition the binary to the hashing state which will eventually automatically transition to the signable state.
Hashable
Use this state to indicate you have completed your upload.
If the binary storage backend has a final step, like is typical in multipart upload scenarios, it is performed as part of this state transition.
Hashing
Use this state to kickoff Peridio's own verification process that computes its own hash over the data and verifies it matches the user provided hash and the hash reported
Once Peridio's verification process completes, the binary will automatically transition states from hashing to signable.
Signable
This state indicates the binary as awaiting a signature.
Once a signature is attached to a signable binary, the binary will automatically transition states from signable to signed.
Signed
The binary is complete and ready to be attached to bundles and distributed via releases.
Destroyed
The binary has been destroyed and can no longer be attached to new bundles nor distributed via releases. See destroyed binaries.
Resetting Binaries
Hashable, hashing, and signable binaries can be reset to the uploadable state. This is achieved with an Admin API update-a-binary request that sets the state to uploadable. Doing this will delete associated binary parts and a new attempt at uploading may be made.
Destroyed Binaries
Binaries with a state of signed can be destroyed. Destroying a binary deletes its content from Peridio and alters its record, to understand the difference between the two see content versus record.
Destroying a binary is an irreversible and destructive action.
- The binary's record is updated such that
destroyed: true, bytes_uploaded: 0. - The binary's content is irrecoverably deleted.
- Devices' ability to update may be interupted, see impact on releases.
Impact on Releases
A release is affected by a destroyed binary if the release is associated with a bundle that is associated with an artifact version that is associated with a destroyed binary.
Affected releases will not serve updates to devices which can cause devices to be be unable to update if the release is also required.
To avoid disrupting device updates, it is recommended to archive any release that would be impacted before destroying the binary. You can see a list of releases associated with a binary most conveniently by viewing the binary in the Peridio Web Console.