beskar7

README

Beskar7: Bare-Metal Provisioning for Kubernetes

A Kubernetes operator that implements the Cluster API infrastructure provider for bare-metal machines.

Simple, reliable approach: Redfish power management + iPXE network boot + Hardware inspection.

Why Beskar7?

• Simple - No complex vendor-specific workarounds
• Reliable - Only uses universally-supported Redfish features
• Vendor Agnostic - Works with any Redfish-compliant BMC
• Hardware Discovery - Collects real hardware specs via inspection
• Production Ready - Clean architecture, minimal dependencies

How It Works

1. Beskar7 claims a physical host
2. Sets PXE boot flag via Redfish
3. Powers on the server
4. Server network boots inspection image (iPXE)
5. Inspection image collects hardware details
6. Reports back to Beskar7
7. Validates hardware requirements
8. Kexecs into target OS
9. Machine joins cluster

Current Status

Version: v0.4.0-alpha
Status: Alpha - Under active development
Breaking Changes: v0.4.0 is NOT compatible with v0.3.x (see CHANGELOG)

Installation

Prerequisites

1. Kubernetes v1.31+ with kubectl configured
2. Cluster API v1.10+ (install with clusterctl)
3. cert-manager v1.16+ (installation guide)
4. iPXE infrastructure - DHCP + HTTP server (setup guide)
5. Inspection image - beskar7-inspector (repository)

Quick Install

Using Helm (Recommended):

helm repo add beskar7 https://projectbeskar.github.io/beskar7
helm repo update
helm install beskar7 beskar7/beskar7 --namespace beskar7-system --create-namespace

Using Release Manifests:

kubectl apply -f https://github.com/projectbeskar/beskar7/releases/download/v0.4.0-alpha/beskar7-manifests-v0.4.0-alpha.yaml

See Quick Start Guide for detailed installation instructions.

Basic Usage

1. Register a Physical Host

apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: PhysicalHost
metadata:
  name: server-01
spec:
  redfishConnection:
    address: "https://192.168.1.100"
    credentialsSecretRef: "bmc-credentials"

2. Create a Machine

apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: Beskar7Machine
metadata:
  name: worker-01
spec:
  inspectionImageURL: "http://boot-server/beskar7-inspector/boot"
  targetImageURL: "http://boot-server/kairos/v2.8.1.tar.gz"
  hardwareRequirements:
    minCPUCores: 4
    minMemoryGB: 16

Complete examples: See examples/ directory for full cluster configurations.

Architecture

Beskar7 consists of three main controllers:

• PhysicalHost Controller - Manages BMC connections and power state
• Beskar7Machine Controller - Orchestrates provisioning workflow
• Beskar7Cluster Controller - Manages cluster-level infrastructure

Detailed architecture: See docs/architecture.md

Hardware Compatibility

Works with any Redfish-compliant BMC. Tested with Dell, HPE, Lenovo, Supermicro, and generic BMCs.

Details: See docs/hardware-compatibility.md

Documentation

• Quick Start Guide - Step-by-step getting started
• iPXE Setup Guide - Infrastructure setup
• Architecture - Technical architecture details
• API Reference - Complete API documentation
• Examples - Working configuration examples
• Troubleshooting - Common issues and solutions
• Hardware Compatibility - Supported BMCs

Development

git clone https://github.com/projectbeskar/beskar7.git
cd beskar7
make build
make test

See docs/ci-cd-and-testing.md for complete development guide.

Contributing

Contributions are welcome! Please:

1. Open an issue to discuss major changes
2. Follow existing code style
3. Add tests for new features
4. Update documentation

License

Apache License 2.0 - See LICENSE file for details.

Support

• Issues: https://github.com/projectbeskar/beskar7/issues
• Discussions: https://github.com/projectbeskar/beskar7/discussions
• Documentation: https://github.com/projectbeskar/beskar7/tree/main/docs

Acknowledgments

This project was inspired by and learns from:

• Tinkerbell - Network boot provisioning
• Metal³ - Kubernetes bare-metal
• Cluster API - Kubernetes cluster lifecycle

---

Beskar7 - Simple, reliable bare-metal provisioning for immutable Kubernetes.