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

[Docs] Clarify ClusterMesh troubleshooting steps when KVStoreMesh is enabled #27691

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

weizhoublue
Copy link
Contributor

@weizhoublue weizhoublue commented Aug 25, 2023

when the KVStoreMesh is on, I find the debug steps are not in line with the facts, the hostAliases does not exist in Cilium DaemonSet, but exist in the clustermesh-apiserver deployment

the chart code

apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: cilium
  namespace: {{ .Release.Namespace }}
  labels:
    k8s-app: cilium
    .....
      {{- if and .Values.clustermesh.useAPIServer .Values.clustermesh.config.enabled (not .Values.clustermesh.apiserver.kvstoremesh.enabled) }}
      hostAliases:
      {{- range $cluster := .Values.clustermesh.config.clusters }}
      {{- range $ip := $cluster.ips }}
      - ip: {{ $ip }}
        hostnames: [ "{{ $cluster.name }}.{{ $.Values.clustermesh.config.domain }}" ]
      {{- end }}
apiVersion: apps/v1
kind: Deployment
metadata:
  name: clustermesh-apiserver
  .......
      hostAliases:
      {{- range $cluster := .Values.clustermesh.config.clusters }}
      {{- range $ip := $cluster.ips }}
      - ip: {{ $ip }}
        hostnames: [ "{{ $cluster.name }}.{{ $.Values.clustermesh.config.domain }}" ]
      {{- end }}

and the remote cluster address does not exist in the secret cilium-clustermesh, but exist in the secret cilium-kvstoremesh

[root@master1 ~]# kubectl get secret -n kube-system cilium-clustermesh -o yaml | yq '.data' | awk '{print $2}' | base64 -d
endpoints:
- https://clustermesh-apiserver.kube-system.svc:2379
trusted-ca-file: /var/lib/cilium/clustermesh/common-etcd-client-ca.crt
key-file: /var/lib/cilium/clustermesh/common-etcd-client.key
cert-file: /var/lib/cilium/clustermesh/common-etcd-client.crt

[root@master1 ~]# kubectl get secret -n kube-system cilium-kvstoremesh -o yaml | yq '.data' | awk '{print $2}' | base64 -d
endpoints:
- https://cluster2.mesh.cilium.io:32379
trusted-ca-file: /var/lib/cilium/clustermesh/common-etcd-client-ca.crt
key-file: /var/lib/cilium/clustermesh/common-etcd-client.key
cert-file: /var/lib/cilium/clustermesh/common-etcd-client.crt

@weizhoublue weizhoublue requested a review from a team as a code owner August 25, 2023 06:26
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 25, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Aug 25, 2023
@lambdanis lambdanis self-assigned this Aug 25, 2023
@lambdanis lambdanis added release-note/misc This PR makes changes that have no direct user impact. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Aug 25, 2023
@lambdanis lambdanis requested review from a team and giorio94 and removed request for a team August 25, 2023 10:26
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

docs structure OK, but someone from @cilium/sig-clustermesh please review the content.

Copy link
Member

@giorio94 giorio94 left a comment

Choose a reason for hiding this comment

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

Looks good to me content wise. I know that there's some ongoing effort to revamp the clustermesh troubleshooting guide, but this improvement is definitely worth.

Documentation/operations/troubleshooting_clustermesh.rst Outdated Show resolved Hide resolved
@giorio94 giorio94 changed the title fix the ClusterMesh debug step when KVStoreMesh is enabled [Docs] Clarify ClusterMesh troubleshooting steps when KVStoreMesh is enabled Aug 25, 2023
@giorio94 giorio94 added the needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch label Aug 25, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.2 Aug 25, 2023
@lambdanis
Copy link
Contributor

/test

Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

@weizhoublue Could you maybe update the CODEOWNERS file to add sig-clustermesh as an owner of the docs you changed? That is:

Documentation/operations/troubleshooting_clustermesh.rst @cilium/sig-clustermesh @cilium/docs-structure

But it's only tangentially related to the change, so it's fine to merge the change as is IMO.

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 25, 2023
@weizhoublue weizhoublue requested a review from a team as a code owner August 25, 2023 11:06
@weizhoublue
Copy link
Contributor Author

@weizhoublue Could you maybe update the CODEOWNERS file to add sig-clustermesh as an owner of the docs you changed? That is:

Documentation/operations/troubleshooting_clustermesh.rst @cilium/sig-clustermesh @cilium/docs-structure

But it's only tangentially related to the change, so it's fine to merge the change as is IMO.

my pleasure, and updated

@giorio94
Copy link
Member

/test

@giorio94 giorio94 removed the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 25, 2023
@weizhoublue
Copy link
Contributor Author

weizhoublue commented Aug 25, 2023

the PR seems to have no business failing the connectivity test of the check
should I try to rebase the main branch ?

@lambdanis
Copy link
Contributor

@weizhoublue yeah, the CI fail seems completely unrelated, it shouldn't block the merge I think

@lambdanis
Copy link
Contributor

/test

@weizhoublue
Copy link
Contributor Author

some connectivity case failed, I try to rebase again

@lambdanis
Copy link
Contributor

/test

@lambdanis
Copy link
Contributor

@weizhoublue It was probably a flake, don't worry about it. The checks relevant to your change passed, so once there is an approve from contributing the PR can be merged.

@weizhoublue
Copy link
Contributor Author

@weizhoublue It was probably a flake, don't worry about it. The checks relevant to your change passed, so once there is an approve from contributing the PR can be merged.

thanks

@giorio94
Copy link
Member

giorio94 commented Sep 1, 2023

@weizhoublue It looks like this PR needs to be rebased to pick the latest CI changes

Signed-off-by: weizhou.lan@daocloud.io <weizhou.lan@daocloud.io>
@weizhoublue
Copy link
Contributor Author

@weizhoublue It looks like this PR needs to be rebased to pick the latest CI changes

ok

@lambdanis
Copy link
Contributor

/test

@michi-covalent michi-covalent added this to Needs backport from main in 1.14.3 Sep 9, 2023
@michi-covalent michi-covalent removed this from Needs backport from main in 1.14.2 Sep 9, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Sep 15, 2023
@julianwiedmann julianwiedmann added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Sep 18, 2023
@ldelossa ldelossa merged commit 300b297 into cilium:main Sep 19, 2023
61 checks passed
@giorio94 giorio94 mentioned this pull request Sep 26, 2023
22 tasks
@giorio94 giorio94 added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Sep 26, 2023
@aanm aanm added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Sep 29, 2023
@jrajahalme jrajahalme moved this from Needs backport from main to Backport done to v1.14 in 1.14.3 Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. kind/community-contribution This was a contribution made by a community member. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.14.3
Backport done to v1.14
Development

Successfully merging this pull request may close these issues.

None yet

7 participants