Skip to content

Commit 3394bd7

Browse files
committed
Minor doc updates
1 parent aa68fc2 commit 3394bd7

File tree

11 files changed

+56
-55
lines changed

11 files changed

+56
-55
lines changed

docs/about/03_quickstart.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ See the <<install/01_installation.adoc, full install guide>> for more details.
5454
5555
== 2. Install a Coherence Cluster
5656
57-
Ensure that the Coherence images can be pulled by the Kubernetes cluster
58-
see <<about/04_obtain_coherence_images.adoc,Obtain Coherence Images>>
57+
Ensure that the Coherence images can be pulled by the Kubernetes cluster,
58+
see <<about/04_obtain_coherence_images.adoc,Obtain Coherence Images>>.
5959
By default a `CoherenceCluster` will use images from Oracle Container Registry.
6060
If a different registry is used the image name will need to be specified in the `CoherenceCluster` yaml,
6161
see <<clusters/056_coherence_image.adoc,Setting the Coherence Image>> for documentation on how to

docs/app-deployment/020_packaging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ COPY files/lib/ /app/lib/
6565
COPY files/conf/ /app/conf/
6666
----
6767
68-
NOTE: Is is recommended to use the `scratch` image in the `FROM` clause to minimize the size of the resultant image.
68+
NOTE: It is recommended to use the `scratch` image in the `FROM` clause to minimize the size of the resultant image.
6969
7070
See the <<clusters/070_applications.adoc,Coherence Applications>> section for
7171
full details on each of the fields in the application section.

docs/clusters/050_coherence.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ See <<clusters/100_logging.adoc,Logging Configuration>> for more details.
4747
See <<clusters/054_coherence_storage_enabled.adoc,Storage Enabled or Disabled Roles>> for more details.
4848
<5> The `imageSpec` section configures the Coherence image details such as image name, pull policy etc.
4949
See <<clusters/056_coherence_image.adoc,Setting the Coherence Image>> for more details.
50-
<6> The `management` configures how Coherence management over ReST behaves, whether it is enabled, etc.
51-
See <<clusters/058_coherence_management.adoc,Coherence Management Over ReST>> for more details.
50+
<6> The `management` configures how Coherence management over REST behaves, whether it is enabled, etc.
51+
See <<clusters/058_coherence_management.adoc,Coherence Management Over REST>> for more details.
5252
<7> The `metrics` configures how Coherence metrics behaves, whether it is enabled, etc.
5353
See <<clusters/060_coherence_metrics.adoc,Coherence Metrics>> for more details.
54-
<8> The `persistence` configures how Coherence management over ReST behaves, whether it is enabled, etc.
54+
<8> The `persistence` configures how Coherence management over REST behaves, whether it is enabled, etc.
5555
See <<clusters/062_coherence_persistence.adoc,Coherence Persistence>> for more details.
56-
<9> The `snapshot` configures how Coherence management over ReST behaves, whether it is enabled, etc.
56+
<9> The `snapshot` configures how Coherence management over REST behaves, whether it is enabled, etc.
5757
See <<clusters/064_coherence_snapshots.adoc,Coherence Snapshots>> for more details.

