Skip to content

Add BM CAPI documentation #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
afritzler merged 1 commit into from
Jun 30, 2025
Merged

Add BM CAPI documentation #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/baremetal/kubernetes/capi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# Cluster API (CAPI) for IronCore Bare Metal

The Cluster API (CAPI) for IronCore bare metal is a project that provides a declarative way to manage bare metal
Kubernetes clusters using the Cluster API framework. It maps the CAPI concepts to the IronCore's `metal-operator`
API types.

The diagram below illustrates the architecture of the Cluster API for IronCore bare metal:

```mermaid
graph TB
subgraph "cluster.x-k8s.io/v1beta1"
direction TB
CAPI_Cluster[Cluster]
CAPI_MachineDeployment[MachineDeployment]
CAPI_Machine[Machine]
end

subgraph "infrastructure.cluster.x-k8s.io/v1beta1"
direction TB
Metal_Machine[MetalMachine]
end

subgraph "metal.ironcore.dev/v1alpha1"
direction TB
MetalOperator_ServerClaim[ServerClaim]
MetalOperator_Server[Server]
end

CAPI_Cluster -->|creates| CAPI_MachineDeployment
CAPI_MachineDeployment -->|creates| CAPI_Machine
CAPI_Machine -->|creates| Metal_Machine
Metal_Machine -->|creates| MetalOperator_ServerClaim
MetalOperator_ServerClaim -->|provisions| MetalOperator_Server
```
7 changes: 7 additions & 0 deletions docs/baremetal/kubernetes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ integration points of handling the `Node` lifecycle and topology information.

Load balancing for `Services` of type `LoadBalancer` is done by the [metal-load-balancer-controller](/baremetal/kubernetes/metal-loadbalancer-controller).

## Cluster API Provider

The [Cluster API Provider for Bare Metal](https://github.com/ironcore-dev/cluster-api-provider-ironcore-metal) is
a Kubernetes project that provides a declarative way to manage bare metal clusters using the Cluster API (CAPI) framework.

More details on the Cluster API provider for bare metal can be found in the [Cluster API Provider](/baremetal/kubernetes/capi) section.

## Gardener Integration

IronCore is also integrated with [Gardener](https://gardener.cloud/), a Kubernetes-native project for managing Kubernetes clusters at scale.
Expand Down
Loading