OpenBook Quick Start Guide
This document is intended for an evaluation deployment of Talligent OpenBook v2.
System requirements
Talligent VM configured as below:
 2 vCPU, 4 GB RAM, 500 GB disk
 Apache Tomcat 7.x, configured for SSL. A self-signed certificate is ok.
 MySQL 5.6, MariaDB 5.5, or MariaDB 10. MariaDB is preferred.
Verifying OpenStack connectivity and Ceilometer configuration
OpenBook communicates with OpenStack via the OpenStack REST APIs. Please ensure that
network security rules allow connections from the OpenBook host to all the adminurl API
endpoints listed in the keystone endpoint-list command output.
To connect to the OpenStack APIs, OpenBook requires a user with the admin role in the admin
project. If you choose to use a userid other than the OpenStack admin id, please ensure that this
userid has the appropriate privilege.
OpenBook relies upon OpenStack’s Ceilometer service for metering data. As such, this service must
be installed and configured correctly to provide the detailed data that OpenBook requires. To
perform a quick check for the Ceilometer configuration, run the commands below and confirm that
the output looks similar to the sample output shown:
# export TOKEN=`curl -d '{"auth":{"passwordCredentials":{"username": "admin",
"password": "<password>"},"tenantName":"admin"}}' -H "Content-type: application/json"
<Keystone endpoint URL>/tokens | python -c 'import sys, json; print
json.load(sys.stdin)["access"]["token"]["id"]'`
# curl -H "X-Auth-Token: $TOKEN" "<Ceilometer endpoint URL>/v2/meters" | python -m
json.tool
[
{
"meter_id": "NTYzMTE2YTMtM2FmMy00YWJkLWFmMWItODc4MzMwYTU4MzhhK2lucWxs\n",
"name": "instance:m1.small",
"project_id": "b152bf178bc64af3b3cfa3abb5059a0a",
"resource_id": "563116a3-3af3-4abd-af1b-878330a5838a",
"source": "openstack",
"type": "gauge",
"unit": "instance",
"user_id": "72e9348bf73540f1ae5378a5a34958ea"
},
{
"meter_id": "NTYzMTE2YTMtM2FmMy00YWJkLWFmMWItODc4MzMwYTU4MzhhK2NwdVGls\n",
"name": "cpu_util",
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
"project_id": "b152bf178bc64af3b3cfa3abb5059a0a",
"resource_id": "563116a3-3af3-4abd-af1b-878330a5838a",
"source": "openstack",
"type": "gauge",
"unit": "%",
"user_id": "72e9348bf73540f1ae5378a5a34958ea"
}
]
# curl -H "X-Auth-Token: $TOKEN" "<Ceilometer endpoint URL>/v2/resources" | python -m
json.tool
[
{
"first_sample_timestamp": "2014-08-18T19:48:39.359000",
"last_sample_timestamp": "2014-08-18T19:48:39.493000",
"links": [
{
"href":
"http://10.0.1.16:8777/v2/resources/003e8be2-cb26-4f62-8b6d9312b80a9f85",
"rel": "self"
},
{
"href":
"http://10.0.1.16:8777/v2/meters/volume.size?q.field=resource_id&q.value=003e8be2cb26-4f62-8b6d-9312b80a9f85",
"rel": "volume.size"
},
{
"href":
"http://10.0.1.16:8777/v2/meters/volume?q.field=resource_id&q.value=003e8be2-cb264f62-8b6d-9312b80a9f85",
"rel": "volume"
}
],
"metadata": {
"availability_zone": "nova",
"created_at": "2014-08-18 19:23:41",
"display_name": "TestVol",
"event_type": "volume.delete.end",
"host": "volume.rhel1.talligent.com",
"launched_at": "",
"size": "2",
"snapshot_id": "None",
"status": "creating",
"tenant_id": "2baf98f37d884c83aea636477e942684",
"user_id": "9682140a3a16469aab73a9c67beab716",
"volume_id": "003e8be2-cb26-4f62-8b6d-9312b80a9f85",
"volume_type": "None"
},
"project_id": "2baf98f37d884c83aea636477e942684",
"resource_id": "003e8be2-cb26-4f62-8b6d-9312b80a9f85",
"user_id": "9682140a3a16469aab73a9c67beab716"
}
]
Depending on the number of resources in your environment, the /resources query can return a
large amount of data and the command may take a few seconds to complete.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Preparing for Installation
Download and unzip the Openbook.zip in the /tmp directory of the OpenBook host. The unzip
directory contains two files – Openbook.war and install-openbook.sh
Scripted Installation
install-openbook.sh performs all the steps required to install OpenBook. This script accepts the
options below.
install-openbook.sh [
[
[
[
[
[
[
[
[
-w
-a
-t
-l
-m
-h
-P
-u
-p
<war file> ]
<app name> ]
<tomcat dir> ]
<OpenBook public URL> ]
<mysql command> ]
<db host> ]
<db port> ]
<db user> ]
<db password> ]
Options:
-w <war file>
Name of WAR file to intall. Default is Openbook.war
-a <app name>
Application name to install as. Default is Openbook
-t <tomcat dir>
Tomcat install directory. Minimum supported version is 6
-l <OpenBook public URL>
Protocol, host, and port of the OpenBook tomcat server, e.g.
http://10.0.1.11:8080
-m <mysql command>
MySQL client command, if not in path, e.g. /opt/mysql/bin/mysql
-h <db host>
MySQL server name. Default is localhost
-P <db port>
MySQL server port. Default is 3306
-u <db user>
MySQL user. Default is root
-p <db password>
MySQL user password.
Manual Installation
The steps below assume that tomcat is installed in /var/lib/tomcat7. If not, please substitute
the appropriate path in the command below.
Deploy the WAR on to tomcat
Copy the Openbook war file to the webapps location of your tomcat installation
cp /tmp/Openbook.war /var/lib/tomcat7/webapps
Restart tomcat
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
service tomcat7 restart
(If you have not configured tomcat as a service you can use the script files located in the bin folder
e.g. /var/lib/tomcat7/bin/startup.sh or shutdown.sh)
Create the OpenBook database schemas
mysql -uroot -p < /var/lib/tomcat7/webapps/Openbook/WEBINF/classes/db/MySQL/create_openbook_schemas.sql
Set OpenBook configuration properties
Edit the openbook.properties file located at /var/lib/tomcat7webapps/Openbook/WEBINF/classes/openbook.properties
Change the following values to match the host name/IP address of the OpenBook database server:
DB_ENTITY_HOST = 127.0.0.1
DB_WORKFLOW_HOST = 127.0.0.1
DB_JOBS_HOST = 127.0.0.1
Change the following value to match the protocol, host and port of the URL for the Openbook
tomcat server:
ROOT_PROVIDER_PUBLIC_URL = http://127.0.0.1:8080
Restart tomcat
service tomcat7 restart
Log in to OpenBook
Using the ROOT_PROVIDER_PUBLIC_URL value from above, log in to
ROOT_PROVIDER_PUBLIC_URL/Openbook with userid openbook and password Tall!g3nt
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Initial configuration For OpenStack Integration
Prior to configuring, please collect the following details for your OpenStack environment:
 Keystone public URL
 OpenStack admin user name (typically ‘admin’) and password
 OpenStack admin tenant ID (available from the Projects view in Horizon)
Configure an OpenStack resource manager
 Navigate to Configure -> Resource Managers
 Click ‘New…’
 Enter manager details, similar to below:
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Test connectivity to the OpenStack controller by clicking on the ‘Test Connection’ button. If the
connection is successful, the list of available OpenStack API endpoints by OpenStack region is
displayed.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Click on the “Synchronization Behavior” tab to set the synchronization frequency, regions to
synchronize, and other options. The region list is a comma-separated list of region names and is
automatically updated if ‘Test Connection’ succeeds and if the region has the Ceilometer service
available. Delete any regions from this list that you do not want to synchronize.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Navigate to the “Data to Synchronize” tab to choose which resource types and utilization metrics
you want to synchronize.
Click on Add to select metrics.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
When done, click Submit on the ‘OpenStack Resource Manager’ dialog to save configuration details.
Saving changes causes three actions within OpenBook:
The list of billable features is populated with OpenStack entity types
A tenant and entity synchronization is started
A periodic synchronization task is enabled to fetch provisioning events and metric data from
OpenStack
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Billable features populated with OpenStack entity types.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5
Sample view of tenants and infrastructure imported from OpenStack.
© 2014 Talligent, Inc. All rights reserved.
OpenBook QuickStart Guide 9-2014, v5