diff --git a/docs/about/03_quickstart.adoc b/docs/about/03_quickstart.adoc index f4c13af64..b2090a6cb 100644 --- a/docs/about/03_quickstart.adoc +++ b/docs/about/03_quickstart.adoc @@ -54,8 +54,8 @@ See the <> for more details. == 2. Install a Coherence Cluster -Ensure that the Coherence images can be pulled by the Kubernetes cluster -see <> +Ensure that the Coherence images can be pulled by the Kubernetes cluster, +see <>. By default a `CoherenceCluster` will use images from Oracle Container Registry. If a different registry is used the image name will need to be specified in the `CoherenceCluster` yaml, see <> for documentation on how to diff --git a/docs/app-deployment/020_packaging.adoc b/docs/app-deployment/020_packaging.adoc index a22b4325e..ad36411a9 100644 --- a/docs/app-deployment/020_packaging.adoc +++ b/docs/app-deployment/020_packaging.adoc @@ -65,7 +65,7 @@ COPY files/lib/ /app/lib/ COPY files/conf/ /app/conf/ ---- -NOTE: Is is recommended to use the `scratch` image in the `FROM` clause to minimize the size of the resultant image. +NOTE: It is recommended to use the `scratch` image in the `FROM` clause to minimize the size of the resultant image. See the <> section for full details on each of the fields in the application section. diff --git a/docs/clusters/050_coherence.adoc b/docs/clusters/050_coherence.adoc index 41ecf9697..d8ca21b69 100644 --- a/docs/clusters/050_coherence.adoc +++ b/docs/clusters/050_coherence.adoc @@ -47,11 +47,11 @@ See <> for more details. See <> for more details. <5> The `imageSpec` section configures the Coherence image details such as image name, pull policy etc. See <> for more details. -<6> The `management` configures how Coherence management over ReST behaves, whether it is enabled, etc. -See <> for more details. +<6> The `management` configures how Coherence management over REST behaves, whether it is enabled, etc. +See <> for more details. <7> The `metrics` configures how Coherence metrics behaves, whether it is enabled, etc. See <> for more details. -<8> The `persistence` configures how Coherence management over ReST behaves, whether it is enabled, etc. +<8> The `persistence` configures how Coherence management over REST behaves, whether it is enabled, etc. See <> for more details. -<9> The `snapshot` configures how Coherence management over ReST behaves, whether it is enabled, etc. +<9> The `snapshot` configures how Coherence management over REST behaves, whether it is enabled, etc. See <> for more details. diff --git a/docs/clusters/058_coherence_management.adoc b/docs/clusters/058_coherence_management.adoc index 07c345f90..7d1e74cd2 100644 --- a/docs/clusters/058_coherence_management.adoc +++ b/docs/clusters/058_coherence_management.adoc @@ -16,24 +16,24 @@ /////////////////////////////////////////////////////////////////////////////// -= Coherence Management over ReST += Coherence Management over REST -== Coherence Management over ReST +== Coherence Management over REST -Since version 12.2.1.4 Coherence has had functionality to expose a management API over ReST. +Since version 12.2.1.4 Coherence has had functionality to expose a management API over REST. This API is disabled by default in Coherence clusters but can be enabled and configured by setting the relevant fields in the `CoherenceCluster` resource. -== Enabling Management Over ReST +== Enabling Management Over REST -Coherence management over ReST can be enabled or disabled by setting the `coherence.management.enabled` field. +Coherence management over REST can be enabled or disabled by setting the `coherence.management.enabled` field. [NOTE] ==== -Enabling management over ReST will add a number of `.jar` files to the classpath of the Coherence JVM. +Enabling management over REST will add a number of `.jar` files to the classpath of the Coherence JVM. In Coherence 12.2.1.4 those `.jar` file are: ``` 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 ``` If adding additional application `.jar` files care should be taken that there are no version conflicts. -If conflicts are an issue there are alternative approaches available to exposing the management over ReST API. +If conflicts are an issue there are alternative approaches available to exposing the management over REST API. The list above is subject to change in later Coherence patches and version. ==== -=== Enabling Management Over ReST for the Implicit Role +=== Enabling Management Over REST for the Implicit Role -When configuring a single implicit role in a `CoherenceCluster` the management over ReST API can be enabled by setting +When configuring a single implicit role in a `CoherenceCluster` the management over REST API can be enabled by setting the `coherence.management.enabled` to `true` in the `CoherenceCluster` `spec` section. For example: @@ -84,13 +84,13 @@ spec: enabled: true # <1> ---- -<1> Management over ReST will be enabled and the http endpoint will bind to port `30000` in the container. +<1> Management over REST will be enabled and the http endpoint will bind to port `30000` in the container. The port is not exposed in a `Service`. -=== Enabling Management Over ReST for Explicit Roles +=== Enabling Management Over REST for Explicit Roles -When configuring a explicit roles in the `roles` list of a `CoherenceCluster` the management over ReST API can be +When configuring a explicit roles in the `roles` list of a `CoherenceCluster` the management over REST API can be enabled or disabled by setting the `coherence.management.enabled` for each role. For example: @@ -112,11 +112,11 @@ spec: enabled: false # <2> ---- -<1> The `data` role has the management over ReST enabled. -<2> The `proxy` role has the management over ReST disabled. +<1> The `data` role has the management over REST enabled. +<2> The `proxy` role has the management over REST disabled. -=== Enabling Management Over ReST for Explicit Roles with a Default +=== Enabling Management Over REST for Explicit Roles with a Default When configuring a explicit roles in the `roles` list of a `CoherenceCluster` a default value for the `coherence.management.enabled` field can be set in the `CoherenceCluster` `spec` section that will apply to @@ -141,20 +141,20 @@ spec: enabled: false # <3> ---- -<1> The default value for enabling management over ReST is `true` which will apply to all roles in the `roles` list +<1> The default value for enabling management over REST is `true` which will apply to all roles in the `roles` list unless the field is specifically overridden. <2> The `data` role does not specify a value for the `coherence.management.enabled` field so it will use the default -value of `true` so management over ReST will be enabled. +value of `true` so management over REST will be enabled. <3> The `proxy` role overrides the default value for the `coherence.management.enabled` field and sets it to `false` -so management over ReST will be disabled. +so management over REST will be disabled. -=== Exposing the Management over ReST API via a Service +=== Exposing the Management over REST API via a Service -Enabling management over ReST only enables the http server so that the endpoint is available in the container. +Enabling management over REST only enables the http server so that the endpoint is available in the container. If external access to the API is required via a service then the port needs to be exposed just like any other additional ports as described in <>. @@ -175,14 +175,14 @@ spec: port: 30000 ---- -<1> Management over ReST will be enabled and the default port value will be used so that the http endpoint will bind +<1> Management over REST will be enabled and the default port value will be used so that the http endpoint will bind to port `30000` in the container. <2> An additional port named `management` is added to the `ports` array which will cause the management port to be exposed on a service. The port specified is `30000` as that is the default port that the management API will bind to. -=== Expose Management Over ReST on a Different Port +=== Expose Management Over REST on a Different Port The default port in the container that the management API uses is 30000. It is possible to change ths port using the `coherence.management.port` field. @@ -205,16 +205,16 @@ spec: port: 9000 # <2> ---- -<1> Management over ReST is enabled and configured to bind to port `9000` in the container. +<1> Management over REST is enabled and configured to bind to port `9000` in the container. <2> The corresponding `port` value of `9000` must be used when exposing the port on a `Service`. -=== Configuring Management Over ReST With SSL +=== Configuring Management Over REST With SSL It is possible to configure the management API endpoint to use SSL to secure the communication between server and client. The SSL configuration is in the `coherence.management.ssl` section of the spec. -See <> for a more in depth guide to configuring SSL. +See <> for a more in depth guide to configuring SSL. For example: diff --git a/docs/clusters/090_ports_and_services.adoc b/docs/clusters/090_ports_and_services.adoc index 1677fb4e9..bd9f6a9e2 100644 --- a/docs/clusters/090_ports_and_services.adoc +++ b/docs/clusters/090_ports_and_services.adoc @@ -40,7 +40,7 @@ that the headless `Service` used for Coherence WKA can declare a port. |`6676` | `health` -| This is the port used to expose the default readiness, liveness and StatusHA ReST endpoints on. +| This is the port used to expose the default readiness, liveness and StatusHA REST endpoints on. |=== diff --git a/docs/developer/04_how_it_works.adoc b/docs/developer/04_how_it_works.adoc index e710fdf49..b396c54cf 100644 --- a/docs/developer/04_how_it_works.adoc +++ b/docs/developer/04_how_it_works.adoc @@ -24,7 +24,7 @@ The high level operation of the Coherence Operator can be seen in the diagram be image::../images/operator.png[operator,1000,562,pdfwidth=90%,scaledwidth=90%] The entry point to the operator is the`main()` function in the `cmd/manager/main.go` file. This function performs -the creation and initialisation of the three controllers and the ReST server. It also creates a configuration k8s +the creation and initialisation of the three controllers and the REST server. It also creates a configuration k8s `secret` that is used by Coherence Pods. The Coherence Operator works in a single namespace, that is it manages CRDs and hence Coherence clusters only in the same namespace that it is installed into. diff --git a/docs/management/010_overview.adoc b/docs/management/010_overview.adoc index bca2499ae..df003a9e4 100644 --- a/docs/management/010_overview.adoc +++ b/docs/management/010_overview.adoc @@ -17,18 +17,18 @@ /////////////////////////////////////////////////////////////////////////////// = Overview -:description: Management Over ReST -:keywords: oracle coherence, kubernetes, operator, Management, ReST +:description: Management Over REST +:keywords: oracle coherence, kubernetes, operator, Management, REST == Management [PILLARS] ==== [CARD] -.Management Over ReST +.Management Over REST [link=management/020_management_over_rest.adoc] -- -Management Over ReST. +Management Over REST. -- [CARD] diff --git a/docs/management/020_management_over_rest.adoc b/docs/management/020_management_over_rest.adoc index 1de84320c..7d7a46a95 100644 --- a/docs/management/020_management_over_rest.adoc +++ b/docs/management/020_management_over_rest.adoc @@ -16,15 +16,15 @@ /////////////////////////////////////////////////////////////////////////////// -= Management over ReST += Management over REST -Since version 12.2.1.4 Coherence has had functionality to expose a management API over ReST. +Since version 12.2.1.4 Coherence has had functionality to expose a management API over REST. This API is disabled by default in Coherence clusters but can be enabled and configured by setting the relevant fields in the `CoherenceCluster` resource. -== Management over ReST +== Management over REST -This example shows how to enable and access Coherence MBeans using Management over ReST. +This example shows how to enable and access Coherence MBeans using Management over REST. Once the Management port is exposed via a load balancer or port-forward command the ReEST 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`. @@ -32,15 +32,15 @@ endpoint is available at `http://host:port/management/coherence/cluster` and the 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 full details on each of the endpoints. -For more details on enabling Management over ReST including enabling SSL, please see the +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. -NOTE: Note: Use of Management over ReST is available only when using the operator with clusters running +NOTE: Note: Use of Management over REST is available only when using the operator with clusters running Coherence 12.2.1.4 or later version. -=== 1. Install a Coherence cluster with Management over ReST enabled +=== 1. Install a Coherence cluster with Management over REST enabled Deploy a simple management enabled `CoherenceCluster` resource with a single role like this: [source,yaml] @@ -61,7 +61,7 @@ spec: port: 30000 <2> ---- -<1> Indicates to enable Management over ReST +<1> Indicates to enable Management over REST <2> The management port must be added to the additional `ports` list so that it is exposed on a service The yaml above can be installed into Kubernetes using `kubectl`: @@ -80,7 +80,7 @@ management-cluster-storage-1 1/1 Running 0 36s management-cluster-storage-2 1/1 Running 0 36s ---- -=== 2. Port-forward the Management over ReST port +=== 2. Port-forward the Management over REST port [source,bash] ---- @@ -92,7 +92,7 @@ Forwarding from 127.0.0.1:30000 -> 30000 === 3. Access the REST endpoint -Issue the following to access the ReST endpoint: +Issue the following to access the REST endpoint: [source,bash] ---- @@ -204,12 +204,12 @@ NOTE: The above output has been truncated due to the large size. === 4. Other Resources -Management over ReST can be used for all management functions, as one would with +Management over REST can be used for all management functions, as one would with standard MBean access over JMX. 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. -* 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/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] * https://docs.oracle.com/en/middleware/fusion-middleware/coherence/12.2.1.4/rest-reference/api-reporter.html[Access the Reporter] diff --git a/docs/management/030_heapdump.adoc b/docs/management/030_heapdump.adoc index d46d8bbac..e263022d8 100644 --- a/docs/management/030_heapdump.adoc +++ b/docs/management/030_heapdump.adoc @@ -30,7 +30,7 @@ A single-command technique is also included at the end of this sample. NOTE: Coherence Pods are configured to produce a heap dump on OOM error by default. See <> for more information. -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]. +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]. === 1. Install a Coherence Cluster diff --git a/docs/management/040_visualvm.adoc b/docs/management/040_visualvm.adoc index 45afc401e..3cd756326 100644 --- a/docs/management/040_visualvm.adoc +++ b/docs/management/040_visualvm.adoc @@ -34,8 +34,8 @@ alternative to RMI that does work well in containers and only requires a single This example shows how to connect to a cluster via JMX over JMXMP. -As an alternative to JMX see <<020_manegement_over_rest.adoc,Management over ReST>> for how to connect to a cluster via -the VisualVM plugin using ReST. +As an alternative to JMX see <<020_manegement_over_rest.adoc,Management over REST>> for how to connect to a cluster via +the VisualVM plugin using REST. 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] 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 + image:../images/jvisualvm.png[VisualVM,width="735"] -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. +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] +for detailed information about Coherence MBeans. === Clean Up diff --git a/docs/metrics/040_scraping.adoc b/docs/metrics/040_scraping.adoc index b2318dc32..28dfba598 100644 --- a/docs/metrics/040_scraping.adoc +++ b/docs/metrics/040_scraping.adoc @@ -58,7 +58,7 @@ operator-coherence-operator-5d779ffc7-7xz7j 1/1 Running 0 === 2. Install Prometheus Operator (Optional) -Id you do not already have a Prometheus environment installed, you can use the `Prometheus Operator` +If you do not already have a Prometheus environment installed, you can use the `Prometheus Operator` chart from https://github.com/helm/charts/tree/master/stable/prometheus-operator using the following: [source,bash]