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

OSSM 3.0 TP1 OSSM-8153 [DOC] OSSM 3.x Concepts

Open gwynnemonahan opened this issue 1 year ago • 5 comments
trafficstars

OSSM 3.0 TP1

This content was not required for TP 1 go live, but OSSM 3.0 is still in TP1 status so this applies to TP1.

Merge to: https://github.com/openshift/openshift-docs/tree/service-mesh-docs-main

Cherry pick: to https://github.com/openshift/openshift-docs/tree/service-mesh-docs-3.0.0tp1

OSSM-8153 OSSM 3.x Concepts

This PR is part of the standalone doc set for the OpenShift Service Mesh project. Kathryn is aware that this content applies for a product that is part of a Technology Preview release. The project is seeking feedback from early adopters.

Version(s):

Technology Preview

OSSM 3.0 is moving to stand alone format and will not be cherry-picked back to OCP core branches.

Issue: https://issues.redhat.com/browse/OSSM-8153

Link to docs preview: https://83560--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/about/ossm-about-concepts-assembly.html

QE review:

  • [x] QE has approved this change.

Additional information:

gwynnemonahan avatar Oct 15 '24 17:10 gwynnemonahan

🤖 Fri Nov 01 17:27:43 - Prow CI generated the docs preview:

https://83560--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/about/ossm-about-concepts-assembly.html

ocpdocs-previewbot avatar Oct 15 '24 17:10 ocpdocs-previewbot

I think we should try to draw more of a line around what is part of the OpenShift Service Mesh and what is an integration (not part of the service mesh offering). Simply re-ordering the content may achieve this.

Parts of Service Mesh:

  • Service Mesh resources
  • Kiali (note, Kiali has a CRDs called Kiali and OSSMConsole which we support - should we include them here too?)

Nots part of Service Mesh (integrations):

  • OpenShift Distributed tracing *
  • OpenShift Monitoring *
  • cert-manager
  • Argo Rollouts

*tracing and monitoring fall under OpenShift Observability, so I would probably put these together. It may also be that they have other features, such as the Cluster Observability operator that can be used with service mesh in the future, though the metrics, logs and tracing integrations described today will remain.

longmuir avatar Oct 22 '24 21:10 longmuir

  • Kiali (note, Kiali has a CRDs called Kiali and OSSMConsole which we support - should we include them here too?)

It is part of the Kiali section https://83560--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/about/ossm-about-concepts-assembly.html#ossm-about-concepts-kiali_ossm-about-concepts-assembly

gwynnemonahan avatar Oct 22 '24 22:10 gwynnemonahan

Parts of Service Mesh:

  • Service Mesh resources
  • Kiali (note, Kiali has a CRDs called Kiali and OSSMConsole which we support - should we include them here too?)

Nots part of Service Mesh (integrations):

  • OpenShift Distributed tracing *
  • OpenShift Monitoring *
  • cert-manager
  • Argo Rollouts

These have been clarified in ossm-about-concepts-assembly.adoc

gwynnemonahan avatar Oct 22 '24 22:10 gwynnemonahan

/retest

gwynnemonahan avatar Oct 29 '24 15:10 gwynnemonahan

/label peer-review-needed

In the spirit of expediency, happy to jump on a call and review/update together.

gwynnemonahan avatar Oct 29 '24 16:10 gwynnemonahan

Rebased evening of 10/29/2024

gwynnemonahan avatar Oct 29 '24 22:10 gwynnemonahan

@gwynnemonahan Mostly formatting suggestions, a few typo-level things. Otherwise, looks great!!

mburke5678 avatar Oct 31 '24 15:10 mburke5678

/label merge-review-needed

gwynnemonahan avatar Oct 31 '24 18:10 gwynnemonahan

@gwynnemonahan could you squash your commits? Thanks!

opayne1 avatar Nov 01 '24 16:11 opayne1

@opayne1 , my bad. Commit squashed, and also rebased.

gwynnemonahan avatar Nov 01 '24 17:11 gwynnemonahan

@gwynnemonahan: 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 Nov 01 '24 17:11 openshift-ci[bot]

/cherrypick service-mesh-docs-3.0.0tp1

opayne1 avatar Nov 01 '24 17:11 opayne1

@opayne1: new pull request created: #84371

In response to this:

/cherrypick service-mesh-docs-3.0.0tp1

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.