OSSM-6063 [DOC] OpenShift Service Mesh Console (OSSMC) plugin Integration #88446

shreyasiddhartha · 2025-02-12T10:57:40Z

Change type: Doc update; OpenShift Service Mesh Console (OSSMC) plugin Integration

Doc JIRA: https://issues.redhat.com/browse/OSSM-6063

Fix Version: service-mesh-docs-main and service-mesh-docs-3.0

Doc Preview: https://88446--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/observability/kiali/ossm-console-plugin

SME Review/QE Review: @jshaughn @ferhoyos
Peer Review: @jeana-redhat

ocpdocs-previewbot · 2025-02-12T11:16:11Z

🤖 Tue Feb 25 11:39:44 - Prow CI generated the docs preview:
https://88446--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

shreyasiddhartha · 2025-02-12T11:21:02Z

/label service-mesh

jshaughn

Looks good, I had one trivial and optional suggestion. But not blocking approval.

modules/ossm-about-console-plugin.adoc

ferhoyos

LGTM

shreyasiddhartha · 2025-02-14T10:45:48Z

/label peer-review-needed

ferhoyos

@shreyasiddhartha I suggests a more descriptive compatibility table to indicate version alignment betwen Kiali/OSSMC and OSSM and the OCP versions supported.

The table is in markdown format, sorry. I hope it is not difficult to convert it to adoc.

observability/kiali/ossm-console-plugin-assembly.adoc

modules/ossm-install-console-plugin-ocp-web-console.adoc

modules/ossm-install-console-plugin-ocp-cli.adoc

jeana-redhat

Global comment: "OpenShift" is not really an approved short name. Instances of {ocp-short-name} in this PR should probably all be {ocp-product-title}. I corrected a few but will stop because it will be a lot of comments - please replace them throughout.

Overall this is pretty solid - there are some similar formatting issues across a big PR, so it' a decent amount of comments, but in pretty good shape regardless 🙂

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

_attributes/common-attributes.adoc

_topic_maps/_topic_map.yml

observability/kiali/ossm-console-plugin-assembly.adoc

modules/ossm-about-console-plugin.adoc

modules/ossm-uninstall-console-plugin-ocp-web-console.adoc

modules/ossm-uninstall-console-plugin-ocp-cli.adoc

modules/ossm-about-console-plugin.adoc

ferhoyos

@shreyasiddhartha I have added some comments about installation section and compatibility matrix

observability/kiali/ossm-console-plugin.adoc

modules/ossm-about-console-plugin.adoc

modules/ossm-install-console-plugin-ocp-cli.adoc

modules/ossm-install-console-plugin-ocp-web-console.adoc

observability/kiali/ossm-console-plugin.adoc

shreyasiddhartha · 2025-02-20T06:12:05Z

@ferhoyos Can you please give your lgtm again?

observability/kiali/ossm-console-plugin.adoc

modules/ossm-install-console-plugin-ocp-cli.adoc

ferhoyos

LGTM

shreyasiddhartha · 2025-02-24T11:08:03Z

/remove-label peer-review-done

shreyasiddhartha · 2025-02-24T11:08:20Z

/label peer-review-needed

shreyasiddhartha · 2025-02-24T11:08:52Z

I have added the peer review label again as there were multiple changes after the previous peer review.

jeana-redhat

Glad to re-review - this looks great overall! There are still some issues with unapproved product name use.

"OpenShift" by itself is not an approved name for OpenShift Container Platform. I am not sure the history behind the {ocp-short-name} attribute, but we are not supposed to use "OpenShift" as a short form.

I have replaced {ocp-short-name} with suggestions of {ocp-product-title} where I see it in this PR, but honestly most of them can probably just be removed. Saying "the web console" is typically sufficient without specifying the product (in most contexts).

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

jeana-redhat · 2025-02-24T15:21:45Z

observability/kiali/ossm-console-plugin.adoc

+{SMPluginShort} is only supported on {ocp-short-name} 4.15 and above. For {ocp-short-name} 4.14 users, only the standalone Kiali console is accessible.
+====
+
+You can install the {SMPluginShort} by using the {ocp-product-title} web console or the {oc-first}.


Ah - apparently the oc-first attribute isn't in the service mesh attributes file. If you want to add it to your file for use, the format is a little weird:

:oc-first: pass:quotes[OpenShift CLI (`oc`)]

Otherwise, you can just type out the thing when you need it (I find that annoying to type, hence created the attribute 😉)

Suggested change

You can install the {SMPluginShort} by using the {ocp-product-title} web console or the {oc-first}.

You can install the {SMPluginShort} by using the {ocp-product-title} web console or the OpenShift CLI (`oc`).

Thanks @jeana-redhat! I removed the attribute because it wasn't displaying correctly. I will try adding the attribute and see what happens again. 😄

it's working, yay 🎉

observability/kiali/ossm-console-plugin.adoc

modules/ossm-uninstall-console-plugin-ocp-cli.adoc

modules/ossm-about-console-plugin.adoc

modules/ossm-install-console-plugin-ocp-cli.adoc

Updates after peer review 2

openshift-ci · 2025-02-25T11:40:55Z

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

shreyasiddhartha · 2025-02-25T14:29:48Z

/label merge-review-needed

jeana-redhat

LGTM, nice work!

/remove-label merge-review-in-progress
/remove-label merge-review-needed

