OBSDOCS-873/TRACING-3799: Documentation for the Tempo monolithic CRD

[max-cx]

trafficstars

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

Signed-off-by: Andreas Gerstmayr [email protected]

Version(s):

Issue:

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[ocpdocs-previewbot]

🤖 Fri May 31 17:07:39 - Prow CI generated the docs preview:

https://75761--ocpdocs-pr.netlify.app/ https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.html https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.html

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and that little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization after the upcoming release in https://issues.redhat.com/browse/OBSDOCS-1067.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and that little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the affected page to be worked on after the upcoming release in https://issues.redhat.com/browse/OBSDOCS-1067.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and that little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on after the upcoming release in https://issues.redhat.com/browse/OBSDOCS-1067.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and that little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on after the upcoming release in OBSDOCS-1067.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on after the upcoming release in OBSDOCS-1067.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on in OBSDOCS-1067 after the upcoming release.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on in OBSDOCS-1067 after the upcoming release.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on in OBSDOCS-1067 after the upcoming release.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

Intro (before the first section): https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[max-cx]

/label peer-review-needed

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on in OBSDOCS-1067 after the upcoming release.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

Intro (before the first section): https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• QE testing is in progress.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

:warning: Note for reviewers: Considering that this is a Technology Preview feature and little time remains for the docs and QE until the scheduled release date, I've planned further docs reorganization of the content on the affected page to be worked on in OBSDOCS-1067 after the upcoming release.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

Intro (before the first section): https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• [ ] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[max-cx]

QE confirmed successful tests.

[GroceryBoyJr]

/label peer-review-in-progress /remove-label peer-review-needed /assign GroceryBoyJr

[max-cx]

LGTM overall

One comment: You squashed the TempoMonolithic configurations (in-memory, PV and object storage, jaeger ui+route) into a single code block at https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing step 3

Personally I think it's easier to read (and copy&paste) if it's divided in multiple sections, like here: https://72786--ocpdocs-pr.netlify.app/openshift-enterprise/latest/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring#configuring-tempomonolithic-storage_distr-tracing-tempo-configuring

I too wish I kept the separate blocks as you preferred. Unfortunately, it doesn't work well with the templates that we use for the docs. I wouldn't have changed your draft if I didn't need to.

[max-cx]

Closing this PR because I cherry-picked its commit into https://github.com/openshift/openshift-docs/pull/76340.

[IshwarKanse]

/lgtm

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

:warning: This PR is tied to a product release date, which is currently set to May 29 (Wednesday).

• If the merge review gets delayed, you're welcome to ping mleonov on Slack.
• If you have any questions, ping mleonov on Slack.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

Intro (before the first section): https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• [x] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[max-cx]

/label merge-review-needed

[kcarmichael08]

Hey, it doesn't look like this was peer reviewed - maybe because of it getting closed & reopened? So I'm adding a peer-review-needed label back on it.

[max-cx]

@skrthomas, thank you so much for your helpful review.

Could you please have a look at my responses?

[max-cx]

/label merge-review-needed

[max-cx]

/remove-label merge-review-needed

[openshift-ci-robot]

@max-cx: This pull request references TRACING-3799 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

:warning: This PR is tied to a product release date, which is currently set to June 5 (Wednesday).

• If the merge review gets delayed, you're welcome to ping mleonov on Slack.
• If you have any questions, ping mleonov on Slack.

Signed-off-by: Andreas Gerstmayr [email protected]

Edit of https://github.com/openshift/openshift-docs/pull/72786

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Issue:

https://issues.redhat.com/browse/OBSDOCS-873 https://issues.redhat.com/browse/TRACING-3799

Link to docs preview:

Reorganized existing (reviewed and published) content that appears as new files:

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempostack-cli_dist-tracing-tempo-installing

New content to be reviewed:

Intro (before the first section): https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-web-console_dist-tracing-tempo-installing

https://75761--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing#distr-tracing-tempo-install-tempomonolithic-cli_dist-tracing-tempo-installing

QE review:

• [x] QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

[max-cx]

/test validate-asciidoc

[max-cx]

validate-asciidoc has gone insane: it sees unterminated example blocks everywhere.

[max-cx]

/label merge-review-needed

[openshift-ci[bot]]

@max-cx: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.