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

Fix bug in Member Exists Join for Kubeadm etcd join #97372

Merged
merged 1 commit into from Jan 14, 2021

Conversation

ihgann
Copy link
Contributor

@ihgann ihgann commented Dec 17, 2020

What type of PR is this?

/kind bug

What this PR does / why we need it:

In kubeadm etcd join there is a a bug that exists where,
if a peer already exists in etcd, it attempts to mitigate
by continuing and generating the etcd manifest file. However,
this existing "member name" may actually be unset, causing
subsequent etcd consistency checks to fail.

This change checks if the member name is empty - if it is,
it sets the member name to the node name, and resumes.

Which issue(s) this PR fixes:

No issue filed (found internally). However, a summary of the issue is as such:

When running kubeadm join phase control-plane-join etcd ..., on a potentially very slow machine, the original join would time out, and a subsequent attempt might occur. In this subsequent attempt, the resulting etcd manifest file may have an erroneous setup where the node name is missing in the --initial-cluster field;

    - --initial-cluster=422646179bda93c41a8dffdb3f18d7cf=https://10.192.179.175:2380,=https://10.192.175.85:2380,42260c0581b89af2fe9aaf27c2f92f68=https://10.192.172.211:2380

Notice the second entry (after the first ,), which specifies =https://10.192.175.85:2380.

This change forces this node name to never be empty.

Special notes for your reviewer:

@neolit123 is aware of this issue.

Does this PR introduce a user-facing change?:

kubeadm: fix a bug where "kubeadm join" would not properly handle missing names for existing etcd members.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

NONE

In kubeadm etcd join there is a a bug that exists where,
if a peer already exists in etcd, it attempts to mitigate
by continuing and generating the etcd manifest file. However,
this existing "member name" may actually be unset, causing
subsequent etcd consistency checks to fail.

This change checks if the member name is empty - if it is,
it sets the member name to the node name, and resumes.
@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 17, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @ihgann!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 17, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @ihgann. Thanks for your PR.

I'm waiting for a kubernetes 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 area/kubeadm sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Dec 17, 2020
@ihgann
Copy link
Contributor Author

ihgann commented Dec 17, 2020

cc @neolit123, please review when you get a chance!

@bl-ue
Copy link
Contributor

bl-ue commented Dec 17, 2020

/cc @neolit123

@pacoxu
Copy link
Member

pacoxu commented Dec 21, 2020

/ok-to-test
IMO, this need a release note like fix missing etcd member name for kubeadm join

@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 Dec 21, 2020
@bl-ue
Copy link
Contributor

bl-ue commented Dec 21, 2020

/test pull-kubernetes-bazel-test

Copy link
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

@ihgann
the change seems good to me.

/triage accepted
/priority important-soon

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Dec 21, 2020
@neolit123
Copy link
Member

@ihgann

as @pacoxu noted, in the PR description instead of NONE under "User facing..." add something like the following:

kubeadm: fix a bug where "kubeadm join" would not properly handle missing names for existing etcd members.

this will allow backporting the change to 1.18+ (1.17 is no longer released).

@neolit123
Copy link
Member

actually 1.17 was still released but today was it's last version:
https://groups.google.com/d/msgid/kubernetes-dev/CAOxYG4zCaXECbSVuAHGYAqtvHvz7ePYa0iw%2BtSFsp_pXcYAbeA%40mail.gmail.com?utm_medium=email&utm_source=footer

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Jan 14, 2021
@ihgann
Copy link
Contributor Author

ihgann commented Jan 14, 2021

@pacoxu @neolit123 I've added the release note.

@neolit123
Copy link
Member

@ihgann
please change the release note to the one i've mentioned earlier:

kubeadm: fix a bug where "kubeadm join" would not properly handle missing names for existing etcd members.

if you want to backport this change please use the cherry pick process documented here:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-release/cherry-picks.md#initiate-a-cherry-pick
the tool is easy to use.

note that we can only target release-1.18 as the minimum, and if you want this change in 1.17 you'd have to carry the patch locally in your setup.

@ihgann
Copy link
Contributor Author

ihgann commented Jan 14, 2021

@neolit123 Fixed. Locally I will cherry-pick for our 1.17 branches.

@neolit123
Copy link
Member

thanks
/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ihgann, neolit123

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 Jan 14, 2021
@k8s-ci-robot k8s-ci-robot merged commit 4a595bd into kubernetes:master Jan 14, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Jan 14, 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. area/kubeadm cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. 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. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants