From 2547fc361f4e8e44d531753985b3b0344d9294d9 Mon Sep 17 00:00:00 2001 From: Tuomo Tanskanen Date: Tue, 22 Oct 2024 13:16:37 +0300 Subject: [PATCH] fix some more spelling issues Fix the leftover nits from the previous spellcheck PR. Signed-off-by: Tuomo Tanskanen --- .cspell-config.json | 1 + design/baremetal-operator/bmc-events.md | 10 ++++------ design/baremetal-operator/how-ironic-works.md | 4 ++-- design/baremetal-operator/image-builder-integration.md | 4 +--- design/baremetal-operator/reboot-interface.md | 4 ++-- .../user-defined-root-device-hints.md | 2 +- 6 files changed, 11 insertions(+), 14 deletions(-) diff --git a/.cspell-config.json b/.cspell-config.json index 32172144..859bb2f6 100644 --- a/.cspell-config.json +++ b/.cspell-config.json @@ -69,6 +69,7 @@ "dhcpd", "DIR", "Dmitry", + "DMTF", "dnsmasq", "drac", "EKS", diff --git a/design/baremetal-operator/bmc-events.md b/design/baremetal-operator/bmc-events.md index 1cb0bfa7..3c5d9dd5 100644 --- a/design/baremetal-operator/bmc-events.md +++ b/design/baremetal-operator/bmc-events.md @@ -5,6 +5,8 @@ http://creativecommons.org/licenses/by/3.0/legalcode --> + + # Event Subscription API Users of bare metal hardware may want to receive events from the @@ -60,8 +62,6 @@ threshold. ### Implementation Details - - ```yaml apiVersion: metal3.io/v1alpha1 kind: BMCEventSubscription @@ -81,7 +81,7 @@ status: - A BMCEventSubscription resource represents a subscription to the events generated by a specific BMC. -- Ironic will manage configuring the subscription using a vendor passthrough API. +- Ironic will manage configuring the subscription using a vendor passthru API. - The BMCEventSubscription will maintain a reference to a BareMetalHost. - The BMCEventSubscription will allow injection of headers using a reference to a secret, for example to provide basic auth credentials. @@ -138,9 +138,7 @@ implementations (if they exist at all). ## References - - -- [Ironic Vendor Passthrough for Subscriptions](https://storyboard.openstack.org/#!/story/2009061) +- [Ironic Vendor Passthru for Subscriptions](https://storyboard.openstack.org/#!/story/2009061) - [Supermicro Redfish Guide](https://www.supermicro.com/manuals/other/RedfishRefGuide.pdf) - [DMTF: Redfish Eventing](https://www.dmtf.org/sites/default/files/Redfish%20School%20-%20Events.pdf) - [Redfish Event Controller (POC)](https://github.com/dhellmann/redfish-event-controller) diff --git a/design/baremetal-operator/how-ironic-works.md b/design/baremetal-operator/how-ironic-works.md index 5c224d19..c70d7ed0 100644 --- a/design/baremetal-operator/how-ironic-works.md +++ b/design/baremetal-operator/how-ironic-works.md @@ -7,7 +7,7 @@ # how-ironic-works - + This document explains how to use ironic in order to achieve various tasks such as creating a node, recreating a node, deprovisioning a @@ -362,7 +362,7 @@ Starting with the bare metal node in the "available" provision_state: 5) Compress the resulting ISO9660 image file using the gzip algorithm. 6) Encode the resulting gzip compressed image file in base64 for - storage and transport. Ironic does the needful to decode and uncompress + storage and transport. Ironic does the needful to decode and decompress the configuration drive prior to deployment. 4. Send a HTTP POST to `/v1/nodes/node-id/states/provision` to initiate diff --git a/design/baremetal-operator/image-builder-integration.md b/design/baremetal-operator/image-builder-integration.md index b0975ebb..81e5034e 100644 --- a/design/baremetal-operator/image-builder-integration.md +++ b/design/baremetal-operator/image-builder-integration.md @@ -7,8 +7,6 @@ # Custom agent image controller - - ## Status implemented @@ -254,7 +252,7 @@ administrator or other user. ### Configure the IP address from within a fixed image Using IPv6 Neighbor Discovery, we can determine the network prefix for each -interface. Using the network prefix we can statelessly choose a static IP +interface. Using the network prefix we can in a stateless way choose a static IP address without fear of collision (by using the Modified EUI-64 method based on the MAC address, and/or a stable privacy address). diff --git a/design/baremetal-operator/reboot-interface.md b/design/baremetal-operator/reboot-interface.md index 54d5837e..05f8eac7 100644 --- a/design/baremetal-operator/reboot-interface.md +++ b/design/baremetal-operator/reboot-interface.md @@ -7,7 +7,7 @@ # reboot-interface - + ## Status @@ -58,7 +58,7 @@ implementation for this would be a RebootSchedule CRD that waits until the appointed time before issuing an immediate reboot request to the BareMetalHost. This allows multiple reboots to be scheduled, scheduled reboots to be manipulated or cancelled, and a record to be left behind of past scheduled -reboots. The proposed design could easily be extended to accomodate this +reboots. The proposed design could easily be extended to accommodate this requirement should it arise in future. This API is not responsible for managing unprovisioned hosts, e.g. to recover diff --git a/design/baremetal-operator/user-defined-root-device-hints.md b/design/baremetal-operator/user-defined-root-device-hints.md index ef74090d..5f8e0c3b 100644 --- a/design/baremetal-operator/user-defined-root-device-hints.md +++ b/design/baremetal-operator/user-defined-root-device-hints.md @@ -13,7 +13,7 @@ implemented ## Summary -This document explains how `rootdevicehints` could be given as user +This document explains how `rootDeviceHints` could be given as user defined parameters as part BaremetalHostSpec. The idea is that user would have the possibility to define selective constraints for root device selection. Sometimes selective constrains will not be