Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide: first take at documenting IrSO #493

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

dtantsur
Copy link
Member

Signed-off-by: Dmitry Tantsur [email protected]

@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 24, 2024
@dtantsur dtantsur force-pushed the ironic-standalone-operator branch from f9ea033 to 436f879 Compare December 27, 2024 17:29
- Which physical network interface will be used for provisioning? Without any
configuration, Ironic will use the host cluster networking.

- If you use a dedicated network interface, are you going to use the built-in

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A little bit confused about this: if we have multiple control plane nodes, should we make sure one interface on each control plane node has an IP address (which means one ironic per control plane node using that IP address)? Shouldn't that IP address be the same, or shouldn't we have a proxy?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The role of keepalived is to maintain the same IP address, regardless of which node is hosting Ironic. I'll try to clarify a bit.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the bottom line is: Make sure you have a usable IP address on the control plane node hosting ironic. It's possible to use keepalived for this.
Its clearer now, thank you!

Copy link
Member

@lentzi90 lentzi90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

Comment on lines +22 to +26
git clone https://github.com/metal3-io/ironic-standalone-operator
cd ironic-standalone-operator
git checkout -b <DESIRED BRANCH OR main>

make install deploy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future we should start publishing the output of kustomize build as a release artifact so users can just do a kubectl apply -f [URL]. This is fine for now though, no need to change!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I totally agree. Do we already do it for CAPM3?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it is part of how CAPI expects things to work. So it is published as infrastructure-components.yaml on every release. That allows clusterctl init --infrastructure=metal3 to automatically find the latest and install it 🙂

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! So, we'll eventually need infrastructure-components.yaml to include IrSO as well (once we switch to it by default)?

docs/user-guide/src/irso/introduction.md Outdated Show resolved Hide resolved
docs/user-guide/src/irso/install-basics.md Outdated Show resolved Hide resolved
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides what is already mentioned by others, I don't see any major issues here. It is a solid first stab at documentation, thank you!

@dtantsur dtantsur force-pushed the ironic-standalone-operator branch from 436f879 to fb72493 Compare January 14, 2025 15:43
@dtantsur
Copy link
Member Author

Hopefully addresses all the comments. Also added information about versions.

@MahnoorAsghar
Copy link

LGTM!

Copy link
Member

@lentzi90 lentzi90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lentzi90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 15, 2025
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 15, 2025
@metal3-io-bot metal3-io-bot merged commit 9ba9b2b into metal3-io:main Jan 15, 2025
8 checks passed
@dtantsur dtantsur deleted the ironic-standalone-operator branch January 15, 2025 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants