Skip to content

Commit 906e6ce

Browse files
metal3-io-botmetal3-io-bot
authored
Merge pull request #652 from Nordix/tuomo/add-links-to-glossary
add links to glossary.md
2 parents 6aadfcf + b799e5d commit 906e6ce

File tree

1 file changed

+84
-81
lines changed

1 file changed

+84
-81
lines changed

‎docs/user-guide/src/glossary.md‎

Lines changed: 84 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -4,89 +4,92 @@
44

55
| Abbreviation | Full Name | Description |
66
|--------------|-----------|-------------|
7-
| BIOS | Basic Input/Output System | Legacy firmware interface for booting computers, being replaced by UEFI |
8-
| BMC | Baseboard Management Controller | Out-of-band management chip enabling remote power control, console access, and hardware monitoring independent of the host OS |
9-
| BMH | BareMetalHost | Metal3 Kubernetes custom resource representing a physical server and its desired state |
10-
| BMO | Bare Metal Operator | Metal3 Kubernetes controller that reconciles BareMetalHost resources by communicating with Ironic |
11-
| CAPI | Cluster API | Kubernetes SIG project providing declarative APIs for cluster creation, configuration, and management |
12-
| CAPM3 | Cluster API Provider Metal3 | Metal3's infrastructure provider enabling Cluster API to manage bare-metal clusters |
13-
| DHCP | Dynamic Host Configuration Protocol | Network protocol for automatic IP configuration; required for PXE/iPXE boot |
14-
| EOL | End of Life | Version no longer receiving updates or support |
15-
| FIPS | Federal Information Processing Standards | US government security standards for cryptographic modules |
16-
| iDRAC | Integrated Dell Remote Access Controller | Dell's BMC implementation with Redfish support |
17-
| iLO | Integrated Lights-Out | HPE's BMC implementation with Redfish support |
18-
| IPA | Ironic Python Agent | Agent running in a ramdisk that executes Ironic commands on bare-metal hosts (inspection, deployment, cleaning) |
19-
| IPAM | IP Address Manager | Metal3 controller managing static IP allocations for cluster nodes |
20-
| IPMI | Intelligent Platform Management Interface | Legacy protocol for remote hardware management; less secure than Redfish |
21-
| iRMC | Integrated Remote Management Controller | Fujitsu's BMC implementation (deprecated in Metal3) |
22-
| IrSO | Ironic Standalone Operator | Metal3 Kubernetes operator that deploys and manages Ironic |
23-
| MAC | Media Access Control | Unique hardware address identifying a network interface |
24-
| NIC | Network Interface Card | Hardware providing network connectivity |
25-
| PXE | Preboot Execution Environment | Intel standard for network booting via DHCP and TFTP |
26-
| RAID | Redundant Array of Independent Disks | Technology combining multiple disks for performance or redundancy |
27-
| SRIOV | Single Root I/O Virtualization | PCIe standard allowing a device to appear as multiple virtual devices |
28-
| TFTP | Trivial File Transfer Protocol | Simple protocol for transferring boot files; used by PXE |
29-
| TLS | Transport Layer Security | Cryptographic protocol securing network communications |
30-
| UEFI | Unified Extensible Firmware Interface | Modern firmware interface replacing BIOS; supports Secure Boot |
31-
| UUID | Universally Unique Identifier | 128-bit identifier for uniquely identifying resources |
32-
| VBMC | Virtual BMC | Tool emulating IPMI BMC for virtual machines |
7+
| BIOS | [Basic Input/Output System](https://en.wikipedia.org/wiki/BIOS) | Legacy firmware interface for booting computers, being replaced by UEFI |
8+
| BMC | [Baseboard Management Controller](https://en.wikipedia.org/wiki/Baseboard_management_controller) | Out-of-band management chip enabling remote power control, console access, and hardware monitoring independent of the host OS |
9+
| BMH | [BareMetalHost](./bmo/introduction.md#enrolling-baremetalhosts) | Metal3 Kubernetes custom resource representing a physical server and its desired state |
10+
| BMO | [Bare Metal Operator](./bmo/introduction.md) | Metal3 Kubernetes controller that reconciles BareMetalHost resources by communicating with Ironic |
11+
| CAPI | [Cluster API](https://cluster-api.sigs.k8s.io/) | Kubernetes SIG project providing declarative APIs for cluster creation, configuration, and management |
12+
| CAPM3 | [Cluster API Provider Metal3](./capm3/introduction.md) | Metal3's infrastructure provider enabling Cluster API to manage bare-metal clusters |
13+
| DHCP | [Dynamic Host Configuration Protocol](https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol) | Network protocol for automatic IP configuration; required for PXE/iPXE boot |
14+
| EOL | [End of Life](https://en.wikipedia.org/wiki/End-of-life_product) | Version no longer receiving updates or support |
15+
| FIPS | [Federal Information Processing Standards](https://www.nist.gov/standardsgov/compliance-faqs-federal-information-processing-standards-fips) | US government security standards for cryptographic modules |
16+
| iDRAC | [Integrated Dell Remote Access Controller](./bmo/supported_hardware.md#redfish-and-its-variants) | Dell's BMC implementation with Redfish support |
17+
| iLO | [Integrated Lights-Out](./bmo/supported_hardware.md#redfish-and-its-variants) | HPE's BMC implementation with Redfish support |
18+
| IPA | [Ironic Python Agent](./ironic/ironic-python-agent.md) | Agent running in a ramdisk that executes Ironic commands on bare-metal hosts (inspection, deployment, cleaning) |
19+
| IPAM | [IP Address Manager](./ipam/introduction.md) | Metal3 controller managing static IP allocations for cluster nodes |
20+
| IPMI | [Intelligent Platform Management Interface](./bmo/supported_hardware.md#ipmi) | Legacy protocol for remote hardware management; less secure than Redfish |
21+
| iRMC | [Integrated Remote Management Controller](./bmo/supported_hardware.md#vendor-specific-protocols) | Fujitsu's BMC implementation (deprecated in Metal3) |
22+
| IrSO | [Ironic Standalone Operator](./irso/introduction.md) | Metal3 Kubernetes operator that deploys and manages Ironic |
23+
| MAC | [Media Access Control](https://en.wikipedia.org/wiki/MAC_address) | Unique hardware address identifying a network interface |
24+
| NIC | [Network Interface Card](https://en.wikipedia.org/wiki/Network_interface_controller) | Hardware providing network connectivity |
25+
| PXE | [Preboot Execution Environment](https://docs.openstack.org/ironic/latest/admin/interfaces/boot.html#pxe-boot) | Intel standard for network booting via DHCP and TFTP |
26+
| RAID | [Redundant Array of Independent Disks](./bmo/raid.md) | Technology combining multiple disks for performance or redundancy |
27+
| SRIOV | [Single Root I/O Virtualization](https://en.wikipedia.org/wiki/Single-root_input/output_virtualization) | PCIe standard allowing a device to appear as multiple virtual devices |
28+
| TFTP | [Trivial File Transfer Protocol](https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol) | Simple protocol for transferring boot files; used by PXE |
29+
| TLS | [Transport Layer Security](https://en.wikipedia.org/wiki/Transport_Layer_Security) | Cryptographic protocol securing network communications |
30+
| UEFI | [Unified Extensible Firmware Interface](https://en.wikipedia.org/wiki/UEFI) | Modern firmware interface replacing BIOS; supports Secure Boot |
31+
| UUID | [Universally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) | 128-bit identifier for uniquely identifying resources |
32+
| VBMC | [Virtual BMC](https://docs.openstack.org/virtualbmc/latest/) | Tool emulating IPMI BMC for virtual machines |
3333

3434
## Key Terms
3535

3636
| Term | Description |
3737
|------|-------------|
38-
| Automated Cleaning | Ironic feature that wipes disk metadata before/after provisioning |
39-
| BareMetalHost (BMH) | Metal3 custom resource representing a physical server and its desired state |
40-
| Bare Metal Operator (BMO) | Metal3 controller reconciling BareMetalHost resources via Ironic |
41-
| Bifrost | OpenStack tool for standalone Ironic deployment |
42-
| Bootstrap Cluster | Temporary management cluster used to create the initial workload cluster |
43-
| cloud-init | Industry-standard tool for cloud instance initialization and configuration |
44-
| Cluster API (CAPI) | Kubernetes SIG project for declarative cluster lifecycle management |
45-
| Cluster API Provider Metal3 (CAPM3) | Metal3's infrastructure provider for Cluster API |
46-
| clusterctl | CLI tool for Cluster API cluster lifecycle management |
47-
| Custom Resource (CR/CRD) | Kubernetes API extension for domain-specific objects; CRD defines the schema |
48-
| Deprovisioning | Process of removing an OS image and cleaning a host |
49-
| dnsmasq | Lightweight DNS/DHCP/TFTP server used for network boot |
50-
| Failure Domain | Topology grouping of hosts sharing common failure characteristics |
51-
| Finalizer | Kubernetes mechanism preventing resource deletion until cleanup completes |
52-
| Firmware Settings | BIOS/UEFI configuration options manageable through Metal3 |
53-
| Glean | Alternative to cloud-init for instance configuration |
54-
| Hardware Inventory | Discovered hardware details (CPU, RAM, disks, NICs) of a host |
55-
| Hardware RAID | RAID implemented by dedicated hardware controller |
56-
| Host Inspection | Process of discovering and recording hardware details of a bare-metal host |
57-
| Ignition | Configuration system used by Fedora CoreOS and similar distributions |
58-
| Infrastructure Provider | Cluster API component implementing cloud/platform-specific functionality |
59-
| IP Address Manager (IPAM) | Metal3 controller managing static IP allocations for cluster nodes |
60-
| iPXE | Open-source network boot firmware extending PXE with HTTP support and scripting |
61-
| Ironic | OpenStack project for bare-metal provisioning, used by Metal3 |
62-
| Ironic Python Agent (IPA) | Agent in ramdisk executing Ironic commands on bare-metal hosts |
63-
| Ironic Standalone Operator (IrSO) | Metal3 operator deploying and managing Ironic |
64-
| ISO | Disc image format (ISO 9660) used for virtual media boot |
65-
| Keepalived | Service providing virtual IP address failover |
66-
| KubeadmControlPlane (KCP) | Cluster API resource managing Kubernetes control plane nodes |
67-
| Kustomize | Kubernetes configuration customization tool |
68-
| Live ISO | Bootable ISO image that runs entirely in memory without disk installation |
69-
| Machine | Cluster API resource representing a single Kubernetes node |
70-
| MachineDeployment | Cluster API resource for declarative worker node management |
71-
| MachineSet | Cluster API resource maintaining a set of Machines |
72-
| Management Cluster | Kubernetes cluster running Metal3/CAPI controllers |
73-
| Metal3Cluster | CAPM3 custom resource representing cluster infrastructure |
74-
| Metal3Machine | CAPM3 custom resource linking a Machine to a BareMetalHost |
75-
| Metal3MachineTemplate | CAPM3 template for creating Metal3Machine resources |
76-
| Network Boot | Booting a machine over the network using PXE/iPXE |
77-
| Network Data | Configuration describing network settings for a provisioned host |
78-
| Node Reuse | Feature allowing reuse of same hosts during rolling upgrades |
79-
| Pivoting | Moving cluster management from bootstrap to target cluster |
80-
| Preparing | Host state where RAID/firmware configuration is applied |
81-
| Provisioning | Process of deploying an OS image to a bare-metal host |
82-
| Provisioning Network | Isolated L2 network for Metal3 to bare-metal communication |
83-
| Ramdisk | Minimal Linux image loaded into RAM for provisioning operations |
84-
| Redfish | Modern RESTful API standard for hardware management, replacing IPMI |
85-
| Remediation | Automated recovery of unhealthy cluster nodes |
86-
| Root Device Hints | Criteria for selecting which disk to use as the root device |
87-
| Software RAID | RAID implemented by the Linux kernel using mdadm |
88-
| Sushy-tools | BMC emulator implementing Redfish protocol for virtual machines |
89-
| Target Cluster | Destination cluster in a pivoting operation |
90-
| User Data | Configuration script/data processed by cloud-init or similar |
91-
| Virtual Media | Boot method using virtual CD/DVD over BMC (no provisioning network needed) |
92-
| Workload Cluster | Kubernetes cluster running user applications |
38+
| [Automated Cleaning](./bmo/automated_cleaning.md) | Ironic feature that wipes disk metadata before/after provisioning |
39+
| [BareMetalHost](./bmo/introduction.md#enrolling-baremetalhosts) (BMH) | Metal3 custom resource representing a physical server and its desired state |
40+
| [Bare Metal Operator](./bmo/introduction.md) (BMO) | Metal3 controller reconciling BareMetalHost resources via Ironic |
41+
| [Bifrost](https://docs.openstack.org/bifrost/latest/) | OpenStack tool for standalone Ironic deployment |
42+
| [Bootstrap Cluster](https://cluster-api.sigs.k8s.io/reference/glossary#bootstrap-cluster) | Temporary cluster used to provision a target management cluster |
43+
| [cloud-init](https://cloudinit.readthedocs.io/en/latest/) | Industry-standard tool for cloud instance initialization and configuration |
44+
| [Cluster API](https://cluster-api.sigs.k8s.io/) (CAPI) | Kubernetes SIG project for declarative cluster lifecycle management |
45+
| [Cluster API Provider Metal3](./capm3/introduction.md) (CAPM3) | Metal3's infrastructure provider for Cluster API |
46+
| [clusterctl](https://cluster-api.sigs.k8s.io/clusterctl/overview) | CLI tool for Cluster API cluster lifecycle management |
47+
| [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CR/CRD) | Kubernetes API extension for domain-specific objects; CRD defines the schema |
48+
| [Deprovisioning](./bmo/provisioning.md#deprovisioning) | Process of removing an OS image and cleaning a host |
49+
| [dnsmasq](https://thekelleys.org.uk/dnsmasq/doc.html) | Lightweight DNS/DHCP/TFTP server used for network boot |
50+
| [Failure Domain](./capm3/failure_domain.md) | Topology grouping of hosts sharing common failure characteristics |
51+
| [Finalizer](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/) | Kubernetes mechanism preventing resource deletion until cleanup completes |
52+
| [Firmware Settings](./bmo/firmware_settings.md) | BIOS/UEFI configuration options manageable through Metal3 |
53+
| [Glean](https://docs.openstack.org/infra/glean/) | Alternative to cloud-init for instance configuration |
54+
| [Hardware Inventory](./ironic/introduction.md#host-enrollment-and-hardware-inventory) | Discovered hardware details (CPU, RAM, disks, NICs) of a host |
55+
| [Hardware RAID](./bmo/raid.md#hardware-raid) | RAID implemented by dedicated hardware controller |
56+
| [Host Inspection](./ironic/introduction.md#host-enrollment-and-hardware-inventory) | Process of discovering and recording hardware details of a bare-metal host |
57+
| [Ignition](https://coreos.github.io/ignition/) | Configuration system used by Fedora CoreOS and similar distributions |
58+
| [Infrastructure Provider](https://cluster-api.sigs.k8s.io/user/concepts#infrastructure-provider) | Cluster API component implementing cloud/platform-specific functionality |
59+
| [IP Address Manager](./ipam/introduction.md) (IPAM) | Metal3 controller managing static IP allocations for cluster nodes |
60+
| [IPAddress](./ipam/introduction.md#ipaddress) | IPAM resource representing an allocated IP address |
61+
| [IPClaim](./ipam/introduction.md#ipclaim) | IPAM resource representing a request for an IP address |
62+
| [IPPool](./ipam/introduction.md#ippool) | IPAM resource defining a pool of IP addresses for allocation |
63+
| [iPXE](https://ipxe.org/) | Open-source network boot firmware extending PXE with HTTP support and scripting |
64+
| [Ironic](./ironic/introduction.md) | OpenStack project for bare-metal provisioning, used by Metal3 |
65+
| [Ironic Python Agent](./ironic/ironic-python-agent.md) (IPA) | Agent in ramdisk executing Ironic commands on bare-metal hosts |
66+
| [Ironic Standalone Operator](./irso/introduction.md) (IrSO) | Metal3 operator deploying and managing Ironic |
67+
| [ISO](https://en.wikipedia.org/wiki/ISO_9660) | Disc image format (ISO 9660) used for virtual media boot |
68+
| [Keepalived](https://www.keepalived.org/) | Service providing virtual IP address failover |
69+
| [KubeadmControlPlane](https://cluster-api.sigs.k8s.io/tasks/control-plane/kubeadm-control-plane) (KCP) | Cluster API resource managing Kubernetes control plane nodes |
70+
| [Kustomize](https://kustomize.io/) | Kubernetes configuration customization tool |
71+
| [Live ISO](./bmo/live-iso.md) | Bootable ISO image that runs entirely in memory without disk installation |
72+
| [Machine](https://cluster-api.sigs.k8s.io/user/concepts#machine) | Cluster API resource representing a single Kubernetes node |
73+
| [MachineDeployment](https://cluster-api.sigs.k8s.io/user/concepts#machinedeployment) | Cluster API resource for declarative worker node management |
74+
| [MachineSet](https://cluster-api.sigs.k8s.io/user/concepts#machineset) | Cluster API resource maintaining a set of Machines |
75+
| [Management Cluster](https://cluster-api.sigs.k8s.io/reference/glossary#management-cluster) | Kubernetes cluster running Metal3/CAPI controllers |
76+
| [Metal3Cluster](./capm3/introduction.md) | CAPM3 custom resource representing cluster infrastructure |
77+
| [Metal3Machine](./capm3/introduction.md) | CAPM3 custom resource linking a Machine to a BareMetalHost |
78+
| [Metal3MachineTemplate](./capm3/introduction.md) | CAPM3 template for creating Metal3Machine resources |
79+
| [Network Boot](./bmo/supported_hardware.md) | Booting a machine over the network using PXE/iPXE |
80+
| [Network Data](./bmo/instance_customization.md#networkdata) | Configuration describing network settings for a provisioned host |
81+
| [Node Reuse](./capm3/node_reuse.md) | Feature allowing reuse of same hosts during rolling upgrades |
82+
| [Pivoting](./capm3/pivoting.md) | Moving cluster management from bootstrap to target cluster |
83+
| [Preparing](./bmo/state_machine.md#preparing) | Host state where RAID/firmware configuration is applied |
84+
| [Provisioning](./bmo/provisioning.md) | Process of deploying an OS image to a bare-metal host |
85+
| [Provisioning Network](./irso/install-basics.md#network-boot-requirements) | Isolated L2 network for Metal3 to bare-metal communication |
86+
| [Ramdisk](https://docs.openstack.org/ironic/latest/admin/ramdisk-boot.html) | Minimal Linux image loaded into RAM for provisioning operations |
87+
| [Redfish](./bmo/supported_hardware.md#redfish-and-its-variants) | Modern RESTful API standard for hardware management, replacing IPMI |
88+
| [Remediation](./capm3/remediaton.md) | Automated recovery of unhealthy cluster nodes |
89+
| [Root Device Hints](./bmo/root_device_hints.md) | Criteria for selecting which disk to use as the root device |
90+
| [Software RAID](./bmo/raid.md#software-raid) | RAID implemented by the Linux kernel using mdadm |
91+
| [Sushy-tools](https://docs.openstack.org/sushy-tools/latest/) | BMC emulator implementing Redfish protocol for virtual machines |
92+
| [Target Cluster](./capm3/pivoting.md) | Destination cluster in a pivoting operation |
93+
| [User Data](./bmo/instance_customization.md#userdata) | Configuration script/data processed by cloud-init or similar |
94+
| [Virtual Media](./bmo/supported_hardware.md) | Boot method using virtual CD/DVD over BMC (no provisioning network needed) |
95+
| [Workload Cluster](https://cluster-api.sigs.k8s.io/reference/glossary#workload-cluster) | Kubernetes cluster running user applications |

0 commit comments

Comments
 (0)