Giters

redhat-sa-brazil / modern-invoice-demo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Modern Invoice Demo

Description

This demo showcase how to integrate Red Hat Data Grid and Red Hat Fuse through a simple Credit Card Invoice Offload use case.

The Additional References section will provide complementary assets for further reading alongside additional details about related topics.

Environment

Deployment on Openshift

  1. Pre-Requisites
  2. Install Red Hat Fuse 7.3 on Openshift
  3. Install Red Hat Data Grid 7.3 on Openshift
  4. Create Modern Invoice Project
  5. Deploy MySQL
  6. Deploy Red Hat Data Grid
  7. Deploy Modern Invoice Demo

Demo Guide

  1. Introduction
  2. Create an Invoice
  3. Get all Invoices on Red Hat Data Grid
  4. Get an Invoice by Id
  5. Get an Invoice by Id using Hystrix
  6. Get an Invoice by Customer's Name

Pre-Requisities

  • Deploying Red Hat Fuse based apps can be very easy when using Apache Maven capabilities. To build and compile our demo, we're going to need Red Hat repositories propertly configured. That said, you can refer the following settings.xml as an example:

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
<profiles>
  <profile>
    <id>default</id>
    <repositories>
      <repository>
        <id>maven-central</id>
        <name>Mave Central Repo</name>
        <url>https://repo1.maven.org/maven2</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </repository>
      <repository>
        <id>redhat-ga</id>
        <name>Red Hat GA</name>
        <url>http://maven.repository.redhat.com/ga/</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </repository>
      <repository>
        <id>redhat-techpreview</id>
        <name>Red Hat TechPreview</name>
        <url>http://maven.repository.redhat.com/techpreview/all/</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </repository>
      <repository>
        <id>redhat-earlyaccess</id>
        <name>Red Hat Early Access</name>
        <url>https://maven.repository.redhat.com/earlyaccess/all</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </repository>
      <repository>
        <id>jboss-ea</id>
        <name>JBoss Early Access Repository</name>
        <url>http://repository.jboss.org/nexus/content/groups/ea</url>
        <snapshots>
          <enabled>false</enabled>
        </snapshots>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>never</updatePolicy>
        </releases>
      </repository>
    </repositories>
    <pluginRepositories>
      <pluginRepository>
        <id>maven-central</id>
        <name>Mave Central Repo</name>
        <url>https://repo1.maven.org/maven2</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </pluginRepository>
      <pluginRepository>
        <id>redhat-ga</id>
        <name>Red Hat GA</name>
        <url>http://maven.repository.redhat.com/ga/</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </pluginRepository>
      <pluginRepository>
        <id>redhat-techpreview</id>
        <name>Red Hat TechPreview</name>
        <url>http://maven.repository.redhat.com/techpreview/all/</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </pluginRepository>
      <pluginRepository>
        <id>redhat-earlyaccess</id>
        <name>Red Hat Early Access</name>
        <url>https://maven.repository.redhat.com/earlyaccess/all</url>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </releases>
        <snapshots>
          <enabled>true</enabled>
          <updatePolicy>daily</updatePolicy>
        </snapshots>
      </pluginRepository>
      <pluginRepository>
        <id>jboss-ea</id>
        <name>JBoss Early Access Repository</name>
        <url>http://repository.jboss.org/nexus/content/groups/ea</url>
        <snapshots>
          <enabled>false</enabled>
        </snapshots>
        <releases>
          <enabled>true</enabled>
          <updatePolicy>never</updatePolicy>
        </releases>
      </pluginRepository>
    </pluginRepositories>
  </profile>
</profiles>

<activeProfiles>
  <activeProfile>default</activeProfile>
</activeProfiles>

</settings>

  • In order to successfully deploy this demo, you're going to need a functional Openshift 3.11 cluster. This can be obtained using your on-premise infrastructure, traditional Cloud Providers such as AWS, Azure, Google Cloud and IBM Cloud, or via CDK/Minishift

  • Setup Openshift Client 3.11 as describe here: Installing the CLI

  • Moving forward, we need to setup Red Hat Container Registry integration, which can be done in several ways which are covered in depth on the following references:

Install Red Hat Fuse 7.3 on Openshift

  • Installing Red Hat Fuse on Openshift is very easy. You just need to access to Openshift namespace (if you want to enable it globally) and import Fuse image streams, quickstarts and templates just as follows:

    • Login as system:admim:
    oc login -u system:admin
    • Import Fuse Image Streams:
    BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.fuse-730065-redhat-00002
oc replace -n openshift -f ${BASEURL}/fis-image-streams.json
    • Install quickstart examples and templates for quick reference:
    for template in eap-camel-amq-template.json \
  eap-camel-cdi-template.json \
  eap-camel-cxf-jaxrs-template.json \
  eap-camel-cxf-jaxws-template.json \
  eap-camel-jpa-template.json \
  karaf-camel-amq-template.json \
  karaf-camel-log-template.json \
  karaf-camel-rest-sql-template.json \
  karaf-cxf-rest-template.json \
  spring-boot-camel-amq-template.json \
  spring-boot-camel-config-template.json \
  spring-boot-camel-drools-template.json \
  spring-boot-camel-infinispan-template.json \
  spring-boot-camel-rest-sql-template.json \
  spring-boot-camel-teiid-template.json \
  spring-boot-camel-template.json \
  spring-boot-camel-xa-template.json \
  spring-boot-camel-xml-template.json \
  spring-boot-cxf-jaxrs-template.json \
  spring-boot-cxf-jaxws-template.json ;
  do
