blob: 3ae7854e119acb11d600a981956b8a852898d82b [file] [log] [blame]
Serge Bazanskicaa12082023-02-16 14:54:04 +01001// Package manager, itself a part of BMaaS project, provides implementation
2// governing Equinix bare metal server lifecycle according to conditions set by
3// Bare Metal Database (BMDB).
4//
5// The implementation will attempt to provide as many machines as possible and
6// register them with BMDB. This is limited by the count of Hardware
7// Reservations available in the Equinix Metal project used. The BMaaS agent
8// will then be started on these machines as soon as they become ready.
9//
10// The implementation is provided in the form of a library, to which interface is
11// exported through Provisioner and Initializer types, each taking servers
12// through a single stage of their lifecycle.
13//
14// See the included test code for usage examples.
15//
16// The terms "device" and "machine" are used interchangeably throughout this
17// package due to differences in Equinix Metal and BMDB nomenclature.
18package manager