Getting Started Web Tutorial
The following is a walkthrough on using the TIBCO Cloud™ Integration web site to push, scale, and delete an integration app. This tutorial is aimed at DevOps administrators who have been provided an EAR file of an app from a developer, and want to push, scale, monitor, and administer the app. For more details on each step, click the corresponding link.
Register Your Account
To begin using TIBCO® Cloud Integration, you must register an account and log in to the Cloud Integration web site. See Registering a TIBCO Cloud™ Integration Cloud Account for more details.
Create and Push Your App
Use the Cloud Integration web page to create and push your app to Cloud Integration.
The following example uses the sample app
petstoreapplication_2.0.0.ear and manifest file
manifest.json. You must first generate these deployment artifacts using TIBCO Business Studio™ - Cloud Edition. For a tutorial of this process, see Deploying an App from TIBCO Business Studio™ - Cloud Edition.
Make sure you are still logged in to the Cloud Integration web page using the login and password you created above. Go to the Apps page:
First, create a new app. Click the Apps tab, then click Create. The Create App window is displayed.
Enter the name of the new app. The name must only contain alphanumeric characters (a-z and 0-9) and the underline character
This creates an empty app. The app creation page with the available build types is shown.
For this example, we will push an Integration app, which is the Pet Store app.
Click the Push integration app tile. The Push App window is displayed.
Drag and drop the
petstoreapplication_2.0.0.earand manifest file
manifest.jsonfiles onto this window. If you are using Chrome, you can drag a folder into this window. You can also click Browse and find the files on your system.
You will now be shown the progress of the app as it is being uploaded, built, and deployed.
Go back to the Apps page. The app will be listed, but will show a progress bar as the app is being pushed to the server. When it is complete, the indicator circle will turn green.
- Next, view the app’s endpoint. In the web UI, select the app whose endpoint you want to view. Click 1 Endpoint. By default, the endpoint URL is selected.
To open the URL in a new browser, click View API.
Note that clicking View API to view in a new browser will open the base URL; you generally need to add a resource path to the URL to see anything. For example, for
petstoreapplicationyou would have to copy the URL and then add the resource path
Scaling the App
When you log in to Cloud Integration, you will first see the Apps tab. This will list your apps. Let’s start, scale, and stop the app we just pushed.
On the Apps page, find the Pet Store app. If there were several more apps on the page, you could use the Sort control to sort the list, for example, by selecting Last Modified to find the newest apps.
Find the indicator circle at the left of the Pet Store app. This shows if the app is running, and if so, how many instances are currently running. You could also click the Pet Store app to go to the app details page. This also has an indicator circle, and shows more information about the app, such as the app type, when it was modified, the number of running instances, and its endpoint and API.
Click the indicator circle. A control appears, which enables you to change the number of instances.
Note: The maximum instance count is currently limited to 3.
Click the up arrow to add instances to the app, then click Scale.
You can also remove instances. Click the down arrow, then click Scale.
Viewing Performance Metrics
You can monitor the performance metrics of your apps on the Metrics tab of an App details page. This tab displays performance metrics such as CPU and memory usage, network throughput, and uptime. You can select a time range to view historical metrics.
To view metrics:
- From the top navigation bar, click Apps.
- Click a running app in the listed apps.
Click the Metrics tab.
The last hour of app metrics are displayed in the Metrics tab.
The following app metrics are displayed:
- Network Throughput
- Performance graph (CPU and memory over time)
- Network throughput graph (up and down network traffic over time)
Click a range in the Time range control to select a range of metrics to view.
You can view app logs for your running app to monitor its performance and debug any potential issues. App logs are shown in a streaming display containing the last hour of logs. You can also display a time/date range of historical logs, or download app logs.
To view and download logs:
- Click the Apps tab.
- From the top navigation bar, click Apps.
Click the Log tab.
The last hour of app logs are displayed in a scrolling window in the Log area of the screen, and will continually update in real time. They are refreshed every ten seconds, and new log data is added to the bottom of the display.
You can search through log entries using the search box.
In addition to real-time logs, you can also view historical logs from a specified range. To view historical logs:
Click a range in the Time range control to select a range of logs to view.
Clicking a time range will deactivate the Realtime control to toggle off real-time logs. To return to real time logs, click the Realtime switch.
To download logs:
On the Log tab, click Download.
A dialog box appears where date/time range can be selected.
Select a time range, and click Download.
The log entries within the specified time range will be downloaded in a text format file.
Note: Log downloads are limited to 10 MB of data.
Configure your App
If you needed to change the values of properties in your app that were defined by default in the
manifest.json file, you can late-bind new property values for an integration app. On the Apps page, in the Environment Controls tab, the current values of app properties can be inspected, modified, or reset to their defaults.
Saving the new configuration changes will restart the app with the new values. This enables you to modify properties without pushing and building a new EAR file, speeding up changes for moving from test to production, or changing credentials or other variables.
To configure your app:
- Click the Apps tab.
- Click your running app in the listed apps.
Click the Environment Controls tab.
A list of app variables is shown in the Application Variables pane. For each property, the name, type, and value are shown.
To change a property, click the displayed value and enter a new value. To return the value to its default value, click Set to Default.
After you have made changes, the No updates to push text in the upper right will change to two links: Cancel Changes and Update App. Click Update App to restart the app with the new values, or click Cancel Changes to revert changes to the default values.
Delete Your App
After you’re done with your app, you can delete it.
On the Apps page, click the action button next to the Pet Store app. Click Delete app.
A confirmation dialog will appear. Click Delete App.
To log out of Cloud Integration, click your username in the upper right corner, then click Logout.