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

Remediation test doc issue in v1.3 to v1.4 upgrade docs #8499

Closed
willie-yao opened this issue Apr 8, 2023 · 2 comments · Fixed by #8511
Closed

Remediation test doc issue in v1.3 to v1.4 upgrade docs #8499

willie-yao opened this issue Apr 8, 2023 · 2 comments · Fixed by #8511
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@willie-yao
Copy link
Contributor

What steps did you take and what happened?

Link to docs:
https://cluster-api.sigs.k8s.io/developer/providers/v1.3-to-v1.4.html#other

A new KCPRemediationSpec test has been added providing better test coverage for KCP remediation most common use cases. As a consequence MachineRemediationSpec now only tests remediation of worker machines (NOTE: we plan to improve this test as well in a future iteration).

What did you expect to happen?

MachineRemediationSpec should be changed to MachineDeploymentRemediationSpec. This could cause some confusion with providers updating their CAPI tests to 1.4.

New proposed bullet point:

A new KCPRemediationSpec test has been added providing better test coverage for KCP remediation most common use cases. As a consequence MachineRemediationSpec has been renamed to MachineDeploymentRemediationSpec and now only tests remediation of worker machines (NOTE: we plan to improve this test as well in a future iteration).

Cluster API version

1.4

Kubernetes version

No response

Anything else you would like to add?

No response

Label(s) to be applied

/kind bug
One or more /area label. See https://github.com/kubernetes-sigs/cluster-api/labels?q=area for the list of labels.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 8, 2023
@willie-yao
Copy link
Contributor Author

/assign

@fabriziopandini
Copy link
Member

/triage accepted
/kind documentation

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/documentation Categorizes issue or PR as related to documentation. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants