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 concepts docs around v1alpha3 #3522

Merged
merged 1 commit into from
Aug 25, 2020
Merged

📖 Update concepts docs around v1alpha3 #3522

merged 1 commit into from
Aug 25, 2020

Conversation

joshrosso
Copy link
Contributor

What this PR does / why we need it:
This upgrades the diagram to include the control plane and machinehealthcheck objects. It also adds some context around the inner-workings of kubeadmcontrolplane.

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 #3097

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 24, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @joshrosso. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 24, 2020
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 24, 2020
JoelSpeed
JoelSpeed reviewed Aug 24, 2020
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.

How comes the management cluster SVG has been updated? I would expect to see plantuml changes accompanying any update to that SVG

@fabriziopandini
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot 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 Aug 24, 2020
fabriziopandini
fabriziopandini reviewed Aug 24, 2020
View reviewed changes
docs/book/src/user/concepts.md Show resolved Hide resolved
docs/book/src/user/concepts.md Outdated Show resolved Hide resolved
@joshrosso
Copy link
Contributor Author

@JoelSpeed : The PlantUML was not edited because this svg was not created as a .plantuml.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 24, 2020
randomvariable
randomvariable reviewed Aug 24, 2020
View reviewed changes
docs/book/src/user/concepts.md Outdated
As of v1alpha2, __Machine-Based__ is the only control plane type that Cluster API supports.
As of v1alpha2, __Machine-Based__ is the only control plane type that Cluster API supports.

As of v1alpha3, the default provider uses kubeadm to bootstrap the control plane. It exposes the configuration via the `kubeadmcontrolplane` object. The controller, `capi-kubeadm-control-plane-controller-manager`, can then create Machine and BootstrapConfig objects based on the requested replicas in the `kubeadmcontrolplanes` object.
Copy link
Member

Choose a reason for hiding this comment

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

"As of v1alpha3, the default provider uses kubeadm to bootstrap the control plane"
is kind of misleading because in a sense, we always were using kubeadm to bootstrap the control plane, there was just no "stateful set" type of controller to manage it - you'd create individual machines with kubeadmconfigs and manage the overall control plane yourself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@randomvariable, great point.

The latter sentence around Kubeadmcontrolplane and capi-kubeadm-control-plane-controller-manager was more what I was trying to qualify v1alpha3 🤔. Let me move that qualifier around.

Copy link
Contributor Author

@joshrosso joshrosso Aug 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@randomvariable, watchu think about this revision?

Copy link
Member

Choose a reason for hiding this comment

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

Think that works.

@vincepri vincepri changed the title 📖, update concepts docs around v1alpha3 📖 Update concepts docs around v1alpha3 Aug 24, 2020
vincepri
vincepri approved these changes Aug 24, 2020
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 Aug 24, 2020
@fabriziopandini
Copy link
Member

lgtm pending squash

@joshrosso
docs: update concepts doc to inlcude v1alpha 3 schema
918d58a 
callout kubeadmcp provider as v1alpha3

This upgrades the diagram to include the control plane and
machinehealthcheck objects. It also adds some context around the
inner-workings of kubeadmcontrolplane.
@joshrosso
Copy link
Contributor Author

@fabriziopandini squashed

@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 Aug 25, 2020
@k8s-ci-robot k8s-ci-robot merged commit bf3f571 into kubernetes-sigs:master Aug 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@randomvariable randomvariable randomvariable left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@JoelSpeed JoelSpeed JoelSpeed left review comments

@vincepri vincepri vincepri approved these changes

Assignees

@fabriziopandini fabriziopandini

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document control-plane-controller in Concepts docs
6 participants
@joshrosso @k8s-ci-robot @fabriziopandini @randomvariable @vincepri @JoelSpeed