jeana-redhat · 2025-02-25T20:01:03Z

/cherrypick service-mesh-docs-3.0

openshift-cherrypick-robot · 2025-02-25T20:01:50Z

@jeana-redhat: new pull request created: #89162

In response to this:

/cherrypick service-mesh-docs-3.0

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.

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 12, 2025

openshift-ci bot added the service-mesh Label for all Service Mesh PRs label Feb 12, 2025

shreyasiddhartha force-pushed the OSSM-6063 branch from 14df8ab to 1ff21b4 Compare February 12, 2025 13:11

shreyasiddhartha closed this Feb 13, 2025

shreyasiddhartha reopened this Feb 13, 2025

shreyasiddhartha force-pushed the OSSM-6063 branch from aaa7ab6 to f691644 Compare February 13, 2025 11:59

jshaughn approved these changes Feb 13, 2025

View reviewed changes

modules/ossm-about-console-plugin.adoc Outdated Show resolved Hide resolved

ferhoyos approved these changes Feb 13, 2025

View reviewed changes

shreyasiddhartha force-pushed the OSSM-6063 branch from 0a5e944 to e206e4c Compare February 14, 2025 06:40

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 14, 2025

jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Feb 14, 2025

ferhoyos suggested changes Feb 14, 2025

View reviewed changes

observability/kiali/ossm-console-plugin-assembly.adoc Outdated Show resolved Hide resolved

modules/ossm-install-console-plugin-ocp-web-console.adoc Outdated Show resolved Hide resolved

modules/ossm-install-console-plugin-ocp-cli.adoc Outdated Show resolved Hide resolved

jeana-redhat reviewed Feb 14, 2025

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Feb 14, 2025

ferhoyos reviewed Feb 18, 2025

View reviewed changes

modules/ossm-about-console-plugin.adoc Show resolved Hide resolved

ferhoyos reviewed Feb 18, 2025

View reviewed changes

observability/kiali/ossm-console-plugin.adoc Outdated Show resolved Hide resolved

modules/ossm-about-console-plugin.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 19, 2025

View reviewed changes

modules/ossm-about-console-plugin.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 19, 2025

View reviewed changes

modules/ossm-install-console-plugin-ocp-cli.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 19, 2025

View reviewed changes

modules/ossm-install-console-plugin-ocp-web-console.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 19, 2025

View reviewed changes

observability/kiali/ossm-console-plugin.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 20, 2025

View reviewed changes

observability/kiali/ossm-console-plugin.adoc Outdated Show resolved Hide resolved

ferhoyos reviewed Feb 20, 2025

View reviewed changes

modules/ossm-install-console-plugin-ocp-cli.adoc Outdated Show resolved Hide resolved

ferhoyos approved these changes Feb 24, 2025

View reviewed changes

openshift-ci bot removed the peer-review-done Signifies that the peer review team has reviewed this PR label Feb 24, 2025

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 24, 2025

jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Feb 24, 2025

jeana-redhat reviewed Feb 24, 2025

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Feb 24, 2025

shreyasiddhartha force-pushed the OSSM-6063 branch from f54f3d7 to 7b641c1 Compare February 25, 2025 11:25

OSSM-6063

f780d2e

Updates after peer review 2

shreyasiddhartha force-pushed the OSSM-6063 branch from 7b641c1 to f780d2e Compare February 25, 2025 11:26

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 25, 2025

jeana-redhat added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Feb 25, 2025

jeana-redhat approved these changes Feb 25, 2025

View reviewed changes

openshift-ci bot removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Feb 25, 2025

jeana-redhat merged commit 45fa19a into openshift:service-mesh-docs-main Feb 25, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Feb 25, 2025

[service-mesh-docs-3.0] OSSM-6063 [DOC] OpenShift Service Mesh Console (OSSMC) plugin Integration #89162

Merged

This was referenced Mar 5, 2025

Add Kiali docs for 3.0 openshift-service-mesh/sail-operator#189

Merged

Add compatibility version table for OSSMC plugin docs openshift-service-mesh/sail-operator#232

Open

	You can install the {SMPluginShort} by using the {ocp-product-title} web console or the {oc-first}.
	You can install the {SMPluginShort} by using the {ocp-product-title} web console or the OpenShift CLI (`oc`).

OSSM-6063 [DOC] OpenShift Service Mesh Console (OSSMC) plugin Integration #88446

OSSM-6063 [DOC] OpenShift Service Mesh Console (OSSMC) plugin Integration #88446

Uh oh!

Conversation

shreyasiddhartha commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shreyasiddhartha commented Feb 12, 2025

Uh oh!

jshaughn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ferhoyos left a comment

Choose a reason for hiding this comment

Uh oh!

shreyasiddhartha commented Feb 14, 2025

Uh oh!

ferhoyos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ferhoyos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shreyasiddhartha commented Feb 20, 2025

Uh oh!

Uh oh!

Uh oh!

ferhoyos left a comment

Choose a reason for hiding this comment

Uh oh!

shreyasiddhartha commented Feb 24, 2025

Uh oh!

shreyasiddhartha commented Feb 24, 2025

Uh oh!

shreyasiddhartha commented Feb 24, 2025

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

shreyasiddhartha Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shreyasiddhartha commented Feb 12, 2025 •

edited

Loading

ocpdocs-previewbot commented Feb 12, 2025 •

edited

Loading