docs: Add section for Kiali and distributed tracing OpenShift integration #328

josunect · 2024-08-30T08:47:20Z

Add new section in the docs for Kiali and distributed tracing OpenShift integration.

Fixes #324

linux-foundation-easycla · 2024-08-30T08:47:24Z

The committers listed above are authorized under a signed CLA.

✅ login: josunect / name: Josune Cordoba (ce47f08, f245ca0, 7218ad5, 315c111, a747c6e)

istio-testing · 2024-08-30T08:47:37Z

Hi @josunect. Thanks for your PR.

I'm waiting for a istio-ecosystem or istio 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-sigs/prow repository.

nrfox · 2024-08-30T12:47:50Z

/ok-to-test

nrfox · 2024-08-30T12:54:35Z

docs/README.md

@@ -30,6 +30,7 @@
  - [Scraping metrics using the OpenShift monitoring stack](#scraping-metrics-using-the-openshift-monitoring-stack)
  - [Integrating with Kiali](#integrating-with-kiali)
    - [Integrating Kiali with the OpenShift monitoring stack](#integrating-kiali-with-the-openshift-monitoring-stack)
+    - [Integrating Kiali with OpenShift distributed tracing](#integrating-kiali-with-openshift-distributed-tracing)


Could you separate configuring Istio and configuring Kiali into two separate sections? Something like

- [Configure tracing with OpenShift distributed tracing](...) - [Integrating with Kiali](...) - [Integrating with the OpenShift monitoring stack](...) - [Integrating with OpenShift distributed tracing](...)

If you split them up you'll probably need a verification step for Istio which can be 1. generating some traffic and then 2. opening the tracing UI to see traces.

docs/README.md

nrfox · 2024-08-30T13:04:52Z

docs/README.md

+          datasource_uid: "a8d2ef1c-d31c-4de5-a90b-e7bc5252cd00" 
+    ```
+
+There is a specific section to setup the Grafana datasource in the Tempo config.


Should there be more instructions for this here?

nrfox · 2024-08-30T13:05:45Z

docs/README.md

+
+There is a specific section to setup the Grafana datasource in the Tempo config.
+
+Now, we should be able to see traces from Kiali.


Can you add a section on what the user should do to see traces in Kiali?

@nrfox I have rewritten these sections, see if it makes more sense now

docs/README.md

nrfox · 2024-09-09T11:13:22Z

docs/README.md

+kubectl create ns bookinfo
+kubectl label ns bookinfo istio-injection=enabled


These steps don't actually deploy bookinfo? I think elsewhere we already describe how to deploy bookinfo. Maybe you can just link to that and assume here that you've already deployed it?

Yes, right, it is linked now.

nrfox · 2024-09-09T11:52:37Z

docs/README.md

+4. Validate the integration: See the traces in the UI
+
+```sh
+kubectl get routes -n tempo tempo-sample-query-frontend-tempo.apps-crc.testing


Is this the actual name of the route object? tempo-sample-query-frontend-tempo.apps-crc.testing

This part .apps-crc.testing seems like a typo?

good catch! Updated now

josunect · 2024-09-09T13:23:47Z

/retest

Signed-off-by: josunect <josune.cordoba@gmail.com>

Co-authored-by: Nick Fox <nick@nrfox.com> Create a new section Signed-off-by: josunect <josune.cordoba@gmail.com>

Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: josunect <josune.cordoba@gmail.com>

Signed-off-by: josunect <josune.cordoba@gmail.com>

* upstream/main: docs: Add section for Kiali and distributed tracing OpenShift integration (istio-ecosystem#328)

…tion (istio-ecosystem#328) * Add tracing docs Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Create a new section Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: josunect <josune.cordoba@gmail.com> * Link to install bookinfo Signed-off-by: josunect <josune.cordoba@gmail.com> * Update route Signed-off-by: josunect <josune.cordoba@gmail.com> --------- Signed-off-by: josunect <josune.cordoba@gmail.com> Co-authored-by: Nick Fox <nick@nrfox.com>

…tion (istio-ecosystem#328) * Add tracing docs Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Create a new section Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: josunect <josune.cordoba@gmail.com> * Link to install bookinfo Signed-off-by: josunect <josune.cordoba@gmail.com> * Update route Signed-off-by: josunect <josune.cordoba@gmail.com> --------- Signed-off-by: josunect <josune.cordoba@gmail.com> Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: bmangoen <bmangoen@redhat.com>

…tion (istio-ecosystem#328) * Add tracing docs Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Create a new section Signed-off-by: josunect <josune.cordoba@gmail.com> * Update docs/README.md Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: josunect <josune.cordoba@gmail.com> * Link to install bookinfo Signed-off-by: josunect <josune.cordoba@gmail.com> * Update route Signed-off-by: josunect <josune.cordoba@gmail.com> --------- Signed-off-by: josunect <josune.cordoba@gmail.com> Co-authored-by: Nick Fox <nick@nrfox.com>

istio-testing added the do-not-merge/work-in-progress label Aug 30, 2024

istio-testing added the size/M label Aug 30, 2024

istio-testing added the needs-ok-to-test label Aug 30, 2024

josunect force-pushed the issue324_tracing_docs branch from 3507890 to 0314c55 Compare August 30, 2024 12:19

josunect marked this pull request as ready for review August 30, 2024 12:37

josunect requested a review from a team as a code owner August 30, 2024 12:37

istio-testing removed the do-not-merge/work-in-progress label Aug 30, 2024

istio-testing added ok-to-test and removed needs-ok-to-test labels Aug 30, 2024

nrfox reviewed Aug 30, 2024

View reviewed changes

josunect force-pushed the issue324_tracing_docs branch from b749290 to 08345eb Compare August 30, 2024 14:31

josunect requested a review from nrfox September 2, 2024 07:10

nrfox reviewed Sep 9, 2024

View reviewed changes

josunect force-pushed the issue324_tracing_docs branch from 749f42c to 9236398 Compare September 9, 2024 11:36

josunect requested a review from nrfox September 9, 2024 11:44

nrfox reviewed Sep 9, 2024

View reviewed changes

nrfox approved these changes Sep 9, 2024

View reviewed changes

josunect and others added 5 commits September 9, 2024 15:44

Add tracing docs

ce47f08

Signed-off-by: josunect <josune.cordoba@gmail.com>

Update docs/README.md

f245ca0

Co-authored-by: Nick Fox <nick@nrfox.com> Create a new section Signed-off-by: josunect <josune.cordoba@gmail.com>

Update docs/README.md

a747c6e

Co-authored-by: Nick Fox <nick@nrfox.com> Signed-off-by: josunect <josune.cordoba@gmail.com>

Link to install bookinfo

7218ad5

Signed-off-by: josunect <josune.cordoba@gmail.com>

Update route

315c111

Signed-off-by: josunect <josune.cordoba@gmail.com>

josunect force-pushed the issue324_tracing_docs branch from f1611de to 315c111 Compare September 9, 2024 14:44

istio-testing merged commit e1e581d into istio-ecosystem:main Sep 9, 2024
12 checks passed

openshift-service-mesh-bot pushed a commit to openshift-service-mesh-bot/sail-operator that referenced this pull request Sep 9, 2024

Automated merge

19c0f50

* upstream/main: docs: Add section for Kiali and distributed tracing OpenShift integration (istio-ecosystem#328)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add section for Kiali and distributed tracing OpenShift integration #328

docs: Add section for Kiali and distributed tracing OpenShift integration #328

josunect commented Aug 30, 2024

linux-foundation-easycla bot commented Aug 30, 2024 •

edited

Loading

istio-testing commented Aug 30, 2024

nrfox commented Aug 30, 2024

nrfox Aug 30, 2024

nrfox Aug 30, 2024

nrfox Aug 30, 2024

nrfox Aug 30, 2024

josunect Aug 30, 2024

nrfox Sep 9, 2024

josunect Sep 9, 2024

nrfox Sep 9, 2024 •

edited

Loading

nrfox Sep 9, 2024

josunect Sep 9, 2024

josunect commented Sep 9, 2024


		There is a specific section to setup the Grafana datasource in the Tempo config.

		Now, we should be able to see traces from Kiali.

		kubectl create ns bookinfo
		kubectl label ns bookinfo istio-injection=enabled

docs: Add section for Kiali and distributed tracing OpenShift integration #328

docs: Add section for Kiali and distributed tracing OpenShift integration #328

Conversation

josunect commented Aug 30, 2024

linux-foundation-easycla bot commented Aug 30, 2024 • edited Loading

istio-testing commented Aug 30, 2024

nrfox commented Aug 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nrfox Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josunect commented Sep 9, 2024

linux-foundation-easycla bot commented Aug 30, 2024 •

edited

Loading

nrfox Sep 9, 2024 •

edited

Loading