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

[kubeadm control plane] documentation #2244

Closed
chuckha opened this issue Jan 31, 2020 · 6 comments · Fixed by #2607
Closed

[kubeadm control plane] documentation #2244

chuckha opened this issue Jan 31, 2020 · 6 comments · Fixed by #2607
Assignees
@chuckha
Labels
area/control-plane Issues or PRs related to control-plane lifecycle management kind/documentation Categorizes issue or PR as related to documentation. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone
v0.3

Comments

@chuckha
Copy link
Contributor

chuckha commented Jan 31, 2020

User Story

We need to shape up our documentation story by the end of the milestone.

Detailed Description

We need to have

  • Quickstart
    • An example of a KubeadmControlPlane
  • How to scale up
  • How to scale down
  • How to upgrade
  • How to fix a damaged node by deleting it
  • How to implement a control plane provider

/kind documentation
/milestone v0.3.0
/priority important-soon
@k8s-ci-robot k8s-ci-robot added this to the v0.3.0 milestone Jan 31, 2020
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Jan 31, 2020
@chuckha chuckha mentioned this issue Jan 31, 2020
Closed
33 tasks
@ncdc ncdc mentioned this issue Mar 2, 2020
Closed
@ncdc
Copy link
Contributor

ncdc commented Mar 2, 2020

Didn't realize this was here when I filed #2466. Copying what I wrote over there:

Document the steps for upgrading workload cluster using KubeadmControlPlane, including:

  • An overview of the process (control plane first, then workers)
  • How to change the version for the control plane
  • How to change the OS image (OVA, AMI, etc) for the control plane machines
  • How to change the version & OS image for MachineDeployments, MachineSets
  • Mention that we recommend MachineDeployments over standalone Machines or MachineSets and why
  • Mention that standalone Machines will need to be deleted and recreated

@vincepri
Copy link
Member

vincepri commented Mar 2, 2020

/area control-plane

@k8s-ci-robot k8s-ci-robot added the area/control-plane Issues or PRs related to control-plane lifecycle management label Mar 2, 2020
@chuckha
Copy link
Contributor Author

chuckha commented Mar 9, 2020

I'll pick this up

/assign
/lifecycle active

@k8s-ci-robot k8s-ci-robot added the lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. label Mar 9, 2020
@chuckha
Copy link
Contributor Author

chuckha commented Mar 9, 2020

@ncdc

How to change the version & OS image for MachineDeployments, MachineSets
Mention that we recommend MachineDeployments over standalone Machines or MachineSets and why
Mention that standalone Machines will need to be deleted and recreated

I'm a little confused as to why these are included. In my mind they don't relate to the control plane and should be covered by the machine deployment documentation, but I'm curious about your thinking. Can you expand on what you'd like to see relating to these bullet points and how they relate to the kubeadm control plane?

@ncdc
Copy link
Contributor

ncdc commented Mar 9, 2020

The MD & MS bits were for general upgrades. If your goal is to upgrade a cluster, you'd want to know how to do the control plane and the workers. I think our documentation organization likely needs improvement (#2146) and if you want to focus on just the control plane aspect for now, 👍.

@vincepri
Copy link
Member

vincepri commented Mar 9, 2020

/milestone v0.3.x

@k8s-ci-robot k8s-ci-robot modified the milestones: v0.3.0, v0.3.x Mar 9, 2020
@chuckha chuckha mentioned this issue Mar 9, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chuckha chuckha

Labels
area/control-plane Issues or PRs related to control-plane lifecycle management kind/documentation Categorizes issue or PR as related to documentation. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
v0.3
Development

Successfully merging a pull request may close this issue.

📖 Add documentation around KubeadmControlPlane chuckha/cluster-api
4 participants
@ncdc @chuckha @vincepri @k8s-ci-robot