Operate

Click on Deploy portal button marked in blue on the right top page of the dashboard. You will be redirected to wizard that will help you create the portal environment.

In the first step:

• Provide a code for you environment (this code is unique)
• Provide a description for your environment
• Enter the domain associated with this enviornment
• Enter the API prefix of the specified domain ("api" is the default value)
• Enter the site prefix of the specified domain ("site" is the default value)

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.

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

SOAJS Controller 

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.

Deploy SOAJS Urac so you can access the portal when you login as following:

• Choose the deployment mode
• Enter the Urac number of instances
• Provide the memory limit per instance
• Choose the Catalog recipe that will be used to deploy Urac
• Select the branch to deploy Urac from

Deploy SOAJS OAuth so you can access the portal when you login as following:

• Choose the deployment mode
• Enter the OAuth number of instances
• Provide the memory limit per instance
• Choose the Catalog recipe that will be used to deploy OAuth
• Select the branch to deploy OAuth from

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.

Finally, validate all your inputs, then press create environment. A progress bar will appear showing the progress.

After the environment is successfully created, go to the domain you created and login using the administrator credentials you created!!