Skip to content

Commit b25e951

Browse files
committed
Update terminology and overview pages
1 parent c4c3af3 commit b25e951

8 files changed

Lines changed: 62 additions & 37 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default withMermaid({
2727
{text: 'Documentation',
2828
items: [
2929
{text: 'Infrastructure as a Service', link: '/iaas/getting-started'},
30-
{text: 'Bare Metal Automation', link: '/baremetal/'},
30+
{text: 'Bare Metal Management', link: '/baremetal/'},
3131
{text: 'Network Automation', link: '/network-automation/'},
3232
]},
3333
],
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API References
22

3-
This section provides detailed API reference documentation for the IronCore Bare Metal Automation components.
3+
This section provides detailed API reference documentation for the IronCore Bare Metal Management components.
44

5-
* [**metal-operator**](/baremetal/api-references/metal-operator): The core bare metal automation component that manages the lifecycle of bare metal servers.
5+
* [**metal-operator**](/baremetal/api-references/metal-operator): The core bare metal management component that manages the lifecycle of bare metal servers.
66
* [**boot-operator**](/baremetal/api-references/boot-operator): Responsible for providing boot images and Ignition configurations to bare metal servers.

docs/baremetal/architecture/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Overview
22

3-
The bare metal automation architecture is described in the diagram below. It consists of two main concepts: out-of-band
3+
The bare metal management architecture is described in the diagram below. It consists of two main concepts: out-of-band
44
server management and in-band server boot automation.
55

6-
![Bare Metal Automation Architecture](/metal-automation-overview.png)
6+
![Bare Metal Management Architecture](/metal-management-overview.png)
77

88
## Out-of-Band Automation
99

docs/baremetal/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Baremetal Automation
1+
# Bare Metal Management
22

3-
The bare metal automation in IronCore is designed to provide a comprehensive solution for managing physical servers
3+
The bare metal management and automation in IronCore is designed to provide a comprehensive solution for managing physical servers
44
in a Kubernetes-native way. It leverages the power of Kubernetes Custom Resource Definitions (CRDs) to automate:
55

66
- **Discovery**: Automatically detect and register bare metal servers.
@@ -11,7 +11,7 @@ in a Kubernetes-native way. It leverages the power of Kubernetes Custom Resource
1111

1212
## Core Components
1313

14-
The core components of the bare metal automation in IronCore include:
14+
The core components of the bare metal management in IronCore include:
1515
- [**Metal Operator**](https://github.com/ironcore-dev/metal-operator): The central component that manages the lifecycle of bare metal servers.
1616
- [**Boot Operator**](https://github.com/ironcore-dev/boot-operator): iPXE and HTTP boot server that provides boot images and Ignition configurations.
1717
- [**FeDHCP**](https://github.com/ironcore-dev/fedhcp): A DHCP server that provides in-band and out-of-band network configuration to bare metal servers.
@@ -22,7 +22,7 @@ Usage guides and concepts for the `metal-operator` API types can be found in the
2222

2323
## Prerequisites
2424

25-
The current implementation of the bare metal automation in IronCore requires the following prerequisites:
25+
The current implementation of the bare metal management in IronCore requires the following prerequisites:
2626

2727
- In-band and out-of-band network connectivity to the bare metal servers.
2828
- A management server in the out-of-band network that can communicate with the bare metal servers.

docs/iaas/architecture/os-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
IronCore uses Open Container Initiative (OCI) images as the standard format for operating system images. This allows
44
for a consistent and portable way to manage and deploy operating systems across different environments. OCI images in
55
IronCore are used both for virtual machine creation in the [Infrastructure as a Service](/iaas/getting-started) and in the
6-
[Bare Metal Automation](/baremetal/) layers. IronCore OCI images should not be confused with container images,
6+
[Bare Metal Management](/baremetal/) layers. IronCore OCI images should not be confused with container images,
77
as they represent a full operating system rather than just a single application or service.
88

99
The core idea behind using OCI as a means to manage operating system images is to leverage any OCI compliant image registry,

docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ layout: home
44

55
hero:
66
name: "IronCore Project"
7-
text: "Cloud Native Infrastructure as a Service and Bare Metal Automation"
8-
tagline: "IronCore is an open-source platform designed to empower users with robust infrastructure management and bare metal automation"
7+
text: "Cloud Native Infrastructure Management"
8+
tagline: "IronCore is an Open-Source platform designed to empower users by providing a robust Infrastructure as a Service layer, Bare Metal Management and Network Automation"
99
image:
1010
src: https://raw.githubusercontent.com/ironcore-dev/ironcore/refs/heads/main/docs/assets/logo_borderless.svg
1111
alt: IronCore
@@ -17,8 +17,11 @@ hero:
1717
text: Infrastructure as a Service
1818
link: /iaas/getting-started
1919
- theme: alt
20-
text: Bare Metal Automation
20+
text: Bare Metal Management
2121
link: /baremetal/
22+
- theme: alt
23+
text: Network Automation
24+
link: /network-automation/
2225

2326
features:
2427
- title: 🔍 Automatic Discovery & Provisioning

docs/overview/index.md

Lines changed: 46 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ can transform your workflows.
66

77
## IronCore Architecture
88

9-
Here’s a visual representation of IronCore’s two layers:
9+
Here's a visual representation of IronCore's two layers. The bare metal management and network automation layers
10+
belong to the infrastructure management domain, while the IaaS layer provides cloud-like capabilities on top.
1011

11-
**Infrastructure as a Service (IaaS)**
12+
## Infrastructure as a Service (IaaS)
1213

1314
```mermaid
1415
graph TD
@@ -23,25 +24,6 @@ graph TD
2324
F -->|Block/Object| L[Data]
2425
```
2526

26-
**Bare Metal Automation**
27-
28-
```mermaid
29-
graph TD
30-
A["Bare Metal Automation"]
31-
32-
A --> G[Server Provisioning]
33-
A --> H[Day 2 Operations]
34-
A --> I[Lifecycle Management]
35-
36-
G -->|Discovery & Deployment| M[Servers]
37-
H -->|BIOS/Firmware Updates| N[Maintenance]
38-
I -->|Health Monitoring| O[Reliability]
39-
```
40-
41-
---
42-
43-
## Infrastructure as a Service (IaaS)
44-
4527
The IaaS layer provides a flexible, user-friendly environment to create and manage **Compute**, **Networking**, and
4628
**Storage** resources. With IronCore, you can:
4729

@@ -58,14 +40,54 @@ control at your fingertips.
5840

5941
---
6042

61-
## Bare Metal Automation
43+
## Bare Metal Management
6244

63-
The Bare Metal Automation layer takes server management to the next level, handling everything from provisioning to ongoing maintenance. Key features include:
45+
```mermaid
46+
graph TD
47+
A["Bare Metal Management"]
48+
49+
A --> G[Server Provisioning]
50+
A --> H[Day 2 Operations]
51+
A --> I[Lifecycle Management]
52+
53+
G -->|Discovery & Deployment| M[Servers]
54+
H -->|BIOS/Firmware Updates| N[Maintenance]
55+
I -->|Health Monitoring| O[Reliability]
56+
```
57+
58+
The Bare Metal Management layer takes server management to the next level, handling everything from provisioning to ongoing maintenance. Key features include:
6459

6560
- **Server Provisioning**: Automate the discovery, configuration, and deployment of bare metal servers.
6661
- **Day 2 Operations**: Simplify maintenance tasks like OS updates, BIOS/firmware upgrades, and hardware diagnostics.
6762
- **Lifecycle Management**: Monitor and manage server health, ensuring peak performance and reliability.
6863

6964
This layer is perfect for those who need fine-grained control over physical hardware without sacrificing automation.
7065

71-
**[Get Started with Bare Metal Automation](/baremetal/)**
66+
**[Get Started with Bare Metal Management](/baremetal/)**
67+
68+
**[API References](/baremetal/api-references/)**
69+
70+
## Network Automation
71+
72+
```mermaid
73+
graph TD
74+
A["Network Automation"]
75+
76+
A --> G[Network Device Provisioning]
77+
A --> H[Day 2 Operations]
78+
A --> I[Lifecycle Management]
79+
80+
G -->|Discovery & Provisioning| M[Network Devices]
81+
H -->|Configuration Management| N[Network Devices]
82+
I -->|Health Monitoring| O[Reliability]
83+
```
84+
85+
The Network Automation layer streamlines the management of network devices and configurations. It offers:
86+
87+
- **Network Device Provisioning**: Automatically discover and provision network devices across your infrastructure.
88+
- **Day 2 Operations**: Manage configurations, updates, and compliance for network devices.
89+
- **Lifecycle Management**: Monitor network device health and performance to ensure optimal operation.
90+
91+
This layer is ideal for network administrators looking to automate and simplify network management tasks.
92+
93+
**[Get Started with Network Automation](/network-automation/)**

0 commit comments

Comments
 (0)