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

Add initial metal3 quickstart #99

Merged
merged 1 commit into from
Feb 14, 2024
Merged

Conversation

hardys
Copy link
Contributor

@hardys hardys commented Feb 8, 2024

@agracey this is still WIP but wanted to push it up for initial review so we can collaborate

Copy link

netlify bot commented Feb 8, 2024

Deploy Preview for edge-misc ready!

Name Link
🔨 Latest commit 783da99
🔍 Latest deploy log https://app.netlify.com/sites/edge-misc/deploys/65c50fc0a5e1e70008ba9377
😎 Deploy Preview https://deploy-preview-99--edge-misc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hardys hardys changed the title [WIP] docs/quickstart/metal3.md [WIP] Add metal3 quickstart Feb 8, 2024
@hardys hardys requested a review from agracey February 8, 2024 17:31
@hardys hardys marked this pull request as draft February 8, 2024 17:31
The basic steps to install and use Metal<sup>3</sup> are:

- Install an RKE2 management cluster
- Install Rancher
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rancher isn't strictly a dependency atm, but if in future we want to enable rancher integration e.g via the turtles UI this will be needed, shall I remove this for now or leave it?

@agracey
Copy link
Contributor

agracey commented Feb 12, 2024

Would you mind if we went ahead and merged while in this state so we can review and edit in smaller chunks? I just did the same with my quickstarts for EIB and Elemental.

Copy link
Contributor

@agracey agracey left a comment

Choose a reason for hiding this comment

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

I think we should go ahead and merge this. That way we can more easily divide the work without having to deal with merging across branches

- Must support deployment via virtualmedia (PXE is not currently supported)
- Must have network connectivity to the Management cluster for access to the Metal<sup>3</sup> provisioning APIs

TODO we need a more detailed support matrix of vendors and BMC firmware versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this something that we inherit directly from upstream?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes and no - we inherit the specific Ironic drivers that are enabled in our configuration, but that's not the same as having a validated support matrix from a product perspective.

credentialsName: controlplane-0-credentials
```

Note the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

Once we switch to asciidoc, this should be a admonition/callout block

In this mode the endpoint for the management cluster APIs is the IP of the management cluster, thus is should be either reserved when using DHCP
or statically configured.

TODO example of how to do this with NodePort, if we want to include it in the docs?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think NodePort makes sense for single nodes and reduces the complexity for dev/test usage.

@hardys
Copy link
Contributor Author

hardys commented Feb 13, 2024

Would you mind if we went ahead and merged while in this state so we can review and edit in smaller chunks? I just did the same with my quickstarts for EIB and Elemental.

Yes that's fine with me, I'm happy to contribute further content as follow-ups but it will definitely be easier if we do it as a series of smaller changes.

@hardys hardys marked this pull request as ready for review February 14, 2024 10:29
@hardys hardys changed the title [WIP] Add metal3 quickstart Add initial metal3 quickstart Feb 14, 2024
@agracey agracey merged commit 29f0f9c into suse-edge:main Feb 14, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants