Skip to content

Commit

Permalink
Merge pull request #482 from Nordix/tuomo/spellcheck-followup
Browse files Browse the repository at this point in the history
fix some more spelling issues
  • Loading branch information
metal3-io-bot authored Oct 22, 2024
2 parents f037629 + 2547fc3 commit 3d32366
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 14 deletions.
1 change: 1 addition & 0 deletions .cspell-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"dhcpd",
"DIR",
"Dmitry",
"DMTF",
"dnsmasq",
"drac",
"EKS",
Expand Down
10 changes: 4 additions & 6 deletions design/baremetal-operator/bmc-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
http://creativecommons.org/licenses/by/3.0/legalcode
-->

<!-- cSpell:ignore ostest,passthru -->

# Event Subscription API

Users of bare metal hardware may want to receive events from the
Expand Down Expand Up @@ -60,8 +62,6 @@ threshold.

### Implementation Details

<!-- cSpell:ignore ostest -->

```yaml
apiVersion: metal3.io/v1alpha1
kind: BMCEventSubscription
Expand All @@ -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.
Expand Down Expand Up @@ -138,9 +138,7 @@ implementations (if they exist at all).
## References
<!-- cSpell:ignore Supermicro,DMTF -->
- [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)
Expand Down
4 changes: 2 additions & 2 deletions design/baremetal-operator/how-ironic-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# how-ironic-works

<!-- cSpell:ignore irmc,xclarity,uncompress -->
<!-- cSpell:ignore irmc,xclarity -->

This document explains how to use ironic in order to achieve various
tasks such as creating a node, recreating a node, deprovisioning a
Expand Down Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions design/baremetal-operator/image-builder-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

# Custom agent image controller

<!-- cSpell:ignore statelessly -->

## Status

implemented
Expand Down Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions design/baremetal-operator/reboot-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# reboot-interface

<!-- cSpell:ignore rebalancing,accomodate,unprovisioned,suffixless -->
<!-- cSpell:ignore rebalancing,unprovisioned,suffixless -->

## Status

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3d32366

Please sign in to comment.