Merge branch 'main' of https://github.com/Redislabs-Solution-Architects/redisbank

Author: NLxAROSA

openshift/README.md

@@ -0,0 +1,152 @@
+## Install and Configure Java
+
+> Note: this is an optional step, you can use any Java version starting from 11 and above
+
+Install Java 17 on your local machine:
+```
+❯ tar xvf OpenJDK17U-jdk_x64_linux_hotspot_17.0.2_8.tar.gz
+
+❯ sudo mv jdk-17.0.2+8 /opt/java/
+```
+
+Add Java to the profile:
+```
+❯ nano .profile
+```
+
+Modify the file:
+```
+# adding java to the path
+PATH=$PATH:/opt/java/jdk-17.0.2+8/bin:/opt/java/jdk-17.0.2+8/lib
+JAVA_HOME=/opt/java/jdk-17.0.2+8
+```
+
+Reload the profile and check java version
+```
+❯ source .profile
+❯ java -version
+```
+
+Configure the VSCode (add to your settings.json):
+
+```
+    "java.configuration.runtimes": [
+        {
+          "name": "JavaSE-17",
+          "path": "/opt/java/jdk-17.0.2+8",
+          "default": true
+        },
+      ]
+```
+
+## Install Redis Operator and Create Redis Cluster
+
+> Note: you should already have your OpenShift cluster installed and configured at this point. Check [RedHat documentation](https://docs.openshift.com/container-platform/4.9/installing/index.html) for details.
+
+> Note: you also need to have OpenShift CLI installed on your local machine. Check [RedHat documentation](https://docs.openshift.com/container-platform/4.9/cli_reference/openshift_cli/getting-started-cli.html) on how to get it installed.
+
+Export KUBECONFIG to point to your OpenShift cluster config:
+```
+export KUBECONFIG=/<your-cluster-configuration-dir>/auth/kubeconfig
+```
+
+Create the new project (namespace) for Redis cluster:
+```
+oc new-project redis-ent-dev
+```
+Follow [this documentation](https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/openshift/OLM) to find and install _Redis Enterprise Operator_ in the OperatorHub - make sure to install it to the project you created in the prior step:
+![](images/install_operator.png)
+
+> Note: this guide was created to simplify the deployment of RedisBank application in OpenShift environment. For production workloads you almost always want to deploy your workloads separately (to a different namespace) from Redis Enterprise namespace. 
+
+## Create Redis Database
+
+First, create a secret for a default user in your database:
+
+```
+oc apply -f bankdb-pwd.yaml
+```
+
+> Note: if you want to modify the password, make sure you also change it in the `openshift` configuration for the application (application-openshift.properties).
+
+To create a new database you can use the [provided resource file](bankdb.yaml):
+
+> Note: modify the name and namespace for your database accordingly
+
+> Note: the list of modules that the cluster supports can be found at the very bottom of your REC cluster YAML file:
+
+![](images/modules_versions.png)
+
+```
+oc apply -f bankdb.yaml
+```
+
+## Build and Deploy the Application
+
+We are going to use [Eclipse JKube Maven Plugin](https://www.eclipse.org/jkube/docs/openshift-maven-plugin#_configuration) for Kubernetes and OpenShift to automate the resources creation and also implement S2I (source to image) build process that is often used in OpenShift environment.
+
+### Configure
+
+In `pom.xml` add [jkube](https://github.com/eclipse/jkube/tree/master/openshift-maven-plugin) maven plugin - it will help to generate the required resources and deploy the application to OpenShift:
+
+```
+<plugin>
+	<groupId>org.eclipse.jkube</groupId>
+	<artifactId>openshift-maven-plugin</artifactId>
+	<version>1.7.0</version>
+</plugin>
+```
+
+In `src/main/resources/application-openshift.properties` change the following settings:
+
+```
+# stomp.host=<app-name-namespace>.apps.<cluster-name>.<dns-zone>
+# for example:
+stomp.host=redisbank-redis-ent-dev.apps.c1.openshift.demo.redislabs.com
+stomp.protocol=ws
+stomp.port=80
+spring.redis.host=bankdb
+spring.redis.port=12869
+spring.redis.password=redisbank
+```
+
+> Note: make sure your application is using the `openshift` profile. One way to set this in a Spring application is to modify the `application.properties` file:
+
+```
+spring.profiles.active=openshift
+```
+
+### Build Locally
+
+This will create and repackage the jar file with all the required resources:
+
+```
+./mvnw clean package -Dmaven.test.skip=true
+```
+
+### Build Remotely
+
+This command will trigger the remote S2I build process. It will also create the _ImageSet_ and the _BuildConfig_ in your OpenShift cluster if not created yet:
+
+```
+./mvnw oc:build -Dmaven.test.skip=true 
+```
+
+### Deploy
+
+Generate the _DeploymentConfig_ resources for your application:
+```
+./mvnw oc:resource
+```
+
+Apply the resources to create the _DeploymentConfig_, _Service_ and _Route_ generated in a previous step:
+
+```
+./mvnw oc:apply
+```
+
+> Note: you can use the undeploy command: `./mvnw oc:undeploy` if you need to undepoy the application completely
+
+At this point of time your application is already deployed and supposed to be up and running. Go check the your Openshift web console on the status and pull the route url to access the app from your browser. This will typically look like this:
+
+`http://redisbank-<namespace>.<cluster-name>.<dns-zone>`

openshift/bankdb-pwd.yaml

@@ -0,0 +1,7 @@
+kind: Secret
+apiVersion: v1
+metadata:
+  name: bankdb-pwd
+data:
+  password: cmVkaXNiYW5r
+type: Opaque

openshift/bankdb.yaml

@@ -0,0 +1,18 @@
+apiVersion: app.redislabs.com/v1alpha1
+kind: RedisEnterpriseDatabase
+metadata:
+  name: bankdb
+  namespace: redis-ent-dev
+spec:
+  modulesList:
+    - name: search
+      version: 2.2.6
+    - name: timeseries
+      version: 1.4.13
+  redisEnterpriseCluster:
+    name: rec
+  shardCount: 2
+  shardsPlacement: dense
+  databasePort: 12869
+  databaseSecretName: bankdb-pwd 
+  memorySize: 1GB

openshift/images/install_operator.png

@@ -0,0 +1,26 @@
+# Properties for running inside OpenShift cluster:
+# ===============================================
+# stomp.host=<app-name>-<namespace>.apps.<cluster-name>.<dns-zone>
+# for example, if you have the following properties:
+#   app-name = redisbank
+#   namespace = redis-ent-dev
+#   cluster-name = c1
+#   dns-zone = openshift.demo.redislabs.com
+# then your host will be the following:
+# stomp.host=redisbank-redis-ent-dev.apps.c1.openshift.demo.redislabs.com
+stomp.host=redisbank-redis-ent-dev.apps.c1.openshift.demo.redislabs.com
+# ws | wss for websockets OR websockets secured accordingly
+stomp.protocol=ws
+# the default route will be 80 for http and 443 for https
+stomp.port=80
+# the service name of your database, get it using the command below:
+#   oc get secret redb-bankdb -o jsonpath="{.data.service_names}" | base64 --decode
+spring.redis.host=bankdb
+# the port of your database, get it using the command below:
+#   oc get secret redb-bankdb -o jsonpath="{.data.port}" | base64 --decode
+spring.redis.port=12869
+# password for the default user to your database, get it using the command below:
+#   oc get secret redb-bankdb -o jsonpath="{.data.password}" | base64 --decode
+# OR if you created a custom secret for a database, then pull it from there, e.g.:
+#   oc get secret bankdb-pwd -o jsonpath="{.data.password}" | base64 --decode 
+spring.redis.password=redisbank

openshift/images/modules_versions.png

@@ -1,3 +1,6 @@
+# Profile
+# spring.profiles.active=openshift
+
 # Properties for running on localhost
 stomp.host=localhost
 stomp.protocol=ws