Deployment Example

In this example we will demo how to deploy SOAJS by leveraging a local Kubernetes cluster. To do this you need to install Docker and enable Kubernetes from the Preferences. click here to learn more

Install SOAJS Installer. click here to learn more

Installation steps

1- you need to create a configuration file as follow:

{
  "mongo": {
    "external": false
  },
  "kubernetes": {
    "ip": "kubernetes.docker.internal",
    "port": 6443,
    "token": "dhwbd87y2ed87gcxwe87dx278gdx78egd87d872gcygwxdh287RLNCkhjnbI9u5P4jIiKyn6WWHPRIsJ2GTxT_f66UKv2yxYgcOAn0_6Kd4nXjvAHBJ2LDZAmRbCYSFmfv5QyX7Tok1BSeszI72nwduxg278dgx78egdcx87wgd78ewgd78gwd78gxew78dg78ewd8ew"
  },
  "nginx": {
    "domain": "soajs.org",
    "apiPrefix": "dashboard-api",
    "sitePrefix": "dashboard",
    "deployType": "NodePort",
    "sslSecret": true,
    "httpPort": 30080,
    "httpsPort": 30443
  },
  "owner": {
    "email": "team@soajs.org",
    "username": "owner",
    "password": "password"
  }
}

• mongo: This is where you specify the mongo cluster you want to use. external=false means SOAJS will install an instance of mongo to persist its data there.
• kubernetes: This where you specify the kubernetes information.
• nginx: This is where you specify the following:
  • domain: is the main domain 
  • apiPrefix: the api prefix which will end up as [apiPrefix.domain]
  • sitePrefix: the site prefix which will end up as [sitePrefix.domain]
  • deployType: can be one of the following:
    • NodePort
    • LoadBalancer
  • sslSecret: This where where you specify how you want to add the https certificate. set this to true to be added as a secret. click here to learn more
  • httpPort: Usually this is 80
  • httpsPort: Usually this is 443
• owner: the owner user and credential information