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

📖 update clusterctl provider contract for clusterclass support #5582

Conversation

ykakarap
Copy link
Contributor

@ykakarap ykakarap commented Nov 4, 2021

What this PR does / why we need it:

This PR update the clusterctl provider contract for providers to opt into cluster class support.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 4, 2021
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

A few nits, but sounds good in general

docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

A couple of nits from my side
Q: should we update also documentation in https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html

docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
@ykakarap ykakarap force-pushed the clusterctl-provider-contract-update branch from c54f540 to 909a2fa Compare November 6, 2021 05:07
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/provider-contract.md Outdated Show resolved Hide resolved
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

lgtm pending addressing open comments

@ykakarap ykakarap force-pushed the clusterctl-provider-contract-update branch from 909a2fa to a8d56db Compare November 8, 2021 18:16
@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 8, 2021
@ykakarap
Copy link
Contributor Author

ykakarap commented Nov 8, 2021

The error in the "Broken Links" pipeline seems to be

ERROR: 1 dead links found!
[✖] #833 → Status: 0

This link is in the "Cluster Provider Spec and Status as CRDs" proposal doc and I believe the error is not related to changes in the current PR.

@fabriziopandini
Copy link
Member

If I'm not wrong the link is correct, might be a flake...

@sbueringer
Copy link
Member

/lgtm
Yeah looks correct. You can try a re-run by commit --amend + push --force

@ykakarap
Copy link
Contributor Author

ykakarap commented Nov 8, 2021

Yeah looks correct. You can try a re-run by commit --amend + push --force

I wonder if this will remove the lgtm label.
I believe someone with rights can just re-trigger the github workflow test form the UI.

@sbueringer
Copy link
Member

sbueringer commented Nov 9, 2021

Yeah looks correct. You can try a re-run by commit --amend + push --force

I wonder if this will remove the lgtm label. I believe someone with rights can just re-trigger the github workflow test form the UI.

Yup, it will remove them. Just suggested it because getting lgtm again shouldn't be a problem :)

I think someone with write or admin access to the repo should be able to restart the workflow.

@ykakarap ykakarap force-pushed the clusterctl-provider-contract-update branch from a8d56db to 141601b Compare November 10, 2021 00:55
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 10, 2021
@ykakarap
Copy link
Contributor Author

@sbueringer can you please LGTM again 🙏🏼
Hopefull the test doesn't flake this time :)

@sbueringer
Copy link
Member

Sure :)

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 10, 2021
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@ykakarap please give a PSA in the office hours about this documentation being available

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 10, 2021
@k8s-ci-robot k8s-ci-robot merged commit 8a0f11b into kubernetes-sigs:main Nov 10, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Nov 10, 2021
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants