Skip to content

Commit 74caa85

Browse files
mukul-tyagi08mukul-tyagi08
committed
feat: add a docker-compose in quick setup to test distributed sync process with redis
1 parent 8641c86 commit 74caa85

File tree

16 files changed

+1994
-0
lines changed

16 files changed

+1994
-0
lines changed

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-client/gravitee.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
management:
2+
type: mongodb
3+
mongodb:
4+
uri: mongodb://mongodb:27017/gravitee?serverSelectionTimeoutMS=5000
5+
6+
ratelimit:
7+
type: mongodb
8+
mongodb:
9+
uri: mongodb://mongodb:27017/gravitee?serverSelectionTimeoutMS=5000
10+
11+
cluster:
12+
type: hazelcast
13+
hazelcast:
14+
config-path: /opt/graviteeio-gateway/config/hazelcast.xml
15+
16+
distributed-sync:
17+
type: redis
18+
redis:
19+
host: redis-stack
20+
port: 6379
21+
22+
services:
23+
sync:
24+
repository:
25+
enabled: true
26+
distributed:
27+
enabled: true

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-client/hazelcast.xml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
The following is given as a simple example to enable hazelcast cluster on local environment.
5+
It will be used when cluster.type: hazelcast is set in gravitee.yml.
6+
7+
For advanced configuration, please refer to official documentation: https://docs.hazelcast.com/imdg/4.2/clusters/discovery-mechanisms
8+
-->
9+
<hazelcast xmlns="http://www.hazelcast.com/schema/config"
10+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
11+
xsi:schemaLocation="http://www.hazelcast.com/schema/config
12+
http://www.hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
13+
14+
<cluster-name>gio-apim-gateway-cluster-bridge</cluster-name>
15+
<network>
16+
<port auto-increment="true" port-count="100">5701</port>
17+
<join>
18+
<auto-detection enabled="true"/>
19+
<multicast enabled="false"/>
20+
<tcp-ip enabled="true">
21+
<member>gateway_client</member>
22+
<member>gateway_client_2</member>
23+
<member>gateway_server</member>
24+
</tcp-ip>
25+
</join>
26+
</network>
27+
</hazelcast>

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-client/logback.xml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
~ Copyright (c) 2015-2016, The Gravitee team (http://www.gravitee.io)
5+
~
6+
~ Licensed under the Apache License, Version 2.0 (the "License");
7+
~ you may not use this file except in compliance with the License.
8+
~ You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing, software
13+
~ distributed under the License is distributed on an "AS IS" BASIS,
14+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
~ See the License for the specific language governing permissions and
16+
~ limitations under the License.
17+
-->
18+
19+
<configuration>
20+
21+
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
22+
<!-- encoders are assigned the type
23+
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
24+
<encoder>
25+
<pattern>%d{HH:mm:ss.SSS} [%thread] [%X{api}] %-5level %logger{36} - %msg%n</pattern>
26+
</encoder>
27+
</appender>
28+
29+
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
30+
<file>${gravitee.home}/logs/gravitee.log</file>
31+
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
32+
<!-- daily rollover -->
33+
<fileNamePattern>${gravitee.home}/logs/gravitee_%d{yyyy-MM-dd}.log</fileNamePattern>
34+
35+
<!-- keep 30 days' worth of history -->
36+
<maxHistory>30</maxHistory>
37+
</rollingPolicy>
38+
39+
<encoder>
40+
<pattern>%d{HH:mm:ss.SSS} [%thread] [%X{api}] %-5level %logger{36} - %msg%n</pattern>
41+
</encoder>
42+
</appender>
43+
44+
<appender name="async-file" class="ch.qos.logback.classic.AsyncAppender">
45+
<appender-ref ref="FILE" />
46+
</appender>
47+
48+
<appender name="async-console" class="ch.qos.logback.classic.AsyncAppender">
49+
<appender-ref ref="STDOUT" />
50+
</appender>
51+
52+
<logger name="io.gravitee" level="INFO" />
53+
<logger name="com.graviteesource" level="INFO" />
54+
<logger name="org.reflections" level="WARN" />
55+
<logger name="org.springframework" level="WARN" />
56+
<logger name="org.eclipse.jetty" level="WARN" />
57+
58+
<!-- Strictly speaking, the level attribute is not necessary since -->
59+
<!-- the level of the root level is set to DEBUG by default. -->
60+
<root level="WARN">
61+
<appender-ref ref="async-console" />
62+
<appender-ref ref="async-file" />
63+
</root>
64+
65+
</configuration>

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-server/gravitee.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
management:
2+
type: mongodb
3+
mongodb:
4+
uri: mongodb://mongodb:27017/gravitee?serverSelectionTimeoutMS=5000
5+
6+
ratelimit:
7+
type: mongodb
8+
mongodb:
9+
uri: mongodb://mongodb:27017/gravitee?serverSelectionTimeoutMS=5000
10+
11+
cluster:
12+
type: hazelcast
13+
hazelcast:
14+
config-path: /opt/graviteeio-gateway/config/hazelcast.xml
15+
16+
distributed-sync:
17+
type: redis
18+
redis:
19+
host: redis-stack
20+
port: 6379
21+
22+
services:
23+
sync:
24+
repository:
25+
enabled: true
26+
distributed:
27+
enabled: true
28+
bridge:
29+
http:
30+
enabled: true
31+
port: 18092
32+
host: 0.0.0.0
33+
authentication:
34+
type: none

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-server/hazelcast.xml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
The following is given as a simple example to enable hazelcast cluster on local environment.
5+
It will be used when cluster.type: hazelcast is set in gravitee.yml.
6+
7+
For advanced configuration, please refer to official documentation: https://docs.hazelcast.com/imdg/4.2/clusters/discovery-mechanisms
8+
-->
9+
<hazelcast xmlns="http://www.hazelcast.com/schema/config"
10+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
11+
xsi:schemaLocation="http://www.hazelcast.com/schema/config
12+
http://www.hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
13+
14+
<cluster-name>gio-apim-gateway-cluster-bridge</cluster-name>
15+
<network>
16+
<port auto-increment="true" port-count="100">5701</port>
17+
<join>
18+
<auto-detection enabled="true"/>
19+
<multicast enabled="false"/>
20+
<tcp-ip enabled="true">
21+
<member>gateway_client</member>
22+
<member>gateway_client_2</member>
23+
<member>gateway_server</member>
24+
</tcp-ip>
25+
</join>
26+
</network>
27+
</hazelcast>

‎docker/quick-setup/distributed-sync-bridge/.config/gateway-server/logback.xml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
~ Copyright (c) 2015-2016, The Gravitee team (http://www.gravitee.io)
5+
~
6+
~ Licensed under the Apache License, Version 2.0 (the "License");
7+
~ you may not use this file except in compliance with the License.
8+
~ You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing, software
13+
~ distributed under the License is distributed on an "AS IS" BASIS,
14+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
~ See the License for the specific language governing permissions and
16+
~ limitations under the License.
17+
-->
18+
19+
<configuration>
20+
21+
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
22+
<!-- encoders are assigned the type
23+
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
24+
<encoder>
25+
<pattern>%d{HH:mm:ss.SSS} [%thread] [%X{api}] %-5level %logger{36} - %msg%n</pattern>
26+
</encoder>
27+
</appender>
28+
29+
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
30+
<file>${gravitee.home}/logs/gravitee.log</file>
31+
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
32+
<!-- daily rollover -->
33+
<fileNamePattern>${gravitee.home}/logs/gravitee_%d{yyyy-MM-dd}.log</fileNamePattern>
34+
35+
<!-- keep 30 days' worth of history -->
36+
<maxHistory>30</maxHistory>
37+
</rollingPolicy>
38+
39+
<encoder>
40+
<pattern>%d{HH:mm:ss.SSS} [%thread] [%X{api}] %-5level %logger{36} - %msg%n</pattern>
41+
</encoder>
42+
</appender>
43+
44+
<appender name="async-file" class="ch.qos.logback.classic.AsyncAppender">
45+
<appender-ref ref="FILE" />
46+
</appender>
47+
48+
<appender name="async-console" class="ch.qos.logback.classic.AsyncAppender">
49+
<appender-ref ref="STDOUT" />
50+
</appender>
51+
52+
<logger name="io.gravitee" level="INFO" />
53+
<logger name="com.graviteesource" level="INFO" />
54+
<logger name="org.reflections" level="WARN" />
55+
<logger name="org.springframework" level="WARN" />
56+
<logger name="org.eclipse.jetty" level="WARN" />
57+
58+
<!-- Strictly speaking, the level attribute is not necessary since -->
59+
<!-- the level of the root level is set to DEBUG by default. -->
60+
<root level="WARN">
61+
<appender-ref ref="async-console" />
62+
<appender-ref ref="async-file" />
63+
</root>
64+
65+
</configuration>

‎docker/quick-setup/distributed-sync-bridge/README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Gateway with Bridge HTTP and Distributed Sync
2+
3+
Here is a docker-compose to run APIM with two or three gateways:
4+
- One as a **Bridge Server.** It can make calls to the database and expose HTTP endpoints to be able to call the database.
5+
- Two as a **Bridge Client.** It calls the Gateway Bridge Server through HTTP to fetch data.
6+
7+
You can classically call your apis through any of your client gateway, for example: `http://localhost:8082/myapi` or `http://localhost:8081/myapi` .
8+
9+
To test the **Bridge Server**, you can call, for example, `http://localhost:18092/_bridge/apis` to list all the apis directly from database.
10+
11+
## How to run ?
12+
13+
⚠️ You need a license file to be able to run Enterprise Edition of APIM. Do not forget to add your license file into `./.license`.
14+
15+
`APIM_VERSION={APIM_VERSION} docker-compose up -d `
16+
17+
To be sure to fetch last version of images, you can do
18+
`export APIM_VERSION={APIM_VERSION} && docker-compose down -v && docker-compose pull && docker-compose up`
19+
20+
If you want to run only one client gateway first and then the other, you can do
21+
`export APIM_REGISTRY=graviteeio.azurecr.io && export APIM_VERSION=master-latest && docker compose up -d redis-stack mongodb elasticsearch gateway_server gateway_client management_api management_ui`
22+
23+
and then to start the second client gateway, you can do
24+
`export APIM_REGISTRY=graviteeio.azurecr.io && export APIM_VERSION=master-latest && docker compose up -d gateway_client_2`
25+
26+
To see what is inside Redis, for example the distributed sync data, you can do
27+
`redis-cli`
28+
29+
and then inside redis-cli, you can do
30+
`Keys distributed*`
31+
32+
## Scenario Testing
33+
34+
Below is the scenario to test distributed sync process with Bridge Server. Logs/Info/Success messages are printed as output.
35+
36+
### Scenario: Test that a new gateway must sync without access to DB
37+
38+
Run the script `test-bridge-crash-new-gateway-sync.sh`.
39+
40+
The script above starts all the services along with bridge server.
41+
It then kills the bridge server and the database, adds a new gateway and verifies that it synced via redis.

0 commit comments

Comments
 (0)