How to Run a Sample Project on IPS

IPS provides exclusive support to deploy UltraStudio projects. This document briefly describes about the steps involved in deploying a sample project that is available under UltraStudio samples.


If you haven’t already done so,

  • Define a container image with user adroitlogic, name ips-worker and tag 17.07 (you can utilize the Select Existing button on the container image creation page to use the already defined image from the image repository).

  • Create a cluster using the above mentioned container image.

  • Some samples may require access to external services, such as ActiveMQ/SFTP servers, or hosted services (e.g. Gmail). Refer to the sample-specific documentation to find out about these additional service requirements.

  • In some cases where the sample needs to access a service (e.g. an UltraStudio Jetty Server instance or an ActiveMQ/SFTP server) running on your host machine, you will have to specify the host machine’s address on the host-only network associated with your IPS virtual machine, for certain property configurations of the sample project.
    This address will usually be the first IP address of the host-only network IP range, e.g. if your VM’s host-only address (obtained using ips_installer ip) is the corresponding address on the host would be


  1. Navigate to the project creation page.

  2. Click the Select a Sample button and select the required project sample.

  3. Click Next and wait for IPS to download the sample XPR from the repository, after which you will be automatically navigated to the Configure page.

    rest service
  4. On the Configure page enter the necessary project properties. For more details about adding project properties, please refer to the sample-specific deployment guide under the Samples category on the left pane. Click Next again on the Configure page when you have finished updating the project properties.

  5. In the Assign page, select the cluster you have created previously, and click Deploy Now.

  6. You will be directed to the Deployments perspective of the selected cluster, with the new project added automatically to the Pending Updates list.

    If you had already deployed a project in the selected cluster, which exposes the same port as our sample project port (i.e. 8280), the project will not be added to the pending updates list and an error message would be displayed indicating the port conflict (as two projects in the same deployment cannot bind to the same port). In that case, you can manually Delete the conflicting project from the Deployed Projects list and use the Add Project button on the upper right hand corner to select the Sample Project for deployment.
  7. If required, Map an external port (e.g. 30040) to the exposed ports (e.g. 8280) of the sample project, using the Configure button.

    Based on the sample project selected the port configurations required might differ. Port mappings are generally required if the sample project contains network-based message receivers (e.g. HTTP listeners). Please refer the deployment guide for the specific sample if you are not sure about the port mapping requirements.
  8. Click Deploy and wait for the progress bar to indicate successful completion of the deployment.


  1. Since the sample is running inside the IPS virtual machine, you will not be able to access it using the IP address (e.g. localhost) and port number (e.g. 8280) mentioned on the corresponding UltraStudio sample documentation page. You will instead have to use a combination of IP address of the IPS virtual machine and the external port(s) mapped during the deployment (e.g.…​;), as described above under Deployment, instead of the default host and port (e.g. http://localhost:8280/…​;) mentioned on the UltraStudio documentation.
    Hence, if the deployed sample contains any network-based (e.g. HTTP) listeners, start by finding the IP address on the host-only interface of your IPS virtual machine using the ips_installer ip command (which would usually be

  2. Follow the steps specified in Testing section of the sample-specific deployment guide to verify its functionality, using the IP address-port combination derived above if required.

In this topic
In this topic
Contact Us