Configuring user_input.json

 This chapter covers the basics of configuring the  user_input.json for the production and development clusters used with API Runtime Services.

Documentation notes

Password values in the code examples should be replaced with actual passwords. For example, the value for "password": "xxxxxx", should be replaced with an actual password.

The passwords are available at support.axway.com. Please make a note of them prior to continuing with this document.

Configuring the user input file

To specify all of the details that we need, such as the machines that we're going to be setting up on requires a complete user_input.json file. Below are example of a production user_input.json and also a development user_input.json.

Note: as of 1.5.5, the key of  ssl_pem_file has been replaced with  ssl_pem_files which now accepts an array of SSL PEM files instead of just one single file.

Production cluster

{
  "ssh": {
    "username": "appcadmin",
    "password": "xxxxxx",
    "port": 22
  },
  "mongodb_hosts": ["10.0.15.186", "10.0.15.187", "10.0.15.188"], // The order MUST be ["primary", "secondary", "arbiter"]
  "version": "1.6.0",
  // List of hosts to be installed. 
  "hosts": ["10.0.15.181","10.0.15.182","10.0.15.183","10.0.15.184"],
  // Required for production installation
  "nfs_server": "10.0.15.185", // dedicated host will be used as nfs server, the installer will configure nfs server on it
  "cluster": "productionClusterTest",
  "newrelic_key": "appcRelic", // Optional 
  "arrowdb_url_prefix": "api",
  "arrowcloud_admin_url_prefix": "admin",
  "dashboard_url_prefix": "dashboard",
  "domain_name": "cloud.appctest.com",
  // SMTP is required for dashboard to send email
  "smtp":{
    "address": "smtp.company.com",
    "username": "username",
    "password": "xxxxxx",
    "port": 587,
    "tls": true,
    "sender_email": "support@company.com",
    "domain": "company.com" // optional
  },
  "email": ["devops@company.com"], // List of emails to receive system events
  // Provide path to ssl pem file if the cluster supports https, otherwise remove this line
  "ssl_pem_files": "/Users/MacbookPro/Arrowcloud-deploy/cloud.appctest.com.pem"
}

Development cluster

{
  "ssh": {
    "username": "appcadmin",
    "password": "xxxxxx",
    "port": 22
  },
  "mongodb_hosts": ["10.0.15.186"], 
  "version": "1.6.0",
  // List of hosts to be installed. 
  "hosts": ["10.0.15.181","10.0.15.182"],
  "cluster": "developmentClusterTest",
  "newrelic_key": "appcRelic", // Optional 
  "arrowdb_url_prefix": "apidev",
  "arrowcloud_admin_url_prefix": "admindev",
  "dashboard_url_prefix": "dashboarddev",
  "domain_name": "cloud.appctest.com",
  // SMTP is required for dashboard to send email
  "smtp":{
    "address": "smtp.company.com",
    "username": "username",
    "password": "xxxxxx",
    "port": 587,
    "tls": true,
    "sender_email": "support@company.com",
    "domain": "company.com" // optional
  },
  "email": ["devops@company.com"], // List of emails to receive system events
  // Provide path to ssl pem file if the cluster supports https, otherwise remove this line
  "ssl_pem_files": "/Users/MacbookPro/Arrowcloud-deploy/cloud.appctest.com.pem"
}
{
  "ssh": {
    "username": "appcadmin",
    "password": "xxxxxx",
    "port": 22
  },
  "mongodb": {
    "hosts": ["10.0.15.235"],  // Primary mongodb node
    "port": "portnumber",
    "rsname": "data",
    "username": "appcelerator",
    "password": "xxxxxx",
    "provision": {
      // Set to false or remove it to bypass mongodb installation and configuration
      "enabled": true,
      "admin_username": "admin",
      "admin_password": "xxxxxx",
      // "enterprise" (the enterprise version) or "open_source" (the open source version)
      "version": "enterprise"
    }
  },
  "env": "development",
  // List of hosts to be installed. 1 host for development and staging and 4 hosts for production
  "hosts": ["10.0.15.234"],
  "cluster": "productionClusterTest",
  "newrelic_key": "appcRelic",
  "arrowdb_url_prefix": "api",
  "arrowcloud_admin_url_prefix": "admin",
  "domain_name": "cloud.appctest.com", 
  // Provide path to ssl pem file if the cluster supports https, otherwise remove this line
  "ssl_pem_files": "/Users/MacbookPro/Arrowcloud-deploy/cloud.appctest.com.pem"
}

SSH

These are the details for logging into your nodes.

Note: If you use OVA deployment, the username you should use is appcadmin. The password will appear on Dashboard near the download link. We strongly encourage you to change the password on every node you launch and update the JSON file accordingly.

MongoDB

The MongoDB section allows you to specify the nodes that you have configured for Mongo use.

Hosts

The hosts section is an array of the nodes designated for ACS and Container usage. Use four (4) for a production cluster and one (1) for a development cluster.

NFS

One node dedicated as nfs node is required for a production cluster. For a development cluster, the installer will configure NFS server on the Mongodb primary host.

Cluster

The cluster section allows you to set a custom string that will be used to name the cluster.

New Relic key

Your New Relic key as mentioned in the Preparing user_input.json chapter or go to New Relic License Key and follow the instructions there.

SSL PEM file

This variable points towards the SSL PEM file that you need to use for authentication.

Related Links