Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.8 KB

README-development.md

File metadata and controls

73 lines (51 loc) · 2.8 KB
Raw

Alloy software components

Check out the sandbox repository to run Alloy along with fleetdbapi.

Alloy is internally composed of two main components the Collector and the Controller, the store is a backend repository of inventory assets.

Collector

The Collector listens for devices on the asset channel (from the asset iterator), and proceeds to collect inventory, bios configuration for the devices received.

Controller

TODO: explain controller bits, the asset iterator is split out as the Alloy scheduler.

In band collection

In band inventory is collected when alloy is invoked with the inband command, this calls into the ironlib library which abstracts the hardware/vendor specific data collection through a host OS.

graph TD
  a((Alloy))-- 1. Lookup asset -->ss[(Store)]
  a((Alloy))-- 3. store/update data -->ss[(Store)]
  a((Alloy))-- 2. collect through host OS utils -->s(Server host OS)
Loading
Out of band collection

Out of band inventory is collected when Alloy is invoked with the out of band command, which calls into the bmclib library, which abstracts hardware/vendor specific data collection remotely through the BMC.

graph TD
  a((Alloy))-- 1. read BMC creds -->ss[(Store)]
  a((Alloy))-- 3. store/update data -->ss[(Store)]
  a((Alloy))-- 2. collect data -->sa(ServerA BMC)
  a((Alloy))-- 2. collect data -->sb(ServerB BMC)
Loading

Debugging/fixture dump environment variables

Set DEBUG_DUMP_FIXTURES=true to have fixture data for fixtures/device.go, fixtures/serverservice_components.* dumped, the objects are dumped to files in the current directory,

fc167440-18d3-4455-b5ee-1c8e347b3f36.device.fixture             # the device object returned from ironlib/bmclib
fc167440-18d3-4455-b5ee-1c8e347b3f36.current.components.fixture # the current component data from server service
fc167440-18d3-4455-b5ee-1c8e347b3f36.new.components.fixture     # the newer component data based on the device object from ironlib/bmclib

Set DEBUG_DUMP_DIFFERS=true to have object differ changelogs from the publish.CreateUpdateServerComponents() method dumped.

Signed commits

The Alloy repository requires signed commits which are attested via sigstore. To enable that on your development machine, you need to install gitsign and enable commit signing with it for this repository:

cd /path/to/this/repository
git config --local commit.gpgsign true  # Sign all commits
git config --local tag.gpgsign true  # Sign all tags
git config --local gpg.x509.program gitsign  # Use gitsign for signing
git config --local gpg.format x509  # gitsign expects x509 args