Skip to content

Commit e5c9477

Browse files
abrennan89abrennan89
authored
Merge pull request #37269 from rh-tokeefe/OSSMDOC-415
OSSMDOC-415: Document confirmation step for service mesh configuration tasks
2 parents 14a59c3 + 71cd7e9 commit e5c9477

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed

‎modules/ossm-federation-create-export.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,37 @@ For example:
109109
----
110110
$ oc get exportedserviceset green-mesh -o yaml |yaml
111111
----
112+
+
113+
. Run the following command to validate the services the red-mesh exports to share with green-mesh:
114+
+
115+
[source,terminal]
116+
----
117+
$ oc get exportedserviceset <PeerMeshExportedTo> -o yaml
118+
----
119+
+
120+
For example:
121+
+
122+
[source,terminal]
123+
----
124+
$ oc -n red-mesh-system get exportedserviceset green-mesh -o yaml
125+
----
126+
+
127+
.Example validating the services exported from the red mesh that are shared with the green mesh.
128+
[source,yaml]
129+
----
130+
status:
131+
exportedServices:
132+
- exportedName: red-ratings.bookinfo.svc.green-mesh-exports.local
133+
localService:
134+
hostname: ratings.red-mesh-bookinfo.svc.cluster.local
135+
name: ratings
136+
namespace: red-mesh-bookinfo
137+
- exportedName: reviews.red-mesh-bookinfo.svc.green-mesh-exports.local
138+
localService:
139+
hostname: reviews.red-mesh-bookinfo.svc.cluster.local
140+
name: reviews
141+
namespace: red-mesh-bookinfo
142+
----
143+
The `status.exportedServices` array lists the services that are currently exported (these services matched the export rules in the `ExportedServiceSet object`). Each entry in the array indicates the name of the exported service and details about the local service that is exported.
144+
+
145+
If a service that you expected to be exported is missing, confirm the Service object exists, its name or labels match the `exportRules` defined in the `ExportedServiceSet` object, and that the Service object's namespace is configured as a member of the service mesh using the `ServiceMeshMemberRoll` or `ServiceMeshMember` object.

‎modules/ossm-federation-create-import.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,35 @@ For example:
110110
----
111111
$ oc get importedserviceset green-mesh -o yaml |yaml
112112
----
113+
+
114+
. Run the following command to validate the services imported into a mesh.
115+
+
116+
[source,terminal]
117+
----
118+
$ oc get importedserviceset <PeerMeshImportedInto> -o yaml
119+
----
120+
+
121+
.Example validating that the services exported from the red mesh have been imported into the green mesh using the status section of the `importedserviceset/red-mesh' object in the 'green-mesh-system` namespace:
122+
+
123+
[source,terminal]
124+
----
125+
$ oc -n green-mesh-system get importedserviceset/red-mesh -o yaml
126+
----
127+
+
128+
[source,yaml]
129+
----
130+
status:
131+
importedServices:
132+
- exportedName: red-ratings.bookinfo.svc.green-mesh-exports.local
133+
localService:
134+
hostname: ratings.bookinfo.svc.red-mesh-imports.local
135+
name: ratings
136+
namespace: bookinfo
137+
- exportedName: reviews.red-mesh-bookinfo.svc.green-mesh-exports.local
138+
localService:
139+
hostname: ""
140+
name: ""
141+
namespace: ""
142+
----
143+
+
144+
In the preceding example only the ratings service is imported, as indicated by the populated fields under `localService`. The reviews service is available for import, but isn't currently imported because it does not match any `importRules` in the `ImportedServiceSet` object.

‎modules/ossm-federation-create-meshPeer.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,44 @@ spec:
8484
----
8585
$ oc create -n red-mesh-system -f servicemeshpeer.yaml
8686
----
87+
+
88+
. To confirm that connection between the red mesh and green mesh is established, inspect the status of the green-mesh `ServiceMeshPeer` in the red-mesh-system namespace:
89+
+
90+
[source,terminal]
91+
----
92+
$ oc -n red-mesh-system get servicemeshpeer green-mesh -o yaml
93+
----
94+
+
95+
.Example ServiceMeshPeer connection between red-mesh and green-mesh
96+
[source,yaml]
97+
----
98+
status:
99+
discoveryStatus:
100+
active:
101+
- pod: istiod-red-mesh-b65457658-9wq5j
102+
remotes:
103+
- connected: true
104+
lastConnected: "2021-10-05T13:02:25Z"
105+
lastFullSync: "2021-10-05T13:02:25Z"
106+
source: 10.128.2.149
107+
watch:
108+
connected: true
109+
lastConnected: "2021-10-05T13:02:55Z"
110+
lastDisconnectStatus: 503 Service Unavailable
111+
lastFullSync: "2021-10-05T13:05:43Z"
112+
----
113+
The `status.discoveryStatus.active.remotes` field shows that istiod in the peer mesh (in this example, the green mesh) is connected to istiod in the current mesh (in this example, the red mesh).
114+
+
115+
The `status.discoveryStatus.active.watch` field shows that istiod in the current mesh is connected to istiod in the peer mesh.
116+
+
117+
If you check the `servicemeshpeer` named `red-mesh` in `green-mesh-system`, you'll find information about the same two connections from the perspective of the green mesh.
118+
+
119+
When the connection between two meshes is not established, the `ServiceMeshPeer` status indicates this in the `status.discoveryStatus.inactive` field.
120+
+
121+
For more information on why a connection attempt failed, inspect the Istiod log, the access log of the egress gateway handling egress traffic for the peer, and the ingress gateway handling ingress traffic for the current mesh in the peer mesh.
122+
+
123+
For example, if the red mesh can't connect to the green mesh, check the following logs:
124+
125+
* istiod-red-mesh in red-mesh-system
126+
* egress-green-mesh in red-mesh-system
127+
* ingress-red-mesh in green-mesh-system

0 commit comments

Comments
 (0)