Skip to content

Commit 7d37681

Browse files
authored
Add BM CAPI documentation (#83)
1 parent ccdef27 commit 7d37681

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/baremetal/kubernetes/capi.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
11
# Cluster API (CAPI) for IronCore Bare Metal
2+
3+
The Cluster API (CAPI) for IronCore bare metal is a project that provides a declarative way to manage bare metal
4+
Kubernetes clusters using the Cluster API framework. It maps the CAPI concepts to the IronCore's `metal-operator`
5+
API types.
6+
7+
The diagram below illustrates the architecture of the Cluster API for IronCore bare metal:
8+
9+
```mermaid
10+
graph TB
11+
subgraph "cluster.x-k8s.io/v1beta1"
12+
direction TB
13+
CAPI_Cluster[Cluster]
14+
CAPI_MachineDeployment[MachineDeployment]
15+
CAPI_Machine[Machine]
16+
end
17+
18+
subgraph "infrastructure.cluster.x-k8s.io/v1beta1"
19+
direction TB
20+
Metal_Machine[MetalMachine]
21+
end
22+
23+
subgraph "metal.ironcore.dev/v1alpha1"
24+
direction TB
25+
MetalOperator_ServerClaim[ServerClaim]
26+
MetalOperator_Server[Server]
27+
end
28+
29+
CAPI_Cluster -->|creates| CAPI_MachineDeployment
30+
CAPI_MachineDeployment -->|creates| CAPI_Machine
31+
CAPI_Machine -->|creates| Metal_Machine
32+
Metal_Machine -->|creates| MetalOperator_ServerClaim
33+
MetalOperator_ServerClaim -->|provisions| MetalOperator_Server
34+
```

docs/baremetal/kubernetes/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ integration points of handling the `Node` lifecycle and topology information.
2424

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

27+
## Cluster API Provider
28+
29+
The [Cluster API Provider for Bare Metal](https://github.com/ironcore-dev/cluster-api-provider-ironcore-metal) is
30+
a Kubernetes project that provides a declarative way to manage bare metal clusters using the Cluster API (CAPI) framework.
31+
32+
More details on the Cluster API provider for bare metal can be found in the [Cluster API Provider](/baremetal/kubernetes/capi) section.
33+
2734
## Gardener Integration
2835

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

0 commit comments

Comments
 (0)