Miscellaneous improvements to the clustermesh troubleshooting guide #32552
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
Document the usage of the newly introduced troubleshoot command to investigate connectivity issues towards the clustermesh control plane (i.e., etcd) in remote clusters. Signed-off-by: Marco Iorio <marco.iorio@isovalent.com>
giorio94
added
area/documentation
When KVStoreMesh is enabled, this component is responsible for connecting to the remote clusters. Document the command which can be used to inspect its status and validate whether connection are established correctly. Signed-off-by: Marco Iorio <marco.iorio@isovalent.com>
Add a clarification note that the manual steps presented in the guide are mostly alternative to using the automatic tools described in the previous section. Additionally, drop the example errors from the TLS certificates step, as potentially misleading. Users shall leverage the troubleshoot command instead. Finally, let's fix a couple of typos. Signed-off-by: Marco Iorio <marco.iorio@isovalent.com>
They apply only when Cilium is configured in kvstore mode, which is seldom the case these days. The lack of local information is also not clustermesh specific, and would imply other serious issues. Moreover, the given checks would not work, and lead to additional confusion when Cilium operates in CRD mode. Hence, let's just replace them with the suggestion of checking whether both Cilium agents and KVStoreMesh (if enabled) are correctly connected to all remote clusters, and the synchronization has completed. Signed-off-by: Marco Iorio <marco.iorio@isovalent.com>
giorio94
force-pushed
the
mio/clustermesh-troubleshoot-docs
branch
from
61ece3b
to
c2d4454
Compare
qmonnet
approved these changes
May 15, 2024
|
/test |
YutaroHayakawa
approved these changes
May 16, 2024
maintainer-s-little-helper
bot
added
the
ready-to-merge
giorio94
added
backport-pending/1.15
giorio94
added
backport-pending/1.14
giorio94
added
backport-pending/1.13
github-actions
bot
added
backport-done/1.15
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.
Improve the clustermesh troubleshooting guide:
troubleshootcommand to automatically perform sanity checks;Please refer to the individual commit descriptions for additional details.
I'm marking this PR for backport to all stable versions to match #32336. Marking as backport/author as well to perform the necessary adaptations based on the features available in each version.