FAQs

What are the optional and mandatory services for API Builder? For example, Docker internal registry and Docker internal registry auth are optional.

All services are mandatory. 

 

What data is being stored in the NFS server?

We store all data including MongoDB data, log files and docker images in the NFS server.

 

Which ports are used by Docker services and protocol type (UDP/TCP)?

Each port should have TCP.

 

What elements are optional and mandatory in user_input.json?

  • "adi":{} is optional if a ADI server is not available for installation. If there is only one ADI server for installation (like "adi":{"server":IP}), the following items are not needed in "adi":{} as there is no SSL certificate in the ADI server: 
    • certificate_authorities
    • certificate, certificate_key
    • key_passphrase
  • nfs_server is optional for development cluster
  • newrelic_key is optional
  • docker_registry is not needed for on-premise installation

What is the distinction between IP addresses used by Dashboard and API Builder apps?

  • For a development cluster, there should be two servers in hosts section of the user_input.json like this: "hosts": ["IP1", "IP2"]. In this case, IP1 is the Dashboard's IP address and IP2 is the address for API Builder apps.
  • For a production cluster, there should be four servers in hosts section of the user_input.json like this: "hosts": ["IP1", "IP2", "IP3", "IP4"]. In this case, IP1 and IP2 addresses are the Dashboard's IP addresses and IP3 and IP4 IP addresses are for the API Builder apps.

 

With API Management Plus, some features mentioned in Managing API Builder Applications don't work. What am I missing?

API Management Plus need access to the following URLS on ports 80/443:

  • pem-query-api.cloud.appcelerator.com
  • pem-core.cloud.appcelerator.com


With API Runtime Service 1.6.0, an error occurs during arrowcloud-vpc cloud deployment with the following message. How does one fix this error?

DEBU[2016-12-12 18:51:30] TASK [create aws resources] **************************************************** 

DEBU[2016-12-12 18:51:35] fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": "Signature expired: 20161210T111738Z is now earlier than 20161212T104501Z (20161212T105001Z - 5 min.)"} 

DEBU[2016-12-12 18:51:35] to retry, use: --limit @/opt/arrowcloud/setup/playbooks/aws_create.retry

 

Restart Docker on the local machine (when you run the go-client). We are investigating this issue and at this time we believe this may be a Docker bug.


Is it possible to install all the nodes on the same VM?

Yes but we don't recommend it. We highly recommend isolating mongoDB and nodes that runs user applications.

 

What are the requirements for such (all nodes installed on one VM)?

We don't have a recommendation at this time since we don't support this configuration for production. But, it would need at least 32G.

 

What is the nature of the data stored on the NFS node?

Photos and files are uploaded through ArrowDB and Arrow apps published by users.

 

Is it possible to use 200Gb of datadisk on the MongoDB node on production instead of the 500Gb required?

Yes but you will have less room to store ArrowDB data. The storage requirement is not only for the data but also for large indexes.

 

Is the Global Haproxy the same component as the Haproxy in API Runtime Services?

The ArrowDB architecture is not for on-premise, it's for public cloud.

 

How does one obtain the API Runtime Services single image (OVA) and/or binaries for installation?

  • The Axway/Appcelerator developers will provide the image and/or binaries.

 

Is it possible to ship a .vmdk image file instead of an OVA?

  • A .vmdk file can be extracted from an OVA file by using this command: tar -xvf *.ova
  • We don't ship .vmdk image files.

 

Is it possible to use hostnames instead of IP addresses in the user_input configuration?

  • We don't support hostnames in user_input. This may change in future versions.

 

Is it possible to run http-only installation?

  • Yes but it's not recommended.

 

When will Red Hat 7 be supported for installation?

  • As of Q4 of 2016, Red Hat 7 should be supported by the Q2 2017 release (our Dockerized version).

 

How does one review the healthcheck service (in order to check the service state for load balancing) for API Runtime Services and ArrowDB?

  • API Runtime load balance can be checked by their status of these two endpoints:
    • ArrowDB: /v1/admins/ping.json
    • API Runtime Services/ping.json

 

Is it possible to deploy the production on-premise cluster with three VM even if we use the --ignore-preinstall-fatal flag?

  • Using three VM will affect the high availability of the entire API Runtime cluster.
  • The suggested configuration is two VM for development and eight VM for production installations.

 

Is it possible to use LDAP for user authentication to Dashboard?

  • Not at this time. We have it on our 2017 roadmap.

 

I've logged through the platform-eu (5.3.1+) but when I execute appc run locally, I cannot access Arrow Admin (unauthorized problem).

You will need to login from the platform-eu website however, the CLI also needs to know they want to connect to the platform-eu. To accomplish that:

  1. Ensure that your CLI is 5.4.0+.
  2. Execute these commands:
    1. appc logout
    2. appc config set defaultEnvironment production-eu
    3. appc login

Now when you execute appc run, it will point to the correct location.

 

Can I log into both platform.appc and platform-eu.appc at the same time?

  • Not with the same browser. You will need to use two different browsers (like Firefox, Safari, Chrome, IE, etc.); one browser for platform.appc and a different one for platform-eu.appc so the session data doesn't conflict within the same browser.


How do I convert VMware images between different states?

You can convert an VMware image via VMware's own ovftool which can be downloaded from VMware Open Virtualization Format Tool 4.0.0.

To convert an image using ovftool from OVA to VMDK, use this command:

$ovftool appc_image_vmware_1.5.2_2016_07_26__19h55m38sUTC.ova new_image.vmdk

This will create a VMDK and VMX files from the OVA file called new_image.filetype. The VMX points to the VMDK and is required since it has all of the VM machine specifications. Once the VMX and VMDK files have been created, you can deploy them the same way you can in vSphere. Only you'll be targeting the VMX file instead of the OVA file.

 

How do I connect to the European Dashboard?

  1. Ensure you are using appc cli version 5.3.1 or later. To get the latest version of appc cli, run this command: appc use latest

  2. Then, run appc config set defaultEnvironment production-eu


I've configured my environment using HTTP URLs. What modifications do I need to make?

  • Edit ~/.acs and change publishPort to 80.


Do we need to mention capacity settings on how to size the architecture based on the number of users, API calls, and so?

  • We deploy with a preset configuration based on the type (development vs. production). If the default architecture doesn’t work for the customer’s use case then we can help make manual changes.


Is our production architecture highly available (HA)?

  • Our production architecture is highly available and can handle individual virtual machines failing.


Are other Appcelerator Suite features like Analytics included in API Runtime Services?

  • Yes.


What are the minimum requirements for the cluster configurations?

  • See Topology and Pre-requisites for details regarding system requirement. 
  • Note: Please ensure the mentioned hardware specifications match that of your configuration. Failure to do so will cause the deployment to fail.


How is disaster recovery (DR) handled?

  • We are still developing a plan for on-premise disaster recovery to handle cases where a physical cluster is destroyed.

Are there any security consideration that need to be addressed such as SSL, firewall, proxy, ports, and so on? 
  • Appcelerator Private provides an option to configure a SSL certificate to access the the on-premise cluster's administrative and API endpoints. If the customer's network requires a proxy for outgoing traffic, this can also be configured when running the self-install tool. 
  • Firewalls are ports that are configured by the customer in their VMware environment.

What command can I use to get the most verbose report when publishing an app?
  • DEBUG=* appc publish -l trace

Related Links