Skip to content

Commit

Permalink
README: update diagram, cheatsheet
Browse files Browse the repository at this point in the history
  • Loading branch information
joelrebel committed May 4, 2023
1 parent 0a716ce commit af4e32d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 26 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ flasher currently supports is Out of band component firmware installs, that is -

As of this release flasher depends on serverservice for the inventory and firmware information.

<p align="left">
<img height="500px" width="450px" src="./docs/flasher-min.png">
</p>
```mermaid
graph TB
a((Flasher))-- 1. Query Asset BMC creds, attributes -->ss[(Serverservice)]
a((Flasher))-- 2. Query current inventory -->sb(ServerA BMC)
a((Flasher))-- 3. Fetch firmware files -->sa(Firmware file store)
a((Flasher))-- 4. install firmware -->sb(ServerA BMC)
```


## build
Expand All @@ -21,7 +25,7 @@ see [cheatsheet.md](./docs/cheatsheet.md)

## Documentation

Documentation on development and flasher implementation can be found in [docs](./docs/README-devel.md)
Documentation on development and flasher implementation can be found in [docs](./docs/README-devel.md)

## Supported devices

Expand Down
23 changes: 1 addition & 22 deletions docs/cheatsheet.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,6 @@
# get flasher task attribute for device

```
flasher get task --device-id f0c8e4ac-5cce-4370-93ff-bd3196fd3b9e \
--config ./samples/flasher-client.yaml
```

# set device for firmware install - force to skip installed component version checks.
```
flasher set install-firmware --device-id fa1e8306-b8a6-425b-8f84-fb747d73d399 \
--inventory-source=serverservice \
--config ./samples/flasher-client.yaml \
--force
```

# delete firmware install task for device
```
flasher delete task --device-id f0c8e4ac-5cce-4370-93ff-bd3196fd3b9e \
--config ./samples/flasher-client.yaml
```

# run worker
```
flasher run worker --inventory-source=serverservice \
flasher run worker --store=serverservice \
--config ./samples/flasher-worker.yaml \
--trace
```
Expand Down
Binary file removed docs/flasher-min.png
Binary file not shown.

0 comments on commit af4e32d

Please sign in to comment.