Introduction

This module helps you manage your products but is no longer found in the dashboard. The only way to access it is to deploy the portal environment.

Steps

General Information
Deployment Strategy
SOAJS Controller
Database
SOAJS urac
SOAJS OAuth
Nginx configuration
Validate and Create
Check Portal

General Information

Deployment Strategy

There is four deployment method:

Existing Settings:

Deploy this environment using the same deployment settings of another environment that you select from a dropdown list.

Docker:

In case you chose Docker, you have to provide the following: Cloud provider, docker port, docker internal port, docker network name and docker certificates

Kubernetes:

In case you chose kubernetes, you have to provide the following: Cloud provider, kubernetes port, kubernetes secret token, kubernetes namespace value, kubernetes namespace mode and nginx deployment mode.

Manual:

Deploy Everything Manually on your Local Machine or a your Custom Server.

Database

Deploy mongo in the created environment, you can choose between three methods:

SOAJS deploys one for you:

Give the database a name, port. some credentials and the connection options.

Shared mongoDB servers:

A MongoDB server is deployed in an another environment and configured to be shared for other environments. So choose the server name and database prefix if any.

External MongoDB server:

use an external mongoDB server, just give the name a name, port, some credentials and the connection options

Environment Security:

Provide a secret phrase to encrypt the tenants keys that will access the environment.

Persist your session in this environment by adding a cookie secret, session name and session secret.

Portal Account:

Create the administrator account so you can login after you finish deploy the portal environment.

Provide a username, password and a valid email.

Ready made services:

This will deploy the controller service in this environment automatically, so choose the controller deployment mode, memory limit, catalog recipe and the branch you want to deploy the controller from.

The controller acts as a gateway to all the microservices deployed in the same environment it operates in, Read More.

Testing & simulation:

If turned off, then this environment isn't sensitive and you can test your services using Swagger Simulator in it.

If turned on, then this environment is sensitive and you can't test your services using Swagger Simulator in it.

SOAJS Urac

SOAJS OAuth

Nginx Configuration

Deploy Nginx in this environment:

Set the memory limit per instance.

Let us create a recipe for you or use an existing one for deployment. In case you chose to create a new one, we will give you the ability to add a custom UI to be associated with this Nginx.

Nginx is an HTTP server also used for upstream arriving requests to the controllers of the environment it operates in.

Provides 2 entry points by default:

API:
domain name that uses the upstream to forward requests to available controllers
Site:
domain name that loads a static content interface

You can add a custom UI by adding its git information as seen in the picture.

Validate and create

Check Portal

After the environment is created, go to the portal domain, in our case "http://portal.soajs.org:82". Enter the credentials and login!!

Browser not supported