Restructure distributed tracing #61948
Conversation
openshift-ci
bot
added
do-not-merge/work-in-progress
|
🤖 Updated build preview is available at: Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/19169 |
openshift-ci
bot
added
size/L
Signed-off-by: Pavol Loffay <p.loffay@gmail.com>
pavolloffay
force-pushed
the
dt-restructure
branch
from
d081f1a
to
6116840
Compare
openshift-ci
bot
added
size/S
openshift-ci
bot
added
size/M
openshift-ci
bot
added
size/L
pavolloffay
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
| @@ -3576,19 +3576,24 @@ Topics: | |||
| Topics: | |||
| - Name: Distributed tracing architecture | |||
There was a problem hiding this comment.
This could be in the same level as Distributed tracing release notes Currently we have to click on the Distributed tracing architecture dropdown arrow and then again select Distributed tracing architecture to view the page.
There was a problem hiding this comment.
agree, but I consider this out of the scope of this work. I will open a separate PR to fix this
_topic_maps/_topic_map.yml
Outdated
| File: distr-tracing-updating | ||
| - Name: Removing distributed tracing | ||
| File: distr-tracing-removing | ||
| - Name: Distributed tracing platform - Jaeger |
There was a problem hiding this comment.
Should we use camel case for the topic names ? Like Distributed Tracing Platform - Jaeger and Distributed Tracing Data Collection - OpenTelemetry.
There was a problem hiding this comment.
The official name of the product is Red Hat OpenShift distributed tracing platform (lower case after OpenShift), but here I guess we can use capitalization as we want.
I will leave this to docs team to decide
|
/lgtm |
|
/lgtm |
| :context: install-distributed-tracing-otel | ||
|
|
||
| toc::[] | ||
|
|
There was a problem hiding this comment.
pavolloffay, I'm not acquainted with this product. I noticed that this page is missing the following paragraphs, see another file in this PR, which are in the preview.
Just to double-check, this is a deliberate omission, correct? Or are these paragraphs not relevant to the content on this page?
I'm talking about these paragraphs:
There was a problem hiding this comment.
Correct, and this was a mistake in docs. The OpenTelemetry does not integrate with service mesh in any form. The service mesh docs do not contain anything about the OTEL operator.
There was a problem hiding this comment.
BTW, just curious: what's your plan regarding the content in https://docs.openshift.com/container-platform/4.13/service_mesh/v2x/ossm-reference-jaeger.html? Will it remain there or be eventually moved under distr_tracing_jaeger?
There was a problem hiding this comment.
That is a question for the service mesh team. I think in the past they wanted to have Jaeger installation docs directly in their docs, however, they are recently trying to decouple from 3rd party tools, so they will maybe just send user to jaeger docs.
| @@ -1,7 +1,7 @@ | |||
| //// | |||
| Module included in the following assemblies: | |||
| * distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc | |||
| * distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc | |||
There was a problem hiding this comment.
Could you please double-check this reference. It didn't seem up to date to me:
* distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc
|
|
||
| toc::[] | ||
|
|
||
| The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELName} resources. You can either install the default configuration or modify the file to better suit your business requirements. | ||
| The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELName} resources. You can either install the default configuration or modify the file to better suit your business requirements. | ||
|
|
||
| include::modules/distr-tracing-config-otel-collector.adoc[leveloffset=+1] |
There was a problem hiding this comment.
I suggest removing the other, commented out include on the following line in another file: https://github.com/openshift/openshift-docs/pull/61948/files#diff-ede8739ac256226eee0c61eab7a1c9b1b216c85b83ec3e5088cbc809004873f6R77.
There was a problem hiding this comment.
@pavolloffay, I left a few more comments here. Please review them. Pre-approving this PR.
|
/lgtm |
|
/lgtm |
…s into distributed-tracing-2.9 Merging changes from Pavol's PR openshift#61948
|
@pavolloffay, fyi, I've merged your changes from this PR into PR #62410. |
openshift-merge-robot
added
the
needs-rebase
|
PR needs rebase. 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/test-infra repository. |
|
It will be done as part of #62410 |
Version(s):
4.10+
Issue:
https://issues.redhat.com/browse/TRACING-3288
Link to docs preview:
https://61948--docspreview.netlify.app/
QE review:
Additional information:
There is no documentation content change in this PR, only structure was changed.
This PR splits
Distributed tracing/Distributed tracing installationinto:Distributed tracing/Distributed tracing platform - JaegerDistributed tracing/Distributed tracing data collection - OpenTelemetryThe spit is necessary because we want to introduce
Distributed tracing/Distributed tracing platform - Tempoand it will be better to have documentation per component. In the future we will probably move theDistributed tracing data collection - OpenTelemetryinto the root level as it might become a separate product.Each of these components will host following sub articles: