Skip to content

Commit

Permalink
Use 'fleet roll-out' (#396)
Browse files Browse the repository at this point in the history
* Use 'fleet roll-out'

* Apply suggestions from code review

Co-authored-by: Florian Loitsch <[email protected]>

---------

Co-authored-by: Florian Loitsch <[email protected]>
  • Loading branch information
Kasper Lund and floitsch authored May 25, 2023
1 parent 12a4eac commit 7d5e9f2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/getstarted/fleet/groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ artemis serial flash --port /dev/ttyUSB0 --group office

From this point forward, the device knows which group it belongs to
so if the pod of its group is changed, Artemis will push an update
to the device when requested to update the fleet:
to the device when requested to roll out the changes to the fleet:

``` sh
artemis fleet update
artemis fleet roll-out
```

<Note>
Expand Down Expand Up @@ -87,10 +87,10 @@ artemis fleet group update --tag v1.0.4 office solar-farm-fr-nce
Once you've updated the pod references in your groups, you can use:

``` sh
artemis fleet update
artemis fleet roll-out
```

to deploy the changes to your devices.
to roll out the changes to your devices.

## Renaming and merging groups

Expand Down
20 changes: 12 additions & 8 deletions docs/getstarted/fleet/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -351,25 +351,29 @@ You can specify which device to update using a device-id flag (`-d`), but most
of the time you just use the default ID that was either set
during flashing, or that can be set with `artemis device default`.

## Updating the entire fleet
## Rolling out changes to a fleet

If you've modified the `my-pod.json` file and you want your
entire fleet of devices to update to reflect the changes, you can
run:
If you've modified the `my-pod.json` file and you want to make the changes available
to your fleet of devices, you can upload the latest version of your pod using:

``` sh
artemis pod upload my-pod.json
```

If your `fleet.json` uses `my-pod@latest`, you can ask the fleet
to update using:
to roll out the changes to your devices using:

``` sh
artemis fleet update
artemis fleet roll-out
```

If you changed the pod reference in `fleet.json` to use a stable tag, then
you need to update that before you run `artemis fleet update`. Because your
pods encapsulate the fully configured firmware, this makes
you need to update that before you run `artemis fleet roll-out`:

``` sh
artemis fleet group update --tag v1.0.3
```

Because your pods encapsulate the fully configured firmware, this makes
it easy to upgrade your containers, the Artemis service, and even the Toit SDK
and its associated virtual machine.

0 comments on commit 7d5e9f2

Please sign in to comment.