|
| 1 | +# Redisearch-Digital-Banking-redistemplate |
| 2 | + |
| 3 | +Provides a quick-start example of using Redis with springBoot with Banking structures. Digital Banking uses an API microservices approach to enable high speed requests for account, customer and transaction information. As seen below, this data is useful for a variety of business purposes in the bank. |
| 4 | +<a href="" rel="Digital Banking"><img src="images/DigitalBanking.png" alt="" /></a> |
| 5 | + |
| 6 | +### Note: This is the same as Redisearch-Digital-Banking but uses redistemplate instead of any of the crudrepository indexes. redisearch 2.0 indexes will be used. This is not using the crudrepository for the basic redis data. |
| 7 | + |
| 8 | +## Overview |
| 9 | +In this tutorial, a java spring boot application is run through a jar file to support typical API calls to a REDIS banking data layer. A redis docker configuration is included. |
| 10 | + |
| 11 | +## Redis Advantages for Digital Banking |
| 12 | + * Redis easily handles high write transaction volume |
| 13 | + * Redis has no tombstone issues and can upsert posted transactions over pending |
| 14 | + * Redis Enterprise scales vertically (large nodes) and horizontally (many nodes) |
| 15 | + * Redisearch 2.0 automatically indexes the hash structure created by Spring Java CRUD repository |
| 16 | + |
| 17 | +## Requirements |
| 18 | +* Docker installed on your local system, see [Docker Installation Instructions](https://docs.docker.com/engine/installation/). |
| 19 | +* Alternatively, can run Redis Enterprise and set the redis host and port in the application.properties file |
| 20 | +* When using Docker for Mac or Docker for Windows, the default resources allocated to the linux VM running docker are 2GB RAM and 2 CPU's. Make sure to adjust these resources to meet the resource requirements for the containers you will be running. More information can be found here on adjusting the resources allocated to docker. |
| 21 | + |
| 22 | +[Docker for mac](https://docs.docker.com/docker-for-mac/#advanced) |
| 23 | +[Docker for windows](https://docs.docker.com/docker-for-windows/#advanced) |
| 24 | + |
| 25 | +## Links that help! |
| 26 | + |
| 27 | + * [Redis Stack](https://redis.com/blog/introducing-redis-stack/) |
| 28 | + * [Redis Search](https://redis.io/docs/stack/search/) |
| 29 | + * [Redis Insight](https://redis.io/docs/stack/insight/) |
| 30 | + * [Spring Data for Redis github](https://github.com/spring-projects/spring-data-examples/tree/master/redis/repositories) |
| 31 | + * [Spring Data for Cassandra](https://www.baeldung.com/spring-data-cassandra-tutorial) |
| 32 | + * [Spring Data for Kafka](https://www.baeldung.com/spring-kafka) |
| 33 | + * [spring data Reference in domain](https://github.com/spring-projects/spring-data-examples/blob/master/redis/repositories/src/main/java/example/springdata/redis/repositories/Person.java) |
| 34 | + * [spring async tips](https://dzone.com/articles/effective-advice-on-spring-async-part-1) |
| 35 | + * [swagger-ui with spring](https://www.baeldung.com/spring-rest-openapi-documentation) |
| 36 | + * |
| 37 | + |
| 38 | + |
| 39 | +## Technical Overview |
| 40 | + |
| 41 | +This github java code uses jedis library for redis. The jedis library supports RediSearch, RedisJSON, and RedisTimeSeries. The original github only used spring java without redisearch. That repository is still intact at [this github location](https://github.com/jphaugla/Redis-Digital-Banking). Another subsequent version uses crud repository and search at [this github location](https://github.com/jphaugla/Redisearch-Digital-Banking) |
| 42 | +All of the Spring Java indexes have been removed in this version. The crud repository has been removed. |
| 43 | +### The spring java code |
| 44 | +This is basic spring links |
| 45 | +* [Spring Redis](https://docs.spring.io/spring-data/data-redis/docs/current/reference/html/#redis.repositories.indexes) |
| 46 | +* *boot*-Contains index creation for each of the four redisearch indexes used in this solution: Account, Customer, Merchant, and Transaction |
| 47 | +* *config*-Initial configuration module using autoconfiguration and a threadpool sizing to adjust based on machine size |
| 48 | +* *controller*-http API call interfaces |
| 49 | +* *data*-code to generate POC type of customer, account, and transaction code |
| 50 | +* *domain*-has each of the java objects with their columns. Enables all the getter/setter methods |
| 51 | +* *repository*-has repository definitions. With transition to redisearch 2.0, not used as heavily as previously. This is where the redistemplate code is added if crud repository is no longer used. Cassandra transaction repository is also here. |
| 52 | +* *service*-asyncservice, topicproducer (kafka) and bankservice doing the interaction with redis |
| 53 | +### |
| 54 | +The java code demonstrates common API actions with the data layer in REDIS. The java spring Boot framework minimizes the amount of code to build and maintain this solution. Maven is used to build the java code and the code is deployed to the tomcat server. |
| 55 | + |
| 56 | +### Data Structures in use |
| 57 | +<a href="" rel="Tables Structures Used"><img src="images/Tables.png" alt="" /></a> |
| 58 | + |
| 59 | +## Using Docker for non-application components |
| 60 | +This option uses docker to support all of the non-application components (kafka, cassandra, redis) with the java application running on the local mac. |
| 61 | +* Prepare Docker environment-see the Prerequisites section above... |
| 62 | +* Pull this github into a directory |
| 63 | +```bash |
| 64 | +git clone https://github.com/jphaugla/Redisearch-Digital-Banking.git |
| 65 | +``` |
| 66 | +* Refer to the notes for redis Docker images used but don't get too bogged down as docker compose handles everything except for a few admin steps on tomcat. |
| 67 | + * [Redis stack docker instructions](https://redis.io/docs/stack/get-started/install/docker/) |
| 68 | +* Open terminal and change to the github home where you will see the docker-compose.yml file, then: |
| 69 | +```bash |
| 70 | +docker-compose -f docker-compose-kafka.yml -f docker-compose.yml -f docker-compose-cassandra.yml up -d |
| 71 | +``` |
| 72 | +## Deploying java application on local mac with Kafka non-application components |
| 73 | +* ensure maven and java are deployed on the local machine |
| 74 | + * have been running with java 17 or java 18 but other versions should work as well |
| 75 | + * have been runing with 3.9.4 and 3.9.5 |
| 76 | +* Set up the environment and run the java application locally |
| 77 | + * edit the [environment file](scripts/setEnv.sh) to use localhost for non-application components |
| 78 | + * source this environment file |
| 79 | + * run the application |
| 80 | +```bash |
| 81 | +source scripts/setEnv.sh |
| 82 | +java -jar target/redis-0.0.1-SNAPSHOT.jar |
| 83 | +``` |
| 84 | + |
| 85 | +## Using terraform on azure for all components |
| 86 | +<a href="" rel="Deployment"><img src="images/deployment.png" alt="" /></a> |
| 87 | +* Use [this github](https://github.com/jphaugla/tfmodule-azure-redis-enterprise) to deploy all of the components (including the application) |
| 88 | +* Check the [readme](https://github.com/jphaugla/tfmodule-azure-redis-enterprise/README.md) for the details on deploying this github including the cloning the github and working with Azure. Completely deploy the terraform github for all deployments. This will also deploy [this github](https://github.com/jphaugla/Redisearch-Digital-Banking-redisTemplate) inside the tester node. The later application deployment instructions will be deployed within the tester node using ssh |
| 89 | +* maven and java will be installed by the ansible jobs for the tester node |
| 90 | +* the ip and dns information is shared in a [temp directory](https://github.com/jphaugla/tfmodule-azure-redis-enterprise/provisioners/temp) within the terraform/ansible repository. Go to the files here to see private (internal) and public (external) kafka node, cassandra node and testinnode IP addresses. The redis internal and external database connection dns names are also available. These dns names will also give an internal and external redis enterprise node IP. |
| 91 | +* log into the tester node using the testernode IP and the ssh key defined in test/main.tf and go to github home |
| 92 | +```bash |
| 93 | +ssh -i <azure key> redislabs@<testerIP> |
| 94 | +cd Redisearch-Digital-Banking-redisTemplate |
| 95 | +``` |
| 96 | +* edit the [environment file](scripts/setEnv.sh) using only the internal connection addresses. NOTE: kafka will only connect from local azure IP addresses and not any public IP addresses. Using public and private Kafka addresses is possible but not configured currently |
| 97 | +* These steps can all be done from client machine local browser using the kafka node public IP address and port 9021. [http://172.172.133.201:9021/](http://172.172.133.201:9021/) From this home screen, pause the currently running connectors: datagen-pageviews, cassanddra-sink, and redis-sink-json using the Kafka Control Center. This will just remove the noise of a second application running. |
| 98 | +* Consider cleaning both the redis (use flushdb) and cassandra databases as well (drop keyspace pageviews) |
| 99 | +* Create transaction table in cassandra using provided script |
| 100 | +```bash |
| 101 | +cd scripts |
| 102 | +# edit the CQLSH_HOST variable inside the script for the cassandra host pubic IP address |
| 103 | +./createCassandraTrans.sh |
| 104 | +``` |
| 105 | +* start the application after logging in to the testernode |
| 106 | +```bash |
| 107 | +ssh -i ~/.ssh/<sshkey> redislabs@<testernode public ip> |
| 108 | +cd Redisearch-Digital-Banking-redisTemplate |
| 109 | +mvn clean package |
| 110 | +# edit scripts/setEnv.sh for current nodes - REDIS_HOST, REDIS_PORT, and KAFKA_HOST must all change to match current environment. *IMPORTANT* only use private/internal IP addresses-DO NOT USE *localhost*. Additional note, redis password is different in local docker version and in ansible created version-verify redis password! |
| 111 | +source scripts/setEnv.sh |
| 112 | +java -jar target/redis-0.0.1-SNAPSHOT.jar |
| 113 | +``` |
| 114 | +* get a second terminal window to the tester node and write a test message to kafka-this will cause the topic to be created. Name can be changed in [application.properties](src/main/resources/application.properites) but default topic name is *transactions* |
| 115 | +```bash |
| 116 | +ssh -i ~/.ssh/<sshkey> redislabs@<testernode public ip> |
| 117 | +cd Redisearch-Digital-Banking-redisTemplate/scripts |
| 118 | +# make sure saveTransaction script says doKafka=true |
| 119 | +./saveTransaction.sh |
| 120 | +``` |
| 121 | +* verify transactions topic is created using kafka control center |
| 122 | + * in control center click on topics and then on the topics page, click messages |
| 123 | + * if you run saveTransaction.sh again while looking at the control center topic pane, the message will be visible. If you put offset of 0, both messages will be visible. |
| 124 | + * application will create the kafka topic on first usage of the topic. |
| 125 | +* Call kafka API to create the RedisSink using provided script. DO THIS FROM your local Mac |
| 126 | +```bash |
| 127 | +cd Redisearch-Digital-Banking-redisTemplate/scripts |
| 128 | +# change localhost to the external/public ip address for the kafka node in the last line. |
| 129 | +# Make sure this is the public kafka IP and not the private |
| 130 | +# Verify the redis.uri and redis.password. (the redis.uri must be INTERNAL) |
| 131 | +./createRedisSink.sh |
| 132 | +ssh -i ~/.ssh/<sshkey> redislabs@<testernode public ip> |
| 133 | +./saveTransaction.sh |
| 134 | +``` |
| 135 | +verify data flowed in to redis using redis-cli |
| 136 | +```bash |
| 137 | +redis-cli -h <redis_external_endpoint.txt> -p <redis_port.txt> -a redis123 |
| 138 | +>keys Trans* |
| 139 | + |
| 140 | + |
| 141 | +* Call an Api to create the cassandra sink using provided script |
| 142 | +```bash |
| 143 | +# on local mac |
| 144 | +cd Redisearch-Digital-Banking-redisTemplate/scripts |
| 145 | +# change localhost to the public ip address for the kafka node in the last line. |
| 146 | +# Set the contactPoints to the local IP address for the cassandra node. |
| 147 | +./createCassandraSink.sh |
| 148 | +ssh -i ~/.ssh/<sshkey> redislabs@<testernode public ip> |
| 149 | +./saveTransaction.sh |
| 150 | +``` |
| 151 | +verify data flowed in to cassandra using cqlsh |
| 152 | + |
| 153 | +## process larger record set |
| 154 | +verify generateData.sh says doKafkfa=true |
| 155 | +```bash |
| 156 | +./scripts/generateData.sh |
| 157 | +``` |
| 158 | +Will see large number of records now in cassandra and redis |
| 159 | + |
| 160 | +Shows a benchmark test run of generateData.sh on GCP servers. Although, this test run is using redisearch 1.0 code base. Need to rerun this test. |
| 161 | +<a href= "" rel= "Generate Data Benchmark"><img src= "images/Benchmark.png" alt= "" /></a > |
| 162 | + |
| 163 | +### Investigate the APIs |
| 164 | +#### Use swagger UI |
| 165 | +* [open api docs](http://localhost:8080/v3/api-docs) |
| 166 | +* [use swagger ui](http://localhost:8080/swagger-ui/index.html) |
| 167 | +#### run bash scripts in ./scripts. Adding the redisearch queries behind each script here also... |
| 168 | + * addTag.sh - add a tag to a transaction. Tags allow user to mark transactions to be in a buckets such as Travel or Food for budgetary tracking purposes |
| 169 | + * deleteCustomer.sh - delete all customers matching a string |
| 170 | + * generateData.sh - simple API to generate default customer, accounts, merchants, phone numbers, emails and transactions |
| 171 | + * generateLots.sh - for server testing to generate higher load levels. Use with startAppservers.sh. Not for use with docker setup. This is load testing with redis enterprise and client application running in same network in the cloud. |
| 172 | + * getByAccount.sh - find transactions for an account between a date range |
| 173 | + * getByCreditCard.sh - find transactions for a credit card between a date range |
| 174 | + * getByCustID.sh - retrieve transactions for customer |
| 175 | + * getByEmail.sh - retrieve customer record using email address |
| 176 | + * getByMerchant.sh - find all transactions for an account from one merchant for date range |
| 177 | + * getByMerchantCategory.sh - find all transactions for an account from merchant category for date range |
| 178 | + * getByNamePhone.sh - get customers by phone and full name. |
| 179 | + * getByPhone.sh - get customers by phone only |
| 180 | + * getByStateCity.sh - get customers by city and state |
| 181 | + * getByZipLastname.sh - get customers by zipcode and lastname. |
| 182 | + * getReturns.sh - get returned transactions count by reason code |
| 183 | + * getTags.sh - get all tags on an account |
| 184 | + * getTaggedAccountTransactions.sh - find transactions for an account with a particular tag |
| 185 | + * getTransaction.sh - get one transaction by its transaction ID |
| 186 | + * getTransactionStatus.sh - see count of transactions by account status of PENDING, AUTHORIZED, SETTLED |
| 187 | + * putCustomer.sh - put a set of json customer records |
| 188 | + * saveAccount.sh - save a sample account |
| 189 | + * saveCustomer.sh - save a sample customer |
| 190 | + * saveTransaction.sh - save a sample Transaction |
| 191 | + * startAppservers.sh - start multiple app server instances for load testing |
| 192 | + * testPipeline.sh - test pipelining |
| 193 | + * updateTransactionStatus.sh - generate new transactions to move all transactions from one transaction Status up to the next transaction status. Parameter is target status. Can choose SETTLED or POSTED. Will move 100,000 transactions per call |
| 194 | + * putDispute.sh - put the dispute specified in dispute.sh |
| 195 | + * disputeReasonCode.sh - set the dispute reason code |
| 196 | + * disputeAccept.sh - accept the dispute |
| 197 | + * disputeResolved.sh - charge back the dispute |
| 198 | + |
0 commit comments