SOAJS Microservices Environment


SOAJS Microservices Environment template includes instructions on how to provision a container cluster and configure and deploy the SOAJS API Gateway while creating an environment.

This template is only available for environment types Single Cloud Clustering and Multi-Cloud Clustering as it requires using container cluster as infrastructure. 

Single Cloud Clustering

The SOAJS wizard will:

  1. Ask you to select which Infra Cloud Provider you would like to deploy a container technology cluster and use it as the infrastructure of this environment to deploy components at later stages
  2. Assis you in creating virtual machine layers if you already connected an infra cloud provider that supports virtual machines as a technology (optional)
  3. Ask you to provide the security phrase encryption that the SOAJS API Gateway should use to decrypt tenant keys provided in incoming requests
  4. Assist you in configuring and deploying the SOAJS API Gateway as a containerized service in your cluster using a catalog deployment recipe.


The wizard will create the new environment and a new registry record for it in the database. The tenant security phrase encryption will be added to the registry record so that the SOAJS API Gateway can use.

Container Technology Cluster

The wizard will create the container technology cluster at the infra cloud provider and establish a communication link with the SOAJS Console and update the registry of this environment with the details of that link.

Virtual Machine Layers

If instructed to, the virtual machine layers for this environment will be created at the infra cloud provider and will each have a label whose value is the environment code you entered.

Once the virtual machines are created and ready, you can then manage them under the infrastructure module.


Once the infrastructure has been provisioned, SOAJS will then deploy its Gateway using container technology on the cluster that was created and will provide the gateway with the registry configuration. 

In this scenario, the SOAJS API Gateway is the entry point to your SOA cloud in this environment and by default, the gateway listens on port 4000 when handling traffic and on port 5000 when handling maintenance operations.

This means that these ports should be exposed so that the gateway can capture arriving traffic and this is achieved by providing a catalog recipe that instructs which ports to expose and how.

At any stage after creating an environment, you can modify the registry and change the port values. In case you do that, make sure you redeploy the SOAJS API Gateway after.

Multi-Cloud Clustering

coming soon


This template is suitable if you want to create an environment that uses container technology as a backbone to deploy source code and resources and at the same time leverage the full capability and features offered by the SOAJS API Gateway.

Once the environment is created and the gateway deployed, click on Deploy → Repositories to deploy from source code OR click on Deploy → Resources to deploy your resources using containers.