Adds first draft at a cluster debugging page #2736
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Could do with some more examples and screenshots
foot
changed the title
foot
commented
Sep 14, 2022
| - Check that the path the cluster definition was merged to is being reconciled by flux | ||
| - Check that there were no errors in the kustomization resource that applied the cluster definition | ||
| - There may be a k8s validation error like a bad namespace in the cluster definition | ||
| - The CAPI provider may not be installed |
There was a problem hiding this comment.
Suggested change
| - The CAPI provider may not be installed | |
| - The CAPI provider may not be installed resulting in a missing CRD error |
There was a problem hiding this comment.
How would they find this?
bigkevmcd
reviewed
Sep 14, 2022
| - Some providers like CAPD can be quite sensitive to your docker state | ||
| - make sure you don't have a lot of other old clusters running. | ||
| - Try a different cluster name, some old resources may not been cleaned up | ||
| - No CNI may have been installed on your clusters. Make sure a ClusterResourceSet is configured to do this. |
There was a problem hiding this comment.
We can link to the documentation for this?
|
|
||
| - Check the logs of the capi controllers, it may be failing to create the cluster | ||
| - Some providers like CAPD can be quite sensitive to your docker state | ||
| - make sure you don't have a lot of other old clusters running. |
There was a problem hiding this comment.
How about we provide instructions?
| - Check the logs of the capi controllers, it may be failing to create the cluster | ||
| - Some providers like CAPD can be quite sensitive to your docker state | ||
| - make sure you don't have a lot of other old clusters running. | ||
| - Try a different cluster name, some old resources may not been cleaned up |
There was a problem hiding this comment.
How can they check this?
| - Check that the path the cluster definition was merged to is being reconciled by flux | ||
| - Check that there were no errors in the kustomization resource that applied the cluster definition | ||
| - There may be a k8s validation error like a bad namespace in the cluster definition | ||
| - The CAPI provider may not be installed |
There was a problem hiding this comment.
How about we link to the documentation that explains how to install CAPI providers?
|
|
||
| ## Cluster does not appear in the UI after merging the PR | ||
|
|
||
| - Check that the path the cluster definition was merged to is being reconciled by flux |
There was a problem hiding this comment.
Can we provide instructions here?
| ## Cluster does not appear in the UI after merging the PR | ||
|
|
||
| - Check that the path the cluster definition was merged to is being reconciled by flux | ||
| - Check that there were no errors in the kustomization resource that applied the cluster definition |
There was a problem hiding this comment.
Can we provide an appropriate kubectl command for users to run?
| - Check that the path the cluster definition was merged to is being reconciled by flux | ||
| - Check that there were no errors in the kustomization resource that applied the cluster definition | ||
| - There may be a k8s validation error like a bad namespace in the cluster definition | ||
| - The CAPI provider may not be installed |
There was a problem hiding this comment.
How would they find this?
|
|
||
| ## Cluster does not transition to ready | ||
|
|
||
| - Check the logs of the capi controllers, it may be failing to create the cluster |
There was a problem hiding this comment.
Let's include an appropriate kubectl command to get these logs?
|
|
||
| ## x509: certificate signed by unknown authority error on Applications/Sources page | ||
|
|
||
| - You may have an old load balancer from a previous cluster, delete it and recreate the cluster |
There was a problem hiding this comment.
"recreate the cluster" is a pretty harsh fix?
saeedfazal
reviewed
Sep 14, 2022
| - Bootstrapping may have failed | ||
| - No ClusterBootstrapConfiguration may be loaded into the cluster | ||
| - Check the github repo to see if flux has made a commit to bootstrap the new cluster | ||
| - Check the logs of the pods of the bootstrap job. They are named `default/run-gitops-${cluster-name}`, flux may have failed to clone the repo. |
There was a problem hiding this comment.
The bootstrap jobs are created in the same name space as of CAPI cluster namespace
ranatrk
reviewed
Sep 14, 2022
|
|
||
| Lets work through some common steps when a cluster is not behaving as expected | ||
|
|
||
| ## Pull request did not appear in github/gitlab |
There was a problem hiding this comment.
could github/gitlab permissions also affect this?
|
@foot Do you still want to go forward with this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why was this change made?
To help users figure out cluster issues when someone is not around to chat to