Introduction

In Technology, or for an IT department, the Digital Business Agility means to have a flexible Platform Enterprise  “Core”. 

Your Core is represented by all technological building blocks that are used as a foundation on top of which a large number of innovative services or products can be developed.

SOAJS allows you to achieve digitization without any barrier

Objective

Demonstrate how SOAJS:

• Integrate, Activate & Deploy a distributed service oriented architecture SOA cooked up from different technologies ( HAPI - Express - Java )
  • Integrate & Activate ( with Github )
  • Container Technology ( via Docker Swarm )
  • Cloud Orchestration ( via SOAJS Dashboard )

• Apply API Management & Lifecycle on SOA
  • Turning on Multi-Tenancy
  • Configuring and apply Multi-Security
  • Configuring and using Multi-Tenancy (at code level)

• Manage your SOA using the API Catalog Module ( via Swagger )

• Turn on Continuous Integration & Delivery ( with Travis )

Scenario

1. Show Case Explained
   1. Services
   2. Productization
   3. Multitenancy 
   4. SOAJS Layers
2. Steps
   1. Install SOAJS
   2. Import Ready Made Demo configuration
   3. Integrate & Activate Services
   4. Deploy a new Environment
   5. Deploy the services ( HAPI - Express - Java )
   6. API Catalog
      1. Test your Services with Swagger and Postman
      2. APIs Explanation
      3. Multi Tenancy Demonstration
3. Turn on Continuous Integration & Delivery

Show Case Explained 

Our Demo will demonstrate how to deploy an environment ( DEV ) then deploy 3 services in it where each service is built using a certain technology/framework.

Once deployed, we will show using the Swagger Simulator tool in the API Catalog Module:

1. how to test the APIs of these services 
2. how multi tenancy is applied at the code level
3. how mutli security is applied on running services

Finally we will demonstrate how to turn on Continuous Integration & Delivery, configure it and see it in action.

Steps

1. Install SOAJS
2. Import Ready Made Demo configuration
3. Integrate & Activate Services
4. Deploy a new Environment
5. Deploy the services ( HAPI - Express - Java )
6. API Catalog
   1. Test your Services with Swagger and Postman
   2. APIs Explanation
   3. Multitenancy Demonstration

1. Install SOAJS

Start by installing and deploying SOAJS as a local Cloud; Click Here and you will be redirected to the SOAJS Installer Space where you can find the installation instructions. For this demo, we will be using Local Cloud Deployment on top of Docker. 

2 - Install Ready Made Demo configuration

Clone the configuration repository from github; it contains the code and a script that will bootstrap some database configuration for this demo ( explained here )

# Create a directory to clone the repo
> mkdir -p /opt/soajs/node_modules

# Go to directory
> cd /opt/soajs/node_modules

# Clone configuration repo from github
> git clone git@github.com:soajs/soajs.tidbit.demo

# Install the dependencies
> cd soajs.tidbit.demo
> npm install

# node . -h <mongo service host> -p <mongo port>
> cd soajs.tidbit.demo/import/
> node . -h dashboard-soajsdata -p 32017

# Open the import script help manual
> cd soajs.tidbit.demo/import/
> node . --help

From here on, we will use the SOAJS Dashboard UI to resume all the work, so log in to the SOAJS Dashboard!!

3 - Integrate & Activate Services

4 - Deploy a new Environment 

5- Deploy the services ( HAPI - Express - Java ) 

Navigate to Repositories under Deploy pillar, press on the service you want to deploy, press Configure Deployment and fill the form:

Once the environment is deployed, update your hosts file and add the below entry:

127.0.0.1	dev-api.mydomain.com

6 - API Catalog 

a - Test your Services with Swagger and Postman 

We will test the microservice in two ways :

1.  Swagger Simulator: rich UI simulator that provides REST API documentation and the ability to interact with them.
    SOAJS Dashboard UI is equipped with Swagger Engine and Simulator by default.

   1. Go to the dashboard → Develop → API Catalog: 
   2. Click on Swagger logo that appears if the microservice contains the property "swagger" set to true
   3. Choose your environment where you deployed your microservice
   4. Choose the right tenant TID1 for example
   5. Use the simulator to make API calls to your microservice
      
      
