Skip to content

Commit 428b61b

Browse files
Use consistent spelling for Ironic
1 parent 5a61282 commit 428b61b

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

docs/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ with Ironic to make changes on the Bare Metal Server.
4040
During the initial introspection and state changes, the above logic works in the
4141
opposite direction as well. Information gathered during introspection or any
4242
state changes on the Bare Metal Server, results in BMO learning about the
43-
change(s) via ironic and a chain of events starts. Once BMO learns about the
43+
change(s) via Ironic and a chain of events starts. Once BMO learns about the
4444
changes, it makes the required
4545
changes on the BMH.
4646

docs/deployment_workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The cluster should either :
1818
the userData and would set the providerIDs based on the BareMetalHost UID.
1919
* Be deployed with the ProviderID set to be the BareMetalHostUUID
2020
* be deployed with each node with the label "metal3.io/uuid" set to the
21-
BareMetalHost UID that is provided by ironic to cloud-init through the
21+
BareMetalHost UID that is provided by Ironic to cloud-init through the
2222
metadata `ds.meta_data.uuid`. This can be achieved by setting the following in
2323
the KubeadmConfig :
2424

docs/dev-setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This requires the following environment variables to be exported :
5353
* `IRONIC_URL`
5454

5555
Those need to be set up accordingly with the
56-
[local ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
56+
[local Ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
5757

5858
The tilt-settings file can be customized. Tilt will also consider everything
5959
under `tilt.d` directory.
@@ -70,7 +70,7 @@ latest code of CAPM3.
7070
Tilt can be used in Metal3-dev-env, as long as the
7171
03_launch_mgmt_cluster.sh script is **NOT** run. In that case Ironic needs to
7272
be deployed locally first, following the
73-
[local ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
73+
[local Ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
7474

7575
By default, the Cluster API components deployed by Tilt have experimental
7676
features turned off. If you would like to enable these features, add
@@ -153,7 +153,7 @@ This requires the following environment variables to be exported :
153153
* `IRONIC_URL`
154154

155155
Those need to be set up accordingly with the
156-
[local ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
156+
[local Ironic setup](https://github.com/metal3-io/baremetal-operator/blob/master/docs/dev-setup.md#running-a-local-instance-of-ironic)
157157

158158
The cluster-api management components that are deployed are configured at the
159159
`/config` folder of each repository respectively. Making changes to those files
@@ -247,7 +247,7 @@ below. Please note, the precedence of variables is as follows:
247247
`worker-templates.flavors[0].WORKER_MACHINE_COUNT`
248248
1. vars defined at 'metadata' level-- spans workers i.e.
249249
`metadata.WORKER_MACHINE_COUNT`
250-
1. programmatically defined default vars i.e. everything except ironic
250+
1. programmatically defined default vars i.e. everything except Ironic
251251
related URL variables "DEPLOY_KERNEL_URL", "DEPLOY_RAMDISK_URL",
252252
"IRONIC_INSPECTOR_URL" and "IRONIC_URL"
253253

docs/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ unset. If unset, then `IRONIC_USERNAME` and `IRONIC_PASSWORD` must be set.
129129

130130
##### IRONIC_INSPECTOR_USERNAME
131131

132-
Username for Ironic inspector basic auth. Optional, but either this variable or
132+
Username for Ironic Inspector basic auth. Optional, but either this variable or
133133
`IRONIC_INSPECTOR_NO_BASIC_AUTH` must be set.
134134

135135
```sh
@@ -138,7 +138,7 @@ Username for Ironic inspector basic auth. Optional, but either this variable or
138138

139139
##### IRONIC_INSPECTOR_PASSWORD
140140

141-
Password for Ironic inspector basic auth. Optional, but either this variable or
141+
Password for Ironic Inspector basic auth. Optional, but either this variable or
142142
`IRONIC_INSPECTOR_NO_BASIC_AUTH` must be set.
143143

144144
```sh
@@ -147,7 +147,7 @@ Password for Ironic inspector basic auth. Optional, but either this variable or
147147

148148
##### IRONIC_INSPECTOR_NO_BASIC_AUTH
149149

150-
Disables basic authentication for Ironic inspector API. Any value provided in
150+
Disables basic authentication for Ironic Inspector API. Any value provided in
151151
this variable disables authentication. To enable authentication, leave this
152152
variable unset. If unset, then `IRONIC_INSPECTOR_USERNAME` and
153153
`IRONIC_INSPECTOR_PASSWORD` must be set.
@@ -347,10 +347,10 @@ WORKERS_KUBEADM_EXTRA_CONFIG="
347347

348348
Before running the `move` command of Clusterctl, elements such as Ironic if
349349
applicable, need to be moved to the target cluster. It is recommended to
350-
scale down the ironic pod in the origin cluster before deploying it on the
350+
scale down the Ironic pod in the origin cluster before deploying it on the
351351
target cluster to prevent issues with a duplicated DHCP server.
352352

353-
Both for pivoting or updating ironic, it is critical that the cluster is in
353+
Both for pivoting or updating Ironic, it is critical that the cluster is in
354354
a stable situation. No operations on BareMetal hosts shall be on-going,
355355
otherwise they might fail. Similarly, in order to prevent conflict during
356356
the pivoting of the DHCP server, we recommend to have no BareMetalHosts
@@ -360,7 +360,7 @@ of the IP address of a running host that would not be supported by Ironic.
360360

361361
In the case of a self-hosted cluster, special care must be paid to Ironic.
362362
Since Ironic runs on the target cluster, updating the target cluster means
363-
that ironic will need to be moved between nodes of the cluster. This results
363+
that Ironic will need to be moved between nodes of the cluster. This results
364364
in similar issues as pivoting. The following points should be ensured to run
365365
a target cluster upgrade:
366366

0 commit comments

Comments
 (0)