Skip to content

Commit b6200a9

Browse files
Merge pull request #549 from dtantsur/api-doc
User guide: link to IrSO rendered API reference
2 parents 1cab165 + 478f2fc commit b6200a9

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

docs/user-guide/src/irso/install-basics.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,10 @@ spec:
167167

168168
**NOTE:** when the DHCP range is not provided, IrSO will pick one for you. In
169169
this example, it will be `192.0.2.10 - 192.0.2.253`.
170+
171+
## What's next?
172+
173+
Check the [API reference][api-ref] (switch to the branch you're using) for
174+
all possible settings you can set on an Ironic object.
175+
176+
[api-ref]: https://github.com/metal3-io/ironic-standalone-operator/blob/main/docs/api.md#ironicspec

docs/user-guide/src/irso/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ kubectl wait --for=condition=Available --timeout=60s \
3030

3131
## API resources
3232

33-
IrSO uses two Custom Resources to manage an Ironic installation:
34-
35-
[Ironic](https://github.com/metal3-io/ironic-standalone-operator/blob/main/config/crd/bases/ironic.metal3.io_ironics.yaml)
36-
manages Ironic itself and all of its auxiliary services.
33+
IrSO uses the [Ironic][api-ref] custom resource to manage Ironic itself and all
34+
of its auxiliary services.
3735

3836
See [installing Ironic with IrSO](./install-basics.md) for information on how
3937
to use these resources.
4038

39+
[api-ref]: https://github.com/metal3-io/ironic-standalone-operator/blob/main/docs/api.md#ironic
40+
4141
## How is Ironic installed?
4242

4343
By default, IrSO installs Ironic as a single pod on a **control plane** node.

0 commit comments

Comments
 (0)