oc replace -n openshift -f \
https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.fuse-730065-redhat-00002/quickstarts/${template}
done
    • Finally install Hawtio Console:
    oc create -n openshift -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.fuse-730065-redhat-00002/fis-console-cluster-template.json
oc create -n openshift -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.fuse-730065-redhat-00002/fis-console-namespace-template.json

Install Red Hat Data Grid 7.3 on Openshift

  • Openshift 3.11 already ships Red Hat Data Grid cache-service and datagrid-service templates which are used to deploy this middleware. You can check them by running:

    oc get templates -n openshift | grep 'cache-service\|datagrid-service'

  • If you can't find cache-service and datagrid-service templates, you can easily deploy them by executing:

    for resource in cache-service-template.yaml \
datagrid-service-template.yaml
do
  oc create -n openshift -f \
    https://raw.githubusercontent.com/jboss-container-images/jboss-datagrid-7-openshift-image/7.3-v1.2/services/${resource}
done

Create Modern Invoice Project

  • In order to keep our environment organized, we're going to create a separated project/namespace to deploy our services and demo. To achieve this, you just need to run:

    oc new-project invoice
    • TIP: you can choose a different project name if you wish.

Deploy MySQL

  • Openshift ships several Databases such as MongoDB, PostgreSQL and others. I chose MySQL for this demo, therefore, we need to deploy it as follows:

    oc new-app --template=mysql-ephemeral --param=MYSQL_USER=admin --param=MYSQL_PASSWORD=admin
    • TIP 1: you can choose different username and password
    • TIP 2: take note of these attributes

  • Wait a few seconds for MySQL deployment and execute oc get pods to make sure everything went just fine:

    > oc get pods
NAME            READY     STATUS    RESTARTS   AGE
mysql-1-th7kp   1/1       Running   0          1m
    • TIP 1 : the pod name mysql-1-th7kp is going to be different from yours;
    • TIP 2 : make sure your pod has a Running status with a 1/1 count;

Deploy Red Hat Data Grid

  • As I previously stated, deploying Red Hat Data Grid is quite straightforward using via Openshift Templates. Just execute the following and a RDG instance will be provisioned afterwards:

    > oc new-app cache-service \
-p APPLICATION_USER=cache \
-p APPLICATION_PASSWORD=cache \
-p APPLICATION_NAME=cache-service
    • TIP 1: you can choose different APPLICATION_USER and APPLICATION_PASSWORD
    • TIP 2: take note of these attributes

Deploy Modern Invoice Demo

  • Before deploying Modern Invoice Demo, we need to compile it. Thus, navigate to the source/modern-invoice directory and execute the following:

    mvn clean compile

mvn fabric8:deploy \
-Dmysql-service-username=admin \
-Dmysql-service-password=admin \
-Djdg-application-name=cache-service \
-Djdg-application-user=cache \
-Djdg-application-password=cache
    • TIP : all attributes should match both MySQL and Red Hat Data Grid params previously informed;

Introduction

  • This demo demonstrates how to integrate Red Hat Data Grid and Red Hat Fuse through a simple Credit Card Invoice Offload use case. In order to do that, we've created 5 (five) Red Hat Fuse routes which leverages this integration. Also there's an Open API/Swagger definition available on: $openshift-modern-invoice-route/fuse/api-doc.

Create an Invoice

  • This is a REST endpoint responsible for creating an Invoice. In order to use it, just hit a HTTP POST on $openshift-modern-invoice-route/fuse/invoice with a content similar as follows:

    http POST modern-invoice-demo.app.myopenshift.com/fuse/invoice customerName=customer1 dueDate="may/2019" total=5500.45

Get all Invoices on Database

  • This is a REST endpoint responsible for fetching all invoices available in our database. In order to use it, just hit a HTTP GET on $openshift-modern-invoice-route/fuse/invoice:

    http GET modern-invoice-demo.app.myopenshift.com/fuse/invoice
    • TIP : bare in mind when not using a MySQL persistent template, if your POD restart for any reason your data will be lost;

Get an Invoice by Id

This is a REST endpoint responsible for fetching all invoices available in our system, looking firstly on Red Hat Data Grid and if no invoice is found, we're going to hit our database looking for it. In order to use it, just hit a HTTP GET on $openshift-modern-invoice-route/fuse/invoice/${id}:

http GET modern-invoice-demo.app.myopenshift.com/fuse/invoice/1
  • TIP 1: when an invoice is not found on Red Hat Data Grid but is available in our database, the Red Hat Fuse Route will populate our cache with this data so the upcoming requests looking for this info, will no longer hit MySQL;
  • TIP 2: consider reviewing Red Hat Fuse Route logs which will display lots of useful information;

Get an Invoice by Id using Hystrix

This is a REST endpoint responsible for fetching all invoices available in Red Hat Data Grid ONLY and if our cache is not available, our Fuse Route will fallback and hit the database to fetch the desired data. In order to use it, just hit a HTTP GET on $openshift-modern-invoice-route/fuse/invoice/hystrix/${id}:

http GET modern-invoice-demo.app.myopenshift.com/fuse/invoice/hystrix/1
  • TIP : this example illustrates how easy you can add resilience on Red Hat Fuse routes exploring Hystrix

Get an Invoice by Customer's Name

This is a REST endpoint responsible for fetching all invoices available in our system, looking firstly on Red Hat Data Grid and if no invoice is found, we're going to hit our database looking for it. In order to use it, just hit a HTTP GET on $openshift-modern-invoice-route/fuse/invoice/${customerName}/customer:

http GET modern-invoice-demo.app.myopenshift.com/fuse/invoice/johndoe/customer
  • TIP : unfortunately this Fuse Route it not working properly. Please review this issue for additional details;

Additional References

About

Languages

Language:Java 100.0%