| Tim Windelschmidt | 6d33a43 | 2025-02-04 14:34:25 +0100 | [diff] [blame^] | 1 | // Copyright The Monogon Project Authors. |
| 2 | // SPDX-License-Identifier: Apache-2.0 |
| 3 | |
| Serge Bazanski | caa1208 | 2023-02-16 14:54:04 +0100 | [diff] [blame] | 4 | // Package manager, itself a part of BMaaS project, provides implementation |
| 5 | // governing Equinix bare metal server lifecycle according to conditions set by |
| 6 | // Bare Metal Database (BMDB). |
| 7 | // |
| 8 | // The implementation will attempt to provide as many machines as possible and |
| 9 | // register them with BMDB. This is limited by the count of Hardware |
| 10 | // Reservations available in the Equinix Metal project used. The BMaaS agent |
| 11 | // will then be started on these machines as soon as they become ready. |
| 12 | // |
| 13 | // The implementation is provided in the form of a library, to which interface is |
| 14 | // exported through Provisioner and Initializer types, each taking servers |
| 15 | // through a single stage of their lifecycle. |
| 16 | // |
| 17 | // See the included test code for usage examples. |
| 18 | // |
| 19 | // The terms "device" and "machine" are used interchangeably throughout this |
| 20 | // package due to differences in Equinix Metal and BMDB nomenclature. |
| 21 | package manager |