OSSM 3.0 TP1 OSSM-8153 [DOC] OSSM 3.x Concepts #83560
Conversation
openshift-ci
bot
added
the
size/M
|
🤖 Fri Nov 01 17:27:43 - Prow CI generated the docs preview: |
openshift-ci
bot
added
size/L
gwynnemonahan
changed the title
openshift-ci
bot
added
the
do-not-merge/work-in-progress
gwynnemonahan
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
gwynnemonahan
force-pushed
the
OSSM-8153
branch
from
57863ca to
53b4237
Compare
| == `IstioRevision` resource | ||
|
|
||
| The `IstioRevision` is a cluster-wide resource and the lowest-level API {SMProduct} provides. It is usually not created by the user, but by the operator itself. Its schema closely resembles that of the `Istio` resource - but instead of representing the state of a control plane you want to be present in your cluster, it represents a revision of that control plane. | ||
|
|
||
| A revision of the control plane you want to be present in your cluster is an instance of Istio with a specific version and revision name, and its revision name can be used to add workloads or entire namespaces to the mesh. For example: by using the `istio.io/rev=<REVISION_NAME>` label. | ||
|
|
||
| You can think of the relationship between the `Istio` and `IstioRevision` resources as similar to the relationship between Kubernetes' `ReplicaSet` and Pod: a `ReplicaSet` can be created by users and results in the automatic creation of Pods, which will trigger the instantiation of your containers. | ||
|
|
||
| Similarly, users create an `Istio` resource which instructs the {SMProduct} Operator to create a matching `IstioRevision`, which then in turn triggers the creation of the Istio control plane. To do that, the {SMProduct} Operator will copy all of your relevant configuration from the `Istio` resource to the `IstioRevision` resource. |
There was a problem hiding this comment.
This section does a good job of explaining how the two resources relate to each other!
|
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:
Nots part of Service Mesh (integrations):
*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. |
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 |
These have been clarified in ossm-about-concepts-assembly.adoc |
jshaughn
left a comment
jshaughn
left a comment
There was a problem hiding this comment.
@gwynnemonahan Looks good, just a few minor comments/suggestions.
gwynnemonahan
force-pushed
the
OSSM-8153
branch
from
aead59b to
3fea072
Compare
gwynnemonahan
force-pushed
the
OSSM-8153
branch
2 times, most recently
from
1abe14c to
54cadf0
Compare
|
/retest |
|
/label peer-review-needed In the spirit of expediency, happy to jump on a call and review/update together. |
openshift-ci
bot
added
the
peer-review-needed
gwynnemonahan
force-pushed
the
OSSM-8153
branch
from
54cadf0 to
828dcc8
Compare
|
Rebased evening of 10/29/2024 |
| + | ||
| Integrating {DTProductName} with {SMProductName} is made of up two parts: {TempoName} and {OTELName}. | ||
| + | ||
| {TempoName}:: Provides distributed tracing to monitor and troubleshoot transactions in complex distributed systems. It is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] project. |
There was a problem hiding this comment.
Per doc guidelines: When pointing to a link that exists external to Red Hat’s customer portal documentation, add the link attribute, and use the <document_heading_name> (<document_source>) format.
|
@gwynnemonahan Mostly formatting suggestions, a few typo-level things. Otherwise, looks great!! |
mburke5678
added
peer-review-done
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
opayne1
added
merge-review-in-progress
|
@gwynnemonahan could you squash your commits? Thanks! |
gwynnemonahan
force-pushed
the
OSSM-8153
branch
from
43b74e7 to
cf08c9d
Compare
gwynnemonahan
force-pushed
the
OSSM-8153
branch
from
cf08c9d to
26b7502
Compare
|
@opayne1 , my bad. Commit squashed, and also rebased. |
|
@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. |
|
/cherrypick service-mesh-docs-3.0.0tp1 |
|
@opayne1: new pull request created: #84371 In response to this:
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. |
10 participants
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:
Additional information: