Skip to content

Commit 9fa4cf9

Browse files
authored
Minor federation example doc update (#716)
* Minor federation example doc update * make image responsive
1 parent 8eac093 commit 9fa4cf9

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

examples/100_federation/README.adoc

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,34 @@
1212
This example demonstrates the Coherence federation feature which allows you to federate cache data asynchronously across multiple geographically dispersed clusters.
1313
Cached data is federated across clusters to provide redundancy, off-site backup, and multiple points of access for application users in different geographical locations.
1414
15-
NOTE: The Coherence federation feature requires Coherence Grid Edition.
15+
NOTE: **Coherence federation feature requires Coherence Grid Edition.**
1616
17-
To demonstrate this feature, we will deploy two Coherence clusters (using Coherence Operator) located on separate OKE (Kubernetes Engine) clusters on Oracle Cloud (OCI).
18-
19-
It is assumed that you have two OCI regions, with two separate OKE clusters already configured, and have configured Dynamic Routing Gateways (DRGs)
17+
To demonstrate this feature, we will deploy two Coherence clusters, using the https://github.com/oracle/coherence-operator[Coherence Operator], located on separate OKE (Kubernetes Engine) clusters on Oracle Cloud (OCI).
18+
It is assumed that you have two OCI regions, with these OKE clusters already configured, and have configured Dynamic Routing Gateways (DRGs)
2019
to connect the two regions together.
2120
22-
The diagram below outlines the setup for this example and uses the following regions that have been configured with the relevant Kubernetes contexts.
21+
TIP: Although this example uses OCI, the concepts can be applied to other cloud providers to achieve the same result.
22+
23+
They key (cloud platform-agnostic) aspects of the example are:
24+
25+
* The two Kubernetes clusters are located in separate cloud regions
26+
* Each region must be able to be connected with or communicate with the other region
27+
* Each region must have a network load balancer (LB), created either via deployment yaml or configured, that can forward traffic on port 40000, in our case, to the federation service in the OKE cluster
28+
* Routing rules must be setup to allow LBs to send traffic over the specified ports between the regions
2329
24-
* Melbourne region has has a Kubernetes context of `c1`
25-
* Sydney region and has a Kubernetes context of `c3`
30+
The diagram below outlines the setup for this example and uses the following OCI regions that have been configured with the relevant Kubernetes contexts.
2631
32+
* Melbourne region has a Kubernetes context of `c1`
33+
* Sydney region has a Kubernetes context of `c3`
2734
28-
image::images/federated-coherence.png[Federated Setup,align="center"]
35+
image::images/federated-coherence.png[Federated Setup,align="center",width="100%",height="auto"]
2936
3037
NOTE: **Although some network setup information is outlined below, it is assumed you have knowledge of, or access to
3138
Oracle Cloud Infrastructure (OCI) administrators who can set up cross region networking using Dynamic Routing Gateways (DRG's) and
3239
Remote Peering Connections. DRG Documentation below for more information.**
3340
41+
42+
3443
See the links below for more information on various topics described above:
3544
3645
* https://github.com/oracle/coherence-operator[Coherence Operator on GitHub]
@@ -41,7 +50,7 @@ See the links below for more information on various topics described above:
4150
4251
[TIP]
4352
====
44-
image:GitHub-Mark-32px.png[] The complete source code for this example is in the https://{examples-source}100_federation[Coherence Operator GitHub] repository.
53+
The complete source code for this example is in the https://{examples-source}100_federation[Coherence Operator GitHub] repository.
4554
====
4655
4756
=== What the Example will Cover

0 commit comments

Comments
 (0)