Concepts

This section provides an overview of the key concepts in the Metal Operator API, detailing the primary resources and their relationships. Each concept is linked to its respective documentation for further reading.

• Endpoint: Represents devices on the out-of-band management network, identified by MAC and IP addresses.
• BMC: Models Baseboard Management Controllers (BMCs), allowing interaction with server hardware.
• BMCSecret: Securely stores credentials required to access BMCs.
• Server: Represents physical servers, managing their state, power, and configurations.
• ServerClaim: Allows users to reserve servers by specifying desired configurations and boot images.
• ServerBootConfiguration: Signals the need to prepare the boot environment for a server.
• ServerMaintenance: Represents maintenance tasks for servers, such as BIOS updates or hardware repairs.
• BIOSSettings: Handles updating the BIOS setting on the physical server's BIOS.
• BIOSSettingsSet: Handles creation of multiple BIOSSettings by selecting physical server's through labels.
• BIOSVersion: Handles upgrading the BIOS Version on the physical server's BIOS.
• BIOSVersionSet: Handles creation of multiple BIOSVersion by selecting physical server's through labels.
• BMCSettings: Handles updating the BMC setting on the physical server's Manager.
• BMCSettingsSet: Handles creation of multiple BMCSettings by selecting BMCs through labels.
• BMCVersion: Handles upgrading the BMC Version on the physical server's Manager.
• BMCVersionSet: Handles creation of multiple BMCVersion by selecting BMC's through labels.