Skip to content

updates.md

Latest commit

 

History

History
74 lines (50 loc) · 2.02 KB

updates.md

File metadata and controls

74 lines (50 loc) · 2.02 KB

Updates

Producing and Serving Update Content

The update server uses a specific file hierarchy for serving update content:

 <datadir>/updates/
                   <ci or prod>/
                                <device tag>/
                                             <update>

The contents of the update directory above are the exact contents of what fioctl targets offline-update produces. Let's say we want to deploy a CI build to some devices connected to our server. The Target is tagged with main and is named intel-corei7-64-lmp-148. The content can be staged on the server by running:

  cd <datadir>
  mkdir -p updates/ci/main/148
  fioctl targets offline-update --expires-in-days 180 --tag main intel-corei7-64-lmp-148 ./updates/ci/main/148

This update will now show up under the "updates" view in your UI.

Updating Your Devices

With an update in place, you will need to create a "rollout" for your device(s) to see it. This can be done via API, CLI, or Web UI.

API

Create a rollout named "first-try"

  curl \
    -H 'Authorization: Bearer <your token>' \
    -H 'Content-type: application/json' \
    -X PUT \
    -d '{"uuids": ["uuid1", "uuid2",...]}' \
    http://<your server>/v1/updates/ci/main/148/rollouts/first-try

CLI

Use the fiocli updates create-rollout command.

Web

Scroll down to the specific update and click "Create rollout".

Tracking the Progress of an Update/Rollout

You can track the progress of an update through the API, CLI, or Web.

Tracking via API

There are two API resources for tailing updates. Both resources emit Server Sent Events.

  • rollout – /v1/updates/<ci|prod>/<tag>/<update>/rollouts/<rollout>/tail
  • the whole update — /v1/updates/<ci|prod>/<tag>/<update>/tail

Tracking via CLI

The CLI has an updates tail subcommand that allows you to tail the update or a specific rollout.

Tracking via Web

Click "Follow progress" on either the Update or Rollout to see details.