agent

README

 _______   _______   _______   __    _   _______ 
|   _   | |       | |       | |  |  | | |       |
|  |_|  | |    ___| |    ___| |   |_| | |_     _|
|       | |   | __  |   |___  |       |   |   |  
|       | |   ||  | |    ___| |  _    |   |   |  
|   _   | |   |_| | |   |___  | | |   |   |   |  
|__| |__| |_______| |_______| |_|  |__|   |___|  

Agent - server fleet automation service

Agent is a vendor agnostic service, cli to automate bare metal server actions across a server fleet.

Agent is currently supports installing firmware Out of band - through the host BMC, and expects the host BMC to be reachable to install firmware.

If the given server is powered off, it will be powered on, the firmware will be install and powered off after.

When a firmware requires the server to be power cycled, agent will perform the power cycle action and poll until the firmware install is completed.

Build

make build-linux

Run

Agent can be run in the service mode or to one-shot cli install a given firmware file.

Note: it expects to be able to reach the BMC interface for the given server.

service command

In the worker mode agent worker, agent depends on NATS to accept work, a secret store for BMC secrets, a firmware file store for firmware files to install.

Check out the sandbox for steps to have it running along with its dependencies.

The sandbox README.md includes instructions to register a server, create firmware sets and install them on a server.

The diagram below depicts the services agent depends on:

graph TB
  a((Agent))-- 1. Query Asset BMC creds, attributes -->ss[(FleetDBAPI)]
  a((Agent))-- 2. Query current inventory -->sb(ServerA BMC)
  a((Agent))-- 3. Fetch firmware files -->sa(Firmware file store)
  a((Agent))-- 4. install firmware -->sb(ServerA BMC)

install command

The agent install command will install the given firmware file on a server, and poll until the install is complete.

agent install --addr 192.168.1.1 \
                --user ADMIN \
                --pass hunder2 \
                --version 3.6 \
                --component bios \
                --vendor supermicro \
                --model x11dph-t \
                --force \
                --file /tmp/BIOS_X11DPH-0981_20220208_3.6_STD.bin \
                --dry-run  \

see cheatsheet.md

Supported devices

For out of band updates, Agent leverages bmclib and so supports firmware installs on devices that are supported by the library.

As of this writing, it supports Dell PowerEdge, Supermicro X11, X12, Asrockrack updates through their BMC.

Documentation

Documentation on development and agent implementation can be found in docs

Documentation

Overview

Copyright 2024 Metal Automata Authors https://github.com/metal-automata

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.