OpenStack

h6. Overview

This page reviews how to add and configure a OpenStack connection using GroundWork Cloud Hub. The connection requires a unique set of parameters (e.g., endpoint, credentials). You will need your GroundWork server and virtual environment connector parameters handy.{section}
{column:width=33%}CONTENTS
{toc:minLevel=1|maxLevel=1|printable=false}
{column}{column:width=33%}RELATED RESOURCES
* [About GroundWork Hubs|About GroundWork Hubs]
* [openstack.org|https://www.openstack.org/software/]{column}
{column}{color:#333333}WAS THIS PAGE HELPFUL?{color}

* {html}<a href="mailto:training@gwos.com?subject=OpenStack Connection">Leave Feedback</a>{html}{column}{section}

h1. 1.0 Adding a New Connection

The initial Cloud Hub screen is used to add, start, stop, modify, or delete available connectors. Follow the steps below to add a connection.&nbsp;You will need to create a new connection in this way for each region to be monitored.

# Log in to GroundWork Monitor as an _Administrator_.
# Select *GroundWork Administration* > *GroundWork Cloud Hub*.
# Click&nbsp;*\+Add*&nbsp;corresponding to the _OpenStack_ connector icon.&nbsp;
\\
\\
Figure: Adding a connection
!bookshelf_cloud_hub_openstack_01.jpg|thumbnail!

h1. 2.0 Configuring the Connection

In the configuration page you will need to enter both the GroundWork server and remote server parameters.

{color:#333333}The data the GroundWork server receives comes from the remote virtualization server.{color} {color:#333333}The GroundWork server is where Cloud Hub will store the connectors metrics.&nbsp;{color}{color:#333333}The information is pulled from the API on a periodic basis based on the check interval that is set.{color}

h4. 2.1 GroundWork Server Parameters

# Here we enter the GroundWork server parameters, each described in the table below.
\\
\\
Figure: GroundWork server values
\\ !bookshelf_cloud_hub_openstack_02.jpg|thumbnail!\\
\\
Table: GroundWork server values
| GroundWork Server Version | The GroundWork server version number which is set to the latest release installed. Cloud Hub can be configured to talk to versions from GroundWork Monitor version 7.0. |
| Display Name | This is the configuration’s name displayed in the list of Cloud Hub connectors on the Cloud Hub home page. |
| GroundWork Server Name | The host name or IP address of the GroundWork server that will integrate the Cloud Hub messages. A port number should not be entered here.&nbsp;If Cloud Hub is running on the same server as the portal the name can be _localhost_, or as preferred the server name. Often the GroundWork server is the same server where Cloud Hub is running however, Cloud Hub can also run in a distributed environment on its own node in a GroundWork cluster. \\ |
| Is SSL enabled on GroundWork Server? | Check this box if the GroundWork server is provisioned with a secure HTTPS transport. |
| GroundWork Web Services Username | This is the provisioned user name granted API access on the GroundWork server. This value defaults to _RESTAPIACCESS_, and can be located&nbsp;by opening a tab to the&nbsp;_GroundWork Administration_&nbsp;>&nbsp;_GroundWork License_&nbsp;page. The value is under&nbsp;_Webservices API Account Info_ in the _Access_ field. {note:title:IMPORTANT}For all systems, make sure the Web Services Username and Password match with the entries in the {{ws_client.properties}} file.{note} |
| GroundWork Web Services Password \\ | This is the corresponding API Token (password) for the given user name on the GroundWork server.&nbsp;This is obtained by opening a tab to the&nbsp;_GroundWork Administration_&nbsp;>&nbsp;_GroundWork License_&nbsp;page.&nbsp;The value is under&nbsp;_Webservices API Account Info_&nbsp;in the _Token (encrypted)_&nbsp;field. {note:title:IMPORTANT}For all systems, make sure the Web Services Username and Password match with the entries in the {{ws_client.properties}} file.{note} |
| Merge hosts on GroundWork Server? | If checked, this option combines all metrics of same named hosts under one host. For example, if there is a Nagios configured host named _demo1_ and a Cloud Hub discovered host named _demo1_, the services for both configured and discovered hosts will be combined under the hostname _demo1_ (case-sensitive). \\ |

h4. 2.2 Remote Server Parameters

# Here we enter the remote server parameters, each described in the table below.
\\
\\
Figure: Remote server values
!bookshelf_cloud_hub_openstack_03.jpg|thumbnail!\\
\\
Table: OpenStack server values
| Is SSL enabled on OpenStack server? | Check this box if the OpenStack server is configured for secure HTTPS. |
| OpenStack Server URL | This is the URL for the OpenStack virtualization server (e.g., {{openstack.yourdomain.com}}). |
| OpenStack Tenant ID \\ | This is the ID for the OpenStack group of users. \\ |
| OpenStack Tenant Name \\ | This is the Name for the OpenStack group of users. \\ |
| OpenStack Server Username \\ | The provisioned Username granted API access on the OpenStack server. \\ |
| OpenStack Server Password \\ | The corresponding Password for the given Username on the OpenStack server. | x | x |
| Nova Port Number | The Nova API listen on port {{8774}} for OpenStack API. |
| Keystone Port Number | The Keystone port number is {{5000}} (public port). |
| Ceilometer Port Number | The Ceilometer port number is {{8777}}. |
| Check Interval (in mins) | This is the polling interval for collecting monitoring data from the virtual instance and sending it to the GroundWork server. The value is in minutes. |
| Connection Retries (-1 infinite) | This entry is the number of retries for the connection and sets a limit on how many attempts are made after a failure. If you set this to \-1, the retrying goes on forever. The number set indicates how many connections are attempted before the connection is left inactive (until you restart it). |
# After the remote server parameters have been entered, click&nbsp;*SAVE*&nbsp;which saves and writes the entries to an XML file in the GroundWork server {{/usr/local/groundwork/conifg/cloudhub}} directory. The Cloud Hub connector is assigned an agent ID and that in turn becomes a record locator in Foundation when you begin monitoring.
# Next, validate the configuration by selecting&nbsp;*TEST CONNECTION*&nbsp;which will check if the connection is accessible with the given credentials. A dialog will be displayed with either a success message or, if the server cannot be contacted, an error message will be displayed with information describing why the connection failed.
# After the credentials have been validated, select *NEXT* to display an associated connection metrics screen where you can determine the metrics to be monitored.

h1. 3.0 Determining Metrics To Be Monitored

Each management system provides metrics for specific checks that can be defined for the instance or the container. The property name and the thresholds are defined in a monitoring profile in an XML format.

In the UI the metrics are separated into categories, e.g.,&nbsp;{color:#333333}{_}Hypervisor Thresholds{_}{color}{color:#333333}, and&nbsp;{color}{color:#333333}{_}Virtual Machine Thresholds (Ceilometer)_{color}{color:#333333}, and&nbsp;{color}{color:#333333}{_}Virtual Machine Thresholds (Nova Compute)_{color}, where you can define if a metric should be monitored, graphed, and also set the values for&nbsp;_Warning_&nbsp;and&nbsp;_Critical_&nbsp;thresholds at which to trigger alerts. By default some of these thresholds are set to&nbsp;_\-1_&nbsp;which turns them off so you can get an idea by watching the data coming in and then setting a value appropriate for the environment. The&nbsp;_Service Name_&nbsp;field enables overriding of the automatically generated service name.&nbsp;

The selections made are applied to every instance discovered in the region. The set of selections is saved on the GroundWork server in the&nbsp;{{/usr/local/groundwork/config/cloudhub/profiles}}&nbsp;directory as a profile in an XML file. The selections become effective both against new instances that may be discovered as well as already monitored instances.

# Here we adjust any profile selections, each described in the table below.
\\
\\
Figure: OpenStack profile metrics
\\ !bookshelf_cloud_hub_openstack_04.jpg|thumbnail!\\
\\
Table: OpenStack profile attribute options
| Attribute | The name of the service attribute (the metric name reported by the virtualization server). |
| Monitored | When on (checked) the service will be monitored. |
| Graphed | When on (checked) the service will be graphed. |
| Warning and Critical Thresholds | These values control the triggering of alerts. A _Warning_ number larger than the _Critical_ value will cause Cloud Hub to detect the metric as a trigger. Choosing a {{\-1}} in a threshold box will disable triggering on that alert. |
| Service Name | Cloud Hub automatically creates service names based on the metric name gathered from a virtualization server. The _Service Name_ option adds the ability to report the polled metrics under a unique name that is set by the Administrator.&nbsp;Leaving the _Service Name_ field blank defaults to the metric name reported by the virtualization server. All Cloud Hub connectors now support the editable _Service Name_ feature. |
| Description | A description of the service attribute. |
# When you are satisfied with the profile selections click&nbsp;*SAVE* to write out the profile.
# Click&nbsp;*HOME* to return to the main Cloud Hub panel.
# Click *START* for the specific connector to begin the discovery and data collection process.
{tip}At anytime, if you decide you do not want to monitor a particular region, simply navigate back to this point (_GroundWork Administration_ > _GroundWork Cloud Hub_) and select _STOP_ for the corresponding connector, the connectors configuration will be maintained for a subsequent _START_. To stop and completely delete a connection see [How to delete GroundWork Hub hosts|How to delete hosts#deletecloudhubhosts].{tip}