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

📖 Update controlplane example in book #6392

Merged
merged 1 commit into from
Apr 20, 2022
Merged

📖 Update controlplane example in book #6392

merged 1 commit into from
Apr 20, 2022

Conversation

killianmuldoon
Copy link
Contributor

Signed-off-by: killianmuldoon [email protected]

Update a v1alpha3 example of a KubeadmControlPlane in the controllers part of the CAPI book

@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 Apr 7, 2022
killianmuldoon
killianmuldoon commented Apr 7, 2022
View reviewed changes
Copy link
Contributor Author

@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.

I'll open a help wanted issue to get more people to review the docs and update the examples. A quick search shows there's still a number of v1alpha3 examples in the book.

@killianmuldoon killianmuldoon mentioned this pull request Apr 7, 2022
Merged
@killianmuldoon killianmuldoon changed the title Update controlplane example in book 📖 Update controlplane example in book Apr 7, 2022
JoelSpeed
JoelSpeed reviewed Apr 8, 2022
View reviewed changes
docs/book/src/developer/architecture/controllers/control-plane.md Outdated
namespace: default
spec:
kubeadmConfigSpec:
clusterConfiguration:
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this key empty, is that valid yaml?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's not valid yaml - it's like this because I didn't want to change anything unnecessarily from the previous example unless there was some reason. I think this is really an example structure so it doesn't have to be valid yaml or anything like that.

I've removed this:

       kubeadmConfigSpec:
        clusterConfiguration:

completely now as it's not part of the contract so I don't think it adds anything to the expected shape of a control plane object.

@killianmuldoon killianmuldoon force-pushed the docs/update-controlplane-example branch 2 times, most recently from 3de492a to defbdc2 Compare April 8, 2022 09:15
JoelSpeed
JoelSpeed reviewed Apr 11, 2022
View reviewed changes
Copy link
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 11, 2022
alexander-demicev
alexander-demicev approved these changes Apr 11, 2022
View reviewed changes
Copy link
Contributor

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

/lgtm

chrischdi
chrischdi reviewed Apr 14, 2022
View reviewed changes
docs/book/src/developer/architecture/controllers/control-plane.md Outdated
Comment on lines 233 to 234
apiVersion: v1
items:
Copy link
Member

Choose a reason for hiding this comment

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

Why using the list here compared to previous example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch - I'll fix this up.

@killianmuldoon killianmuldoon force-pushed the docs/update-controlplane-example branch from defbdc2 to 4b9815c Compare April 14, 2022 13:19
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed 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. labels Apr 14, 2022
chrischdi
chrischdi reviewed Apr 14, 2022
View reviewed changes
Copy link
Member

@chrischdi chrischdi left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 14, 2022
fabriziopandini
fabriziopandini reviewed Apr 20, 2022
View reviewed changes
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

@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 Apr 20, 2022
@fabriziopandini
Copy link
Member

/cherry-pick release-1.1

@k8s-infra-cherrypick-robot
Copy link

@fabriziopandini: once the present PR merges, I will cherry-pick it on top of release-1.1 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.1

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.

@k8s-ci-robot k8s-ci-robot merged commit f202f9d into kubernetes-sigs:main Apr 20, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Apr 20, 2022
@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Apr 20, 2022
Merged
@k8s-infra-cherrypick-robot
Copy link

@fabriziopandini: new pull request created: #6427

In response to this:

/cherry-pick release-1.1

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoelSpeed JoelSpeed JoelSpeed left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@chrischdi chrischdi chrischdi left review comments

@alexander-demicev alexander-demicev alexander-demicev approved these changes

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@chrischdi chrischdi

@fabriziopandini fabriziopandini

@JoelSpeed JoelSpeed

@alexander-demicev alexander-demicev

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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v1.2
Development

Successfully merging this pull request may close these issues.
7 participants
@killianmuldoon @k8s-ci-robot @fabriziopandini @k8s-infra-cherrypick-robot @chrischdi @JoelSpeed @alexander-demicev