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

📖 doc: add node bootstrap troubleshooting doc #4627

Merged

Conversation

sbueringer
Copy link
Member

What this PR does / why we need it:
Adds some guidance how node bootstrap failures can be debugged.

xref: #4583 (comment)

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 -

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 17, 2021
@sbueringer
Copy link
Member Author

/cc @vincepri

@k8s-ci-robot k8s-ci-robot requested a review from vincepri May 17, 2021 18:40
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 17, 2021
@@ -1,5 +1,23 @@
# Troubleshooting

## Node bootstrap failures

Failures during Node bootstrapping can have a lot of different causes. For example, ClusterAPI resources might be
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Failures during Node bootstrapping can have a lot of different causes. For example, ClusterAPI resources might be
Failures during Node bootstrapping can have a lot of different causes. For example, Cluster API resources might be

1. Kubelet: `journalctl -u kubelet --since "1 day ago"`
(Note: it might be helpful to increase the Kubelet log level by e.g. setting `--v=8` via
`systemctl edit --full kubelet && systemctl restart kubelet`)
1. If Node bootstrapping consistently fails and the kubeadm logs are not verbose enough, the `kubeadm` verbosity
Copy link
Contributor

Choose a reason for hiding this comment

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

this section assumes cloud-init and kubeadm which does not apply to all bootstrap providers, maybe add something like "when using CABPK" at the top or as a separate header

@fabriziopandini
Copy link
Member

Thanks for this write up! It will super helpful to have something where to redirect users in case of problems.
/approve

(lgtm pending comments above to be addressed)

@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 May 18, 2021
@sbueringer sbueringer force-pushed the pr-add-troubleshooting-doc branch from 46efeb2 to 36bae1a Compare May 18, 2021 17:30
@sbueringer
Copy link
Member Author

@fabriziopandini @CecileRobertMichon ptal. I added it to the section title.

Copy link
Contributor

@CecileRobertMichon CecileRobertMichon 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 May 18, 2021
@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot merged commit 9a69d3b into kubernetes-sigs:master May 18, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone May 18, 2021
@sbueringer sbueringer deleted the pr-add-troubleshooting-doc branch May 24, 2021 19:29
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. 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
Development

Successfully merging this pull request may close these issues.

4 participants