From c4c3af34ebfc235f57783b14e9763b693031a68d Mon Sep 17 00:00:00 2001 From: Andreas Fritzler Date: Wed, 21 Jan 2026 12:42:07 +0100 Subject: [PATCH 1/2] Add network automation section --- docs/.vitepress/config.mts | 10 ++++++++-- docs/network-automation/index.md | 15 +++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/network-automation/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 4232567..5596089 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -28,6 +28,7 @@ export default withMermaid({ items: [ {text: 'Infrastructure as a Service', link: '/iaas/getting-started'}, {text: 'Bare Metal Automation', link: '/baremetal/'}, + {text: 'Network Automation', link: '/network-automation/'}, ]}, ], @@ -154,8 +155,13 @@ export default withMermaid({ { text: 'boot-operator', link: '/baremetal/api-references/boot-operator' }, ], }, - ]}, - + ], + '/network-automation/': [ + { + text: 'Overview', link: '/network-automation/', + }, + ], + }, socialLinks: [ { icon: 'github', diff --git a/docs/network-automation/index.md b/docs/network-automation/index.md new file mode 100644 index 0000000..afb364b --- /dev/null +++ b/docs/network-automation/index.md @@ -0,0 +1,15 @@ +# Network Automation + +The IronCore project provides a robust framework for automating network management tasks. We are leveraging +a Kubernetes-based architecture to streamline the deployment, configuration, and monitoring of network devices. + +## Key Features +- **Devices Discovery**: Automatically discover network devices. +- **Provisioning**: Automate the provisioning of network devices. +- **Configuration Management**: Manage and apply configurations across multiple devices. + +## Getting Started + +In the IronCore project we support different vendors and device types through dedicated operators. Below are some of the key components: + +- [network-operator](https://ironcore.dev/network-operator/): Automation for Cisco NX-OS devices. From b25e951e8ec5de5911c99b4fa204e316cc3ac658 Mon Sep 17 00:00:00 2001 From: Andreas Fritzler Date: Thu, 22 Jan 2026 12:58:43 +0100 Subject: [PATCH 2/2] Update terminology and overview pages --- docs/.vitepress/config.mts | 2 +- docs/baremetal/api-references/index.md | 4 +- docs/baremetal/architecture/index.md | 4 +- docs/baremetal/index.md | 8 +- docs/iaas/architecture/os-images.md | 2 +- docs/index.md | 9 ++- docs/overview/index.md | 70 ++++++++++++------ ...view.png => metal-management-overview.png} | Bin 8 files changed, 62 insertions(+), 37 deletions(-) rename docs/public/{metal-automation-overview.png => metal-management-overview.png} (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 5596089..21b6958 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -27,7 +27,7 @@ export default withMermaid({ {text: 'Documentation', items: [ {text: 'Infrastructure as a Service', link: '/iaas/getting-started'}, - {text: 'Bare Metal Automation', link: '/baremetal/'}, + {text: 'Bare Metal Management', link: '/baremetal/'}, {text: 'Network Automation', link: '/network-automation/'}, ]}, ], diff --git a/docs/baremetal/api-references/index.md b/docs/baremetal/api-references/index.md index ee40d12..f0afbf1 100644 --- a/docs/baremetal/api-references/index.md +++ b/docs/baremetal/api-references/index.md @@ -1,6 +1,6 @@ # API References -This section provides detailed API reference documentation for the IronCore Bare Metal Automation components. +This section provides detailed API reference documentation for the IronCore Bare Metal Management components. -* [**metal-operator**](/baremetal/api-references/metal-operator): The core bare metal automation component that manages the lifecycle of bare metal servers. +* [**metal-operator**](/baremetal/api-references/metal-operator): The core bare metal management component that manages the lifecycle of bare metal servers. * [**boot-operator**](/baremetal/api-references/boot-operator): Responsible for providing boot images and Ignition configurations to bare metal servers. diff --git a/docs/baremetal/architecture/index.md b/docs/baremetal/architecture/index.md index 8b0b7ef..df85736 100644 --- a/docs/baremetal/architecture/index.md +++ b/docs/baremetal/architecture/index.md @@ -1,9 +1,9 @@ # Overview -The bare metal automation architecture is described in the diagram below. It consists of two main concepts: out-of-band +The bare metal management architecture is described in the diagram below. It consists of two main concepts: out-of-band server management and in-band server boot automation. -![Bare Metal Automation Architecture](/metal-automation-overview.png) +![Bare Metal Management Architecture](/metal-management-overview.png) ## Out-of-Band Automation diff --git a/docs/baremetal/index.md b/docs/baremetal/index.md index 7e41446..5747ab1 100644 --- a/docs/baremetal/index.md +++ b/docs/baremetal/index.md @@ -1,6 +1,6 @@ -# Baremetal Automation +# Bare Metal Management -The bare metal automation in IronCore is designed to provide a comprehensive solution for managing physical servers +The bare metal management and automation in IronCore is designed to provide a comprehensive solution for managing physical servers in a Kubernetes-native way. It leverages the power of Kubernetes Custom Resource Definitions (CRDs) to automate: - **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 ## Core Components -The core components of the bare metal automation in IronCore include: +The core components of the bare metal management in IronCore include: - [**Metal Operator**](https://github.com/ironcore-dev/metal-operator): The central component that manages the lifecycle of bare metal servers. - [**Boot Operator**](https://github.com/ironcore-dev/boot-operator): iPXE and HTTP boot server that provides boot images and Ignition configurations. - [**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 ## Prerequisites -The current implementation of the bare metal automation in IronCore requires the following prerequisites: +The current implementation of the bare metal management in IronCore requires the following prerequisites: - In-band and out-of-band network connectivity to the bare metal servers. - A management server in the out-of-band network that can communicate with the bare metal servers. diff --git a/docs/iaas/architecture/os-images.md b/docs/iaas/architecture/os-images.md index 498108e..1d995da 100644 --- a/docs/iaas/architecture/os-images.md +++ b/docs/iaas/architecture/os-images.md @@ -3,7 +3,7 @@ IronCore uses Open Container Initiative (OCI) images as the standard format for operating system images. This allows for a consistent and portable way to manage and deploy operating systems across different environments. OCI images in IronCore are used both for virtual machine creation in the [Infrastructure as a Service](/iaas/getting-started) and in the -[Bare Metal Automation](/baremetal/) layers. IronCore OCI images should not be confused with container images, +[Bare Metal Management](/baremetal/) layers. IronCore OCI images should not be confused with container images, as they represent a full operating system rather than just a single application or service. The core idea behind using OCI as a means to manage operating system images is to leverage any OCI compliant image registry, diff --git a/docs/index.md b/docs/index.md index e1a4197..d64245e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,8 +4,8 @@ layout: home hero: name: "IronCore Project" - text: "Cloud Native Infrastructure as a Service and Bare Metal Automation" - tagline: "IronCore is an open-source platform designed to empower users with robust infrastructure management and bare metal automation" + text: "Cloud Native Infrastructure Management" + 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" image: src: https://raw.githubusercontent.com/ironcore-dev/ironcore/refs/heads/main/docs/assets/logo_borderless.svg alt: IronCore @@ -17,8 +17,11 @@ hero: text: Infrastructure as a Service link: /iaas/getting-started - theme: alt - text: Bare Metal Automation + text: Bare Metal Management link: /baremetal/ + - theme: alt + text: Network Automation + link: /network-automation/ features: - title: 🔍 Automatic Discovery & Provisioning diff --git a/docs/overview/index.md b/docs/overview/index.md index e771d56..70d5e44 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -6,9 +6,10 @@ can transform your workflows. ## IronCore Architecture -Here’s a visual representation of IronCore’s two layers: +Here's a visual representation of IronCore's two layers. The bare metal management and network automation layers +belong to the infrastructure management domain, while the IaaS layer provides cloud-like capabilities on top. -**Infrastructure as a Service (IaaS)** +## Infrastructure as a Service (IaaS) ```mermaid graph TD @@ -23,25 +24,6 @@ graph TD F -->|Block/Object| L[Data] ``` -**Bare Metal Automation** - -```mermaid -graph TD - A["Bare Metal Automation"] - - A --> G[Server Provisioning] - A --> H[Day 2 Operations] - A --> I[Lifecycle Management] - - G -->|Discovery & Deployment| M[Servers] - H -->|BIOS/Firmware Updates| N[Maintenance] - I -->|Health Monitoring| O[Reliability] -``` - ---- - -## Infrastructure as a Service (IaaS) - The IaaS layer provides a flexible, user-friendly environment to create and manage **Compute**, **Networking**, and **Storage** resources. With IronCore, you can: @@ -58,9 +40,22 @@ control at your fingertips. --- -## Bare Metal Automation +## Bare Metal Management -The Bare Metal Automation layer takes server management to the next level, handling everything from provisioning to ongoing maintenance. Key features include: +```mermaid +graph TD + A["Bare Metal Management"] + + A --> G[Server Provisioning] + A --> H[Day 2 Operations] + A --> I[Lifecycle Management] + + G -->|Discovery & Deployment| M[Servers] + H -->|BIOS/Firmware Updates| N[Maintenance] + I -->|Health Monitoring| O[Reliability] +``` + +The Bare Metal Management layer takes server management to the next level, handling everything from provisioning to ongoing maintenance. Key features include: - **Server Provisioning**: Automate the discovery, configuration, and deployment of bare metal servers. - **Day 2 Operations**: Simplify maintenance tasks like OS updates, BIOS/firmware upgrades, and hardware diagnostics. @@ -68,4 +63,31 @@ The Bare Metal Automation layer takes server management to the next level, handl This layer is perfect for those who need fine-grained control over physical hardware without sacrificing automation. -**[Get Started with Bare Metal Automation](/baremetal/)** +**[Get Started with Bare Metal Management](/baremetal/)** + +**[API References](/baremetal/api-references/)** + +## Network Automation + +```mermaid +graph TD + A["Network Automation"] + + A --> G[Network Device Provisioning] + A --> H[Day 2 Operations] + A --> I[Lifecycle Management] + + G -->|Discovery & Provisioning| M[Network Devices] + H -->|Configuration Management| N[Network Devices] + I -->|Health Monitoring| O[Reliability] +``` + +The Network Automation layer streamlines the management of network devices and configurations. It offers: + +- **Network Device Provisioning**: Automatically discover and provision network devices across your infrastructure. +- **Day 2 Operations**: Manage configurations, updates, and compliance for network devices. +- **Lifecycle Management**: Monitor network device health and performance to ensure optimal operation. + +This layer is ideal for network administrators looking to automate and simplify network management tasks. + +**[Get Started with Network Automation](/network-automation/)** diff --git a/docs/public/metal-automation-overview.png b/docs/public/metal-management-overview.png similarity index 100% rename from docs/public/metal-automation-overview.png rename to docs/public/metal-management-overview.png