You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Since version 12.2.1.4 Coherence has had functionality to expose a management API over ReST.
21
+
Since version 12.2.1.4 Coherence has had functionality to expose a management API over REST.
22
22
This API is disabled by default in Coherence clusters but can be enabled and configured by setting the relevant fields
23
23
in the `CoherenceCluster` resource.
24
24
25
-
== Management over ReST
25
+
== Management over REST
26
26
27
-
This example shows how to enable and access Coherence MBeans using Management over ReST.
27
+
This example shows how to enable and access Coherence MBeans using Management over REST.
28
28
29
29
Once the Management port is exposed via a load balancer or port-forward command the ReEST
30
30
endpoint is available at `http://host:port/management/coherence/cluster` and the Swagger JSON document is available at `http://host:port/management/coherence/cluster/metadata-catalog`.
31
31
32
32
See https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/index.html[REST API for Managing Oracle Coherence] for
33
33
full details on each of the endpoints.
34
34
35
-
For more details on enabling Management over ReST including enabling SSL, please see the
35
+
For more details on enabling Management over REST including enabling SSL, please see the
See the https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/manage/using-jmx-manage-oracle-coherence.html[Coherence Management] documentation for more information.
39
39
40
-
NOTE: Note: Use of Management over ReST is available only when using the operator with clusters running
40
+
NOTE: Note: Use of Management over REST is available only when using the operator with clusters running
41
41
Coherence 12.2.1.4 or later version.
42
42
43
-
=== 1. Install a Coherence cluster with Management over ReST enabled
43
+
=== 1. Install a Coherence cluster with Management over REST enabled
44
44
45
45
Deploy a simple management enabled `CoherenceCluster` resource with a single role like this:
46
46
[source,yaml]
@@ -61,7 +61,7 @@ spec:
61
61
port: 30000 <2>
62
62
----
63
63
64
-
<1> Indicates to enable Management over ReST
64
+
<1> Indicates to enable Management over REST
65
65
<2> The management port must be added to the additional `ports` list so that it is exposed on a service
66
66
67
67
The yaml above can be installed into Kubernetes using `kubectl`:
@@ -92,7 +92,7 @@ Forwarding from 127.0.0.1:30000 -> 30000
92
92
93
93
=== 3. Access the REST endpoint
94
94
95
-
Issue the following to access the ReST endpoint:
95
+
Issue the following to access the REST endpoint:
96
96
97
97
[source,bash]
98
98
----
@@ -204,12 +204,12 @@ NOTE: The above output has been truncated due to the large size.
204
204
205
205
=== 4. Other Resources
206
206
207
-
Management over ReST can be used for all management functions, as one would with
207
+
Management over REST can be used for all management functions, as one would with
208
208
standard MBean access over JMX.
209
209
210
210
Please see the https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/index.html[Coherence REST API] for more information on these features.
211
211
212
-
* https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/manage/using-jmx-manage-oracle-coherence.html#GUID-D160B16B-7C1B-4641-AE94-3310DF8082EC[Connecting JVisualVM to Management over ReST]
212
+
* https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/manage/using-jmx-manage-oracle-coherence.html#GUID-D160B16B-7C1B-4641-AE94-3310DF8082EC[Connecting JVisualVM to Management over REST]
* https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/op-management-coherence-cluster-members-memberidentifier-diagnostic-cmd-jfrcmd-post.html[Produce and extract a Java Flight Recorder (JFR) file]
215
215
* https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/api-reporter.html[Access the Reporter]
Copy file name to clipboardExpand all lines: docs/management/030_heapdump.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ A single-command technique is also included at the end of this sample.
30
30
NOTE: Coherence Pods are configured to produce a heap dump on OOM error by default. See
31
31
<<clusters/080_jvm.adoc, Configure The JVM>> for more information.
32
32
33
-
NOTE: You cal also trigger a heap dump via the https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/op-management-coherence-cluster-members-memberidentifier-dumpheap-post.html[Management over ReST API].
33
+
NOTE: You cal also trigger a heap dump via the https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/op-management-coherence-cluster-members-memberidentifier-dumpheap-post.html[Management over REST API].
Copy file name to clipboardExpand all lines: docs/management/040_visualvm.adoc
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,8 @@ alternative to RMI that does work well in containers and only requires a single
34
34
35
35
This example shows how to connect to a cluster via JMX over JMXMP.
36
36
37
-
As an alternative to JMX see <<020_manegement_over_rest.adoc,Management over ReST>> for how to connect to a cluster via
38
-
the VisualVM plugin using ReST.
37
+
As an alternative to JMX see <<020_manegement_over_rest.adoc,Management over REST>> for how to connect to a cluster via
38
+
the VisualVM plugin using REST.
39
39
40
40
NOTE: See the https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/manage/introduction-oracle-coherence-management.html[Coherence Management Documentation]
41
41
for more information on JMX and Management.
@@ -282,7 +282,8 @@ If you have installed the Coherence VisualVM plugin, you can also see a `Coheren
Refer to the [Coherence MBean Reference](https://docs.oracle.com/middleware/12213/coherence/COHMG/oracle-coherence-mbeans-reference.htm#COHMG5442) for detailed information about Coherence MBeans.
285
+
Refer to the https://www.oracle.com/pls/topic/lookup?ctx=en/middleware/fusion-middleware/coherence/12.2.1.4&id=COHMG5442[Coherence MBean Reference]
0 commit comments