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.

Sign up for GitHub

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

Jump to bottom

Added info on ClusterClass use #385

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added info on ClusterClass use #385

wants to merge 1 commit into from

Conversation

p-strusiewiczsurmacki-mobica
Copy link

This PR introduces some basic info on how to use ClusterClass with CAPM3, and how to deploy example ClusterClass using Tilt.

Should be only merged after CAPM3 PR #1405 gets merged.

@metal3-io-bot metal3-io-bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 28, 2024
@metal3-io-bot
Copy link
Contributor

Hi @p-strusiewiczsurmacki-mobica. Thanks for your PR.

I'm waiting for a metal3-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@metal3-io-bot metal3-io-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 28, 2024
@p-strusiewiczsurmacki-mobica p-strusiewiczsurmacki-mobica mentioned this pull request Feb 28, 2024
Merged
@lentzi90
Copy link
Member

/ok-to-test
We have quite strict formatting rules so I expect to see some failures here. Hopefully it is not too hard to fix them

@metal3-io-bot metal3-io-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 29, 2024
lentzi90
lentzi90 reviewed Feb 29, 2024
View reviewed changes
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
Holding until the CAPM3 PR is merged
/hold

@metal3-io-bot metal3-io-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 29, 2024
@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 Feb 29, 2024
tuminoid
tuminoid reviewed Feb 29, 2024
View reviewed changes
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.

Some nits

docs/user-guide/src/capm3/clusterclass.md Outdated
@@ -0,0 +1,73 @@
# Using ClusterClass with CAPM3

ClusterClass is a feature of Cluster API that enables the cluster operators to create multiple clusters using a single general template. You can find detailed explanation of how to use a `ClusterClass` in the [Cluster API documentation](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210526-cluster-class-and-managed-topologies.md)
Copy link
Member

Choose a reason for hiding this comment

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

Line length is not (yet) enforced, but it would be appreciated if you could wrap them at 80.

Copy link
Author

Choose a reason for hiding this comment

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

Wrapped at 80 where possible (some URLs might be longer).

docs/user-guide/src/capm3/clusterclass.md Outdated
git clone https://github.com/metal3-io/cluster-api-provider-metal3.git
```

2. Generate Tilt settings that will enable ClusterClass support in CAPI.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
2. Generate Tilt settings that will enable ClusterClass support in CAPI.
1. Generate Tilt settings that will enable ClusterClass support in CAPI.

Auto numbering should work here, and avoids issue of mis-numbering.

Copy link
Author

Choose a reason for hiding this comment

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

Fixed :)

docs/user-guide/src/capm3/clusterclass.md Outdated
make tilt-settings-clusterclass
```

2. Start Tilt.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
2. Start Tilt.
1. Start Tilt.

...Like here, 2 should be 3.

Copy link
Author

Choose a reason for hiding this comment

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

Fixed :)

@p-strusiewiczsurmacki-mobica
Added info on ClusterClass use
131afef 
Signed-off-by: Patryk Strusiewicz-Surmacki <[email protected]>
@metal3-io-bot
Copy link
Contributor

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@metal3-io-bot metal3-io-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 23, 2024
Sunnatillo
Sunnatillo reviewed Jul 15, 2024
View reviewed changes
Copy link
Member

@Sunnatillo Sunnatillo left a comment

Choose a reason for hiding this comment

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

LGTM

@Sunnatillo
Copy link
Member

/remove-lifecycle stale

@metal3-io-bot metal3-io-bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tuminoid tuminoid tuminoid left review comments

@lentzi90 lentzi90 lentzi90 left review comments

@Sunnatillo Sunnatillo Sunnatillo left review comments

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@p-strusiewiczsurmacki-mobica @metal3-io-bot @lentzi90 @Sunnatillo @tuminoid