openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

OBSDOCS-980: Add Jaeger deprecation notice and migration recommendations to the DT architecture page

Open max-cx opened this issue 1 year ago • 5 comments

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

https://issues.redhat.com/browse/OBSDOCS-980

Link to docs preview:

TIP in the Architecture page

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture#distr-tracing-architecture_distributed-tracing-architecture

Rewritten paragraph in the deprecation section of the release notes

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr-tracing-rn#distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_distr-tracing-rn

TIP in the Jaeger pages (about installing, configuring, updating, and removing Jaeger)

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing

QE review:

  • [ ] QE has approved this change.

Additional information:

max-cx avatar Oct 23 '24 05:10 max-cx

@max-cx: This pull request references OBSDOCS-980 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.18.0" version, but no target version was set.

In response to this:

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.

openshift-ci-robot avatar Oct 23 '24 05:10 openshift-ci-robot

@max-cx: This pull request references OBSDOCS-980 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.18.0" version, but no target version was set.

In response to this:

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

https://issues.redhat.com/browse/OBSDOCS-980

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 avatar Oct 23 '24 05:10 openshift-ci-robot

🤖 Mon Feb 03 17:40:01 - Prow CI generated the docs preview: https://83995--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-previewbot avatar Oct 23 '24 05:10 ocpdocs-previewbot

@max-cx: This pull request references OBSDOCS-980 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.18.0" version, but no target version was set.

In response to this:

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

https://issues.redhat.com/browse/OBSDOCS-980

Link to docs preview:

TIP in the Architecture page

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture#distr-tracing-architecture_distributed-tracing-architecture

Rewritten paragraph in the deprecation section of the release notes

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr-tracing-rn#distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_distr-tracing-rn

TIP in the Jaeger pages (about installing, configuring, updating, and removing Jaeger)

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing

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 avatar Oct 25 '24 16:10 openshift-ci-robot

Hi @max-cx sorry for taking this long to review this. My only comment is that I think we should add the word Jaeger explicitly to make the message as accurate as possible, to avoid misconceptions and possible noise. So, could you please add the "(Jaeger)" bit to the additions when you mention the deprecation?

From

"The Red Hat OpenShift distributed tracing platform Operator will be removed from the redhat-operators catalog in November 2025."

To

"The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog in November 2025."

Thanks again!

jgomezselles avatar Oct 31 '24 15:10 jgomezselles

Hi @max-cx sorry for taking this long to review this. My only comment is that I think we should add the word Jaeger explicitly to make the message as accurate as possible, to avoid misconceptions and possible noise. So, could you please add the "(Jaeger)" bit to the additions when you mention the deprecation?

From

"The Red Hat OpenShift distributed tracing platform Operator will be removed from the redhat-operators catalog in November 2025."

To

"The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog in November 2025."

Thanks again!

@jgomezselles, I'd love to do this, but both Red Hat OpenShift distributed tracing platform and Tempo Operator are the current Operator names in the OperatorHub. I fear that if I add (Jaeger) there, customers will be confused because if they look for Red Hat OpenShift distributed tracing platform (Jaeger) among their installed Operators, they will not find it, and some might even assume that it doesn't apply to them. I did mention the Tempo Operator and OTEL Operator in the same paragraph, so I believe it should be clear without mentioning Jaeger. image

UPDATE on 20241129: I had to remove the November 2024 timeframe in response to a merge reviewer's objections in the 3.4 RN PR. I also added (Jaeger) like Jose asked me.

max-cx avatar Nov 05 '24 14:11 max-cx

@max-cx: This pull request references OBSDOCS-980 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.19.0" version, but no target version was set.

In response to this:

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

https://issues.redhat.com/browse/OBSDOCS-980

Link to docs preview:

TIP in the Architecture page

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture#distr-tracing-architecture_distributed-tracing-architecture

Rewritten paragraph in the deprecation section of the release notes

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr-tracing-rn#distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_distr-tracing-rn

TIP in the Jaeger pages (about installing, configuring, updating, and removing Jaeger)

image

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing

QE review:

  • N/A. Engineering stakeholders have 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 avatar Nov 29 '24 13:11 openshift-ci-robot

/label peer-review-needed

max-cx avatar Nov 29 '24 13:11 max-cx

/retest

max-cx avatar Jan 29 '25 16:01 max-cx

@max-cx: This pull request references OBSDOCS-980 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.19.0" version, but no target version was set.

In response to this:

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

https://issues.redhat.com/browse/OBSDOCS-980

Link to docs preview:

TIP in the Architecture page

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture#distr-tracing-architecture_distributed-tracing-architecture

Rewritten paragraph in the deprecation section of the release notes

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr-tracing-rn#distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_distr-tracing-rn

TIP in the Jaeger pages (about installing, configuring, updating, and removing Jaeger)

  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating
  • https://83995--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing

QE review:

  • N/A. Engineering stakeholders have 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 avatar Jan 30 '25 16:01 openshift-ci-robot

/label merge-review-needed

max-cx avatar Jan 31 '25 09:01 max-cx

@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.

openshift-ci[bot] avatar Feb 03 '25 17:02 openshift-ci[bot]

/label merge-review-needed

max-cx avatar Feb 03 '25 18:02 max-cx

... after squashing the commits.

max-cx avatar Feb 03 '25 18:02 max-cx

/cherrypick enterprise-4.12

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.13

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.14

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.15

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.16

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.17

xenolinux avatar Feb 04 '25 05:02 xenolinux

/cherrypick enterprise-4.18

xenolinux avatar Feb 04 '25 05:02 xenolinux

@xenolinux: new pull request created: #87996

In response to this:

/cherrypick enterprise-4.12

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.

@xenolinux: new pull request created: #87997

In response to this:

/cherrypick enterprise-4.13

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.

@xenolinux: new pull request created: #87998

In response to this:

/cherrypick enterprise-4.14

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.

@xenolinux: new pull request created: #87999

In response to this:

/cherrypick enterprise-4.15

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.

@xenolinux: new pull request created: #88000

In response to this:

/cherrypick enterprise-4.16

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.

@xenolinux: new pull request created: #88001

In response to this:

/cherrypick enterprise-4.17

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.

@xenolinux: new pull request created: #88002

In response to this:

/cherrypick enterprise-4.18

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.