docs/clusters/058_coherence_management.adoc

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19-
= Coherence Management over ReST
19+
= Coherence Management over REST
2020
2121
22-
== Coherence Management over ReST
22+
== Coherence Management over REST
2323
24-
Since version 12.2.1.4 Coherence has had functionality to expose a management API over ReST.
24+
Since version 12.2.1.4 Coherence has had functionality to expose a management API over REST.
2525
This API is disabled by default in Coherence clusters but can be enabled and configured by setting the relevant fields
2626
in the `CoherenceCluster` resource.
2727
2828
2929
30-
== Enabling Management Over ReST
30+
== Enabling Management Over REST
3131
32-
Coherence management over ReST can be enabled or disabled by setting the `coherence.management.enabled` field.
32+
Coherence management over REST can be enabled or disabled by setting the `coherence.management.enabled` field.
3333
3434
[NOTE]
3535
====
36-
Enabling management over ReST will add a number of `.jar` files to the classpath of the Coherence JVM.
36+
Enabling management over REST will add a number of `.jar` files to the classpath of the Coherence JVM.
3737
In Coherence 12.2.1.4 those `.jar` file are:
3838
```
3939
org.glassfish.hk2.external:aopalliance-repackaged:jar:2.4.0-b34
@@ -60,15 +60,15 @@ org.glassfish.hk2:osgi-resource-locator:jar:1.0.1
6060
```
6161
If adding additional application `.jar` files care should be taken that there are no version conflicts.
6262
63-
If conflicts are an issue there are alternative approaches available to exposing the management over ReST API.
63+
If conflicts are an issue there are alternative approaches available to exposing the management over REST API.
6464
6565
The list above is subject to change in later Coherence patches and version.
6666
====
6767
6868
69-
=== Enabling Management Over ReST for the Implicit Role
69+
=== Enabling Management Over REST for the Implicit Role
7070
71-
When configuring a single implicit role in a `CoherenceCluster` the management over ReST API can be enabled by setting
71+
When configuring a single implicit role in a `CoherenceCluster` the management over REST API can be enabled by setting
7272
the `coherence.management.enabled` to `true` in the `CoherenceCluster` `spec` section.
7373
For example:
7474
@@ -84,13 +84,13 @@ spec:
8484
enabled: true # <1>
8585
----
8686
87-
<1> Management over ReST will be enabled and the http endpoint will bind to port `30000` in the container.
87+
<1> Management over REST will be enabled and the http endpoint will bind to port `30000` in the container.
8888
The port is not exposed in a `Service`.
8989
9090
91-
=== Enabling Management Over ReST for Explicit Roles
91+
=== Enabling Management Over REST for Explicit Roles
9292
93-
When configuring a explicit roles in the `roles` list of a `CoherenceCluster` the management over ReST API can be
93+
When configuring a explicit roles in the `roles` list of a `CoherenceCluster` the management over REST API can be
9494
enabled or disabled by setting the `coherence.management.enabled` for each role.
9595
For example:
9696
@@ -112,11 +112,11 @@ spec:
112112
enabled: false # <2>
113113
----
114114
115-
<1> The `data` role has the management over ReST enabled.
116-
<2> The `proxy` role has the management over ReST disabled.
115+
<1> The `data` role has the management over REST enabled.
116+
<2> The `proxy` role has the management over REST disabled.
117117
118118
119-
=== Enabling Management Over ReST for Explicit Roles with a Default
119+
=== Enabling Management Over REST for Explicit Roles with a Default
120120
121121
When configuring a explicit roles in the `roles` list of a `CoherenceCluster` a default value for the
122122
`coherence.management.enabled` field can be set in the `CoherenceCluster` `spec` section that will apply to
@@ -141,20 +141,20 @@ spec:
141141
enabled: false # <3>
142142
----
143143
144-
<1> The default value for enabling management over ReST is `true` which will apply to all roles in the `roles` list
144+
<1> The default value for enabling management over REST is `true` which will apply to all roles in the `roles` list
145145
unless the field is specifically overridden.
146146
147147
<2> The `data` role does not specify a value for the `coherence.management.enabled` field so it will use the default
148-
value of `true` so management over ReST will be enabled.
148+
value of `true` so management over REST will be enabled.
149149
150150
<3> The `proxy` role overrides the default value for the `coherence.management.enabled` field and sets it to `false`
151-
so management over ReST will be disabled.
151+
so management over REST will be disabled.
152152
153153
154154
155-
=== Exposing the Management over ReST API via a Service
155+
=== Exposing the Management over REST API via a Service
156156
157-
Enabling management over ReST only enables the http server so that the endpoint is available in the container.
157+
Enabling management over REST only enables the http server so that the endpoint is available in the container.
158158
If external access to the API is required via a service then the port needs to be exposed just like any other
159159
additional ports as described in <<clusters/090_ports_and_services.adoc,Expose Ports and Services>>.
160160
@@ -175,14 +175,14 @@ spec:
175175
port: 30000
176176
----
177177
178-
<1> Management over ReST will be enabled and the default port value will be used so that the http endpoint will bind
178+
<1> Management over REST will be enabled and the default port value will be used so that the http endpoint will bind
179179
to port `30000` in the container.
180180
181181
<2> An additional port named `management` is added to the `ports` array which will cause the management port to be
182182
exposed on a service. The port specified is `30000` as that is the default port that the management API will bind to.
183183
184184
185-
=== Expose Management Over ReST on a Different Port
185+
=== Expose Management Over REST on a Different Port
186186
187187
The default port in the container that the management API uses is 30000. It is possible to change ths port using the
188188
`coherence.management.port` field.
@@ -205,16 +205,16 @@ spec:
205205
port: 9000 # <2>
206206
----
207207
208-
<1> Management over ReST is enabled and configured to bind to port `9000` in the container.
208+
<1> Management over REST is enabled and configured to bind to port `9000` in the container.
209209
210210
<2> The corresponding `port` value of `9000` must be used when exposing the port on a `Service`.
211211
212212
213-
=== Configuring Management Over ReST With SSL
213+
=== Configuring Management Over REST With SSL
214214
215215
It is possible to configure the management API endpoint to use SSL to secure the communication between server and
216216
client. The SSL configuration is in the `coherence.management.ssl` section of the spec.
217-
See <<management/020_manegement_over_rest.adoc,Management over ReST>> for a more in depth guide to configuring SSL.
217+
See <<management/020_manegement_over_rest.adoc,Management over REST>> for a more in depth guide to configuring SSL.
218218
219219
For example:
220220

docs/clusters/090_ports_and_services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ that the headless `Service` used for Coherence WKA can declare a port.
4040
4141
|`6676`
4242
| `health`
43-
| This is the port used to expose the default readiness, liveness and StatusHA ReST endpoints on.
43+
| This is the port used to expose the default readiness, liveness and StatusHA REST endpoints on.
4444
4545
|===
4646

docs/developer/04_how_it_works.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The high level operation of the Coherence Operator can be seen in the diagram be
2424
image::../images/operator.png[operator,1000,562,pdfwidth=90%,scaledwidth=90%]
2525
2626
The entry point to the operator is the`main()` function in the `cmd/manager/main.go` file. This function performs
27-
the creation and initialisation of the three controllers and the ReST server. It also creates a configuration k8s
27+
the creation and initialisation of the three controllers and the REST server. It also creates a configuration k8s
2828
`secret` that is used by Coherence Pods. The Coherence Operator works in a single namespace, that is it manages CRDs
2929
and hence Coherence clusters only in the same namespace that it is installed into.
3030

docs/management/010_overview.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
///////////////////////////////////////////////////////////////////////////////
1818
1919
= Overview
20-
:description: Management Over ReST
21-
:keywords: oracle coherence, kubernetes, operator, Management, ReST
20+
:description: Management Over REST
21+
:keywords: oracle coherence, kubernetes, operator, Management, REST
2222
2323
== Management
2424
2525
[PILLARS]
2626
====
2727
[CARD]
28-
.Management Over ReST
28+
.Management Over REST
2929
[link=management/020_management_over_rest.adoc]
3030
--
31-
Management Over ReST.
31+
Management Over REST.
3232
--
3333
3434
[CARD]

docs/management/020_management_over_rest.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,31 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19-
= Management over ReST
19+
= Management over REST
2020
21-
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.
2222
This API is disabled by default in Coherence clusters but can be enabled and configured by setting the relevant fields
2323
in the `CoherenceCluster` resource.
2424
25-
== Management over ReST
25+
== Management over REST
2626
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.
2828
2929
Once the Management port is exposed via a load balancer or port-forward command the ReEST
3030
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`.
3131
3232
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
3333
full details on each of the endpoints.
3434
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
3636
<<clusters/058_coherence_management.adoc,Coherence Operator documentation>>.
3737
3838
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.
3939
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
4141
Coherence 12.2.1.4 or later version.
4242
43-
=== 1. Install a Coherence cluster with Management over ReST enabled
43+
=== 1. Install a Coherence cluster with Management over REST enabled
4444
4545
Deploy a simple management enabled `CoherenceCluster` resource with a single role like this:
4646
[source,yaml]
@@ -61,7 +61,7 @@ spec:
6161
port: 30000 <2>
6262
----
6363
64-
<1> Indicates to enable Management over ReST
64+
<1> Indicates to enable Management over REST
6565
<2> The management port must be added to the additional `ports` list so that it is exposed on a service
6666
6767
The yaml above can be installed into Kubernetes using `kubectl`:
@@ -80,7 +80,7 @@ management-cluster-storage-1 1/1 Running 0 36s
8080
management-cluster-storage-2 1/1 Running 0 36s
8181
----
8282
83-
=== 2. Port-forward the Management over ReST port
83+
=== 2. Port-forward the Management over REST port
8484
8585
[source,bash]
8686
----
@@ -92,7 +92,7 @@ Forwarding from 127.0.0.1:30000 -> 30000
9292
9393
=== 3. Access the REST endpoint
9494
95-
Issue the following to access the ReST endpoint:
95+
Issue the following to access the REST endpoint:
9696
9797
[source,bash]
9898
----
@@ -204,12 +204,12 @@ NOTE: The above output has been truncated due to the large size.
204204
205205
=== 4. Other Resources
206206
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
208208
standard MBean access over JMX.
209209
210210
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.
211211
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]
213213
* <<clusters/058_coherence_management.adoc,Enabling SSL>>
214214
* 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]
215215
* https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/api-reporter.html[Access the Reporter]

docs/management/030_heapdump.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A single-command technique is also included at the end of this sample.
3030
NOTE: Coherence Pods are configured to produce a heap dump on OOM error by default. See
3131
<<clusters/080_jvm.adoc, Configure The JVM>> for more information.
3232
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].
3434
3535
=== 1. Install a Coherence Cluster
3636

docs/management/040_visualvm.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ alternative to RMI that does work well in containers and only requires a single
3434
3535
This example shows how to connect to a cluster via JMX over JMXMP.
3636
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.
3939
4040
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]
4141
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
282282
+
283283
image:../images/jvisualvm.png[VisualVM,width="735"]
284284
285-
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]
286+
for detailed information about Coherence MBeans.
286287
287288
288289
=== Clean Up

0 commit comments

Comments
 (0)