Skip to content

Commit 733601c

Browse files
committed
oracle demo updates
1 parent 95ee65d commit 733601c

File tree

2 files changed

+34
-19
lines changed

2 files changed

+34
-19
lines changed

connectors/oracle/demo/README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,26 @@
33
* Docker compatible [*nix OS](https://en.wikipedia.org/wiki/Unix-like) and [Docker](https://docs.docker.com/get-docker) installed.
44
* Please have 8 vCPU*, 8GB RAM and 50GB storage for this demo to function properly. Adjust the resources based on your requirements. For HA, at least have 2 Redis Connect Connector instances deployed on separate hosts.
55
* [Oracle JDBC Driver](https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html) (`ojdbc8.jar`)
6-
<div class="notecard note">
7-
<h4>Note</h4>
8-
<p>We can not include the Oracle JDBC Driver due to licensing requirement. Please obtain the Oracle client jar following the link above or get a copy from your existing Oracle installation.</p>
9-
</div>
106

11-
<br>Execute the following commands (copy & paste) to download and setup Redis Connect Oracle Connector and demo scripts.
12-
i.e.</br>
7+
| :exclamation: IMPORTANT |
8+
| :-----------------------------|
9+
| We can not include the Oracle JDBC Driver due to licensing requirement. Please obtain the Oracle client jar following the link above or get a copy from your existing Oracle installation. |
10+
11+
<p>Execute the following commands (copy & paste) to download and setup Redis Connect Oracle Connector and demo scripts.
12+
i.e.</p>
13+
1314
```bash
1415
wget -c https://github.com/redis-field-engineering/redis-connect-dist/archive/main.zip && \
1516
mkdir -p redis-connect-oracle/demo && \
16-
unzip main.zip "redis-connect-dist-main/connectors/oracle/demo/*" -d redis-connect-oracle/demo && \
17-
cp -R redis-connect-oracle/demo/redis-connect-dist-main/connectors/oracle/demo/* redis-connect-oracle/demo && \
18-
mv redis-connect-oracle/demo/config redis-connect-oracle && \
19-
rm -rf main.zip redis-connect-oracle/demo/redis-connect-dist-main && \
17+
mkdir -p redis-connect-oracle/k8s-docs && \
18+
unzip main.zip "redis-connect-dist-main/connectors/oracle/*" -d redis-connect-oracle && \
19+
cp -R redis-connect-oracle/redis-connect-dist-main/connectors/oracle/demo/* redis-connect-oracle/demo && \
20+
cp -R redis-connect-oracle/redis-connect-dist-main/connectors/oracle/k8s-docs/* redis-connect-oracle/k8s-docs && \
21+
rm -rf main.zip redis-connect-oracle/redis-connect-dist-main && \
2022
cd redis-connect-oracle && \
2123
chmod a+x demo/*.sh
2224
```
25+
2326
Expected output:
2427
```bash
2528
redis-connect-oracle$ ls
@@ -29,12 +32,14 @@ config demo
2932
## Setup Oracle database in docker (Source)
3033

3134
<br>Execute [setup_oracle.sh](setup_oracle.sh)</br>
32-
<u>Oracle 12c and 18c:</u>
35+
_**Oracle 12c and 18c:**_
36+
3337
```bash
3438
redis-connect-oracle$ cd demo
3539
demo$ ./setup_oracle.sh 12.2.0.1-ee 1521 logminer
3640
```
37-
<u>Oracle 19c:</u> Currently redis-connect-oracle does not support CDC with 19c but works with Initial load.
41+
_**Oracle 19c:**_ Currently redis-connect-oracle does not support CDC with 19c but works with Initial load.
42+
3843
```bash
3944
demo$ ./setup_oracle.sh 19.3.0-ee 1522 logminer
4045
```
@@ -148,14 +153,19 @@ demo$ docker exec -it re-node1 bash -c "redis-cli -p 12000 FT._LIST"
148153
</details>
149154
150155
---
151-
**NOTE**
156+
157+
| :memo: |
158+
|---------------|
152159
153160
The above script will create a 1-node Redis Enterprise cluster in a docker container, [Create a target database with RediSearch module](https://docs.redislabs.com/latest/modules/add-module-to-database/), [Create a job management and metrics database with RedisTimeSeries module](https://docs.redislabs.com/latest/modules/add-module-to-database/), [Create a RediSearch index for emp Hash](https://redislabs.com/blog/getting-started-with-redisearch-2-0/) and [Start an instance of RedisInsight](https://docs.redislabs.com/latest/ri/installing/install-docker/).
154161
155162
---
156163
157164
## Start Redis Connect Oracle Connector
158165
166+
| :point_up: | Don't forget to download and copy the Oracle client jar into the extlib folder i.e. ```bash demo$ cp ojdbc8.jar extlib``` |
167+
|---------------|:--------------------------|
168+
159169
<details><summary>Run Redis Connect Oracle Connector docker container to see all the options</summary>
160170
<p>
161171
@@ -169,6 +179,7 @@ docker run \
169179
-e REDISCONNECT_SOURCE_PASSWORD=redisconnectpassword \
170180
-e REDISCONNECT_JAVA_OPTIONS="-Xms256m -Xmx256m" \
171181
-v $(pwd)/../config:/opt/redislabs/redis-connect-oracle/config \
182+
-v $(pwd)/../extlib:/opt/redislabs/redis-connect-oracle/extlib \
172183
--net host \
173184
redislabs/redis-connect-oracle:pre-release-alpine
174185
```
@@ -256,6 +267,7 @@ docker run \
256267
-e REDISCONNECT_SOURCE_PASSWORD=hr \
257268
-e REDISCONNECT_JAVA_OPTIONS="-Xms256m -Xmx256m" \
258269
-v $(pwd)/../config:/opt/redislabs/redis-connect-oracle/config \
270+
-v $(pwd)/../extlib:/opt/redislabs/redis-connect-oracle/extlib \
259271
--net host \
260272
redislabs/redis-connect-oracle:pre-release-alpine stage
261273
```
@@ -314,6 +326,7 @@ docker run \
314326
-e REDISCONNECT_SOURCE_PASSWORD=hr \
315327
-e REDISCONNECT_JAVA_OPTIONS="-Xms256m -Xmx1g" \
316328
-v $(pwd)/../config:/opt/redislabs/redis-connect-oracle/config \
329+
-v $(pwd)/../extlib:/opt/redislabs/redis-connect-oracle/extlib \
317330
--net host \
318331
redislabs/redis-connect-oracle:pre-release-alpine start
319332
```
@@ -400,6 +413,7 @@ docker run \
400413
-e REDISCONNECT_SOURCE2_PASSWORD=hr \
401414
-e REDISCONNECT_JAVA_OPTIONS="-Xms256m -Xmx256m" \
402415
-v $(pwd)/../config:/opt/redislabs/redis-connect-oracle/config \
416+
-v $(pwd)/../extlib:/opt/redislabs/redis-connect-oracle/extlib \
403417
--net host \
404418
redislabs/redis-connect-oracle:pre-release-alpine stage
405419
```
@@ -464,6 +478,7 @@ docker run \
464478
-e REDISCONNECT_SOURCE2_PASSWORD=hr \
465479
-e REDISCONNECT_JAVA_OPTIONS="-Xms256m -Xmx1g" \
466480
-v $(pwd)/../config:/opt/redislabs/redis-connect-oracle/config \
481+
-v $(pwd)/../extlib:/opt/redislabs/redis-connect-oracle/extlib \
467482
--net host \
468483
redislabs/redis-connect-oracle:pre-release-alpine start
469484
```

connectors/oracle/k8s-docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Overall flow:
1010
5. Stage the Redis Connect job.
1111
6. Start the Redis Connect job.
1212

13-
**Note:** This doc uses `kubectl` and `oc` interchangably.
13+
**Note:** This doc uses `kubectl` and `oc` interchangeably.
1414

1515
## 1. Clone the Redis Connect for Oracle Repository
16+
17+
Follow the [demo](../demo) steps then goto k8s-docs directory
1618
```
17-
$ git clone https://github.com/redis-field-engineering/redis-connect-dist.git
18-
...
19-
$ cd redis-connect-dist/connectors/oracle/k8s-docs
19+
redis-connect-oracle$ cd k8s-docs
2020
```
2121

2222
## 2. Configure Redis Connect
@@ -35,8 +35,8 @@ Details for configuring Redis Connect for Oracle are <a href="../demo/" target="
3535

3636
This deployment requires the use of K8s ConfigMaps. The necessary config maps will be uploaded from your local directories using the commands below.
3737

38-
```
39-
$ cd ../demo/config/samples/oracle
38+
```bash
39+
k8s-docs$ cd ../demo/config/samples/oracle
4040
demo/config/samples/oracle$ ls
4141
FormatterConfig.yml JobManager.yml env.yml templates/
4242
JobConfig.yml Setup.yml mappers/

0 commit comments

Comments
 (0)