2. Postman: simulates your curl requests to test the microservice.
   Import the postman collections JAVA.postman_collection.json - EXPRESS.postman_collection.json - HAPI.postman_collection.json from the postman folder in the repo soajs.tidbit.demo you cloned above.
   
   

b- APIs Explanation 

• /tidbit/hello using method GET: This API take two parameters, username and lastname. When you hit it, the response is a massage containing the provided username and lastname.
  
  
• /tidbit/hello using method POST: This API doesn't take any parameter. When you hit it, a json response is formulated and returned. This json response represents the services configuration that was detected by SOAJS controller and supplied to the service.
  This shows that when you use SOAJS, you don't need to modify your code in order to benefit from mutlitenancy and urac.

app.post('/tidbit/hello', function(req, res){
   res.send(req.soajs);
});

{
  "tenant": {
    "id": "593fdd808428b63b708d5fa6",
    "code": "TID1",
    "key": {
      "iKey": "0e379751d5dda1952d64022bae2324dd",
      "eKey": "dde502c6bcdfbf87812c6a35788670006d204fda01d3e75354987cfd9a7c3b9b7245cd51aac287703292db0f81a31053fd027f064ddff91e6436910d32cfe06d251aecd60cb2af5e76c51a4eb6b872c9bdcea1a3f965508b3318fcbe2fa44a31"
    },
    "application": {
      "product": "DEV",
      "package": "DEV_PACK1",
      "appId": "58bd240606f3698ba308dc21",
      "acl": null,
      "acl_all_env": null,
      "package_acl": null,
      "package_acl_all_env": null
    }
  },
  "servicesConfig": {
    "data": "This is service config 1"
  },
  "device": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
  "geo": {
    "ip": "10.255.0.4"
  }
}

By just writing simple express code, SOAJS gave you the power of multitenancy!! 

As you see, the API returned all the tenant information with the service config. To learn more about services config, click here.

c- Multitenancy Demonstration 

Java, hapi and express are multitenant microservices; you will need to provide the tenant keys for the requests to work.

To find these keys, go to the Manage pillar → Multitenancy → Client ( you will see the list of tenants there ).

Expand a tenant entry, to reach the external keys section, grab the external key and use it in the postman requests. In the Swagger Simulator, when you pick the tenant, the external key is added automatically to the header

Continuous Integration & Delivery

Continuous integration & Continuous Delivery CI/CD provides the mechanism to automate everything. Continuous integration (CI) means that whenever a developer checks in code to the source repository, a build is automatically triggered. Continuous delivery (CD) takes this one step further: after a build and automated unit tests are successful, you automatically deploy the application to an environment where you can do more in-depth testing.

Generally we recommend that you do continuous delivery to your development and staging environments. Most teams, require a manual review and approval process for production deployment. 

SOAJS provides you with ready made UI so you can turn on and configure CI/CD with just a few clicks.

CI/CD Full Horizontal Flow

Once CI/CD is configured and the files are in the repository, once a developer pushes updates to the master branch of this repo, the following scenario will take place:

{
  //"uri": "http://dashboard-api.soajs.org:80/cd/deploy?deploy_token=yyyyyyyyyyy"
  "uri": "$SOAJS_CD_DASHBOARD_PROTOCOL://$SOAJS_CD_DASHBOARD_DOMAIN:$SOAJS_CD_DASHBOARD_PORT$SOAJS_CD_DASHBOARD_ROUTE?deploy_token=$SOAJS_CD_DEPLOY_TOKEN",
  "headers": {
    "key": "$SOAJS_CD_AUTH_KEY",
    "Content-Type": "application/json"
  },
  "json": true,
  "body": {
	"repo": "soajs.nodejs.express", //repo name
    "branch": "master", //repo branch


	//if repo is a service or a multi service, the below get appended to the body
    "services": [
      {
        "serviceName": "express", 	//detected repo service
        "serviceVersion": 1			//detected service version
      }
    ]
  }
}