This article reviews how to add and configure an OpenStack connection using GroundWork Cloud Hub. The connection requires a unique set of parameters. If you are connecting to a remote GroundWork server to send results, you will need your remote GroundWork server RESTACCESSAPI token.
Adding a new connection
To access Cloud Hub configuration, log in to GroundWork Monitor as a member of the Admin role (e.g., user admin), and select Configuration > Cloud Hub. To add a new connection click the +Add button next to the OpenStack connector icon. You will need to create a new connection in this way for each OpenStack project to be monitored.
The data the GroundWork server receives comes from the remote virtualization server. The information is pulled from the API on a periodic basis based on the check interval that is set. In the configuration page you will need to enter both the GroundWork Server and OpenStack Connector parameters. The fas fa-info-circle link located at the top right side provides information and versioning for the selected Cloud Hub connector.
- The GroundWork Server can simply be the same as the one you are running the Cloud Hub connector on, or it can be a remote server.
- If it's the same as the one you are running on, leave the directive Use Local Connection checked.
- Otherwise, uncheck this box and fill in the hostname of the remote GroundWork server in the Hostname field, leave RESTAPIACCESS in the Username field, and paste in the the encrypted Token. The token can be obtained on the remote GroundWork server, for users within the Admin role, by going to Administration > Security under Webservices API Account: RESTAPIACCESS, Encrypted Token. Just copy the key from the remote server into the Token field on the Cloud Hub server.
Once you have the GroundWork Server side of the form filled out, click Test. If you have the credentials correct and you have access to the API, you will see a Success message. Otherwise an error will give you a hint as to what is wrong and let you try again.
Using a remote server will populate the remote server with the OpenStack monitoring data, and this will not show in the local GroundWork Server.
Table: GroundWork server values
Version Indicates the minimum GroundWork Monitor version needed. In other words, a version below the indicated value is incompatible. Hostname The host name or IP address where a Groundwork server is running. A port number should not be entered here. If Groundwork is running on the same server, you can enter localhost. Username The provisioned Username granted API access on the GroundWork server. Token The corresponding API Token for the given Username on the GroundWork server, see Administration > Security under Webservices API Account: RESTAPI Encrypted Token. SSL Check this box if the GroundWork server is provisioned with a secure HTTPS transport. Merge Hosts 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). Monitor If checked, enables connection to be monitored. Use Local Connection This directive refers to where the Cloud Hub results are sent.
If this field is checked, results will be posted to the same server as where Cloud Hub is running.
Or, with this field unchecked, you can forward results to any accessible GroundWork server you define with the name and API key.
Ownership Ownership is the owner of a connectors hosts and the ownership can be switched.
When a Cloud Hub connector is instantiated the following options are available for ownership:
Always take ownership: The connector will assume ownership of all hosts it instantiates, even merged hosts. This will remain true even if another app merges the host.
Leave ownership if already owned: The connector host will remain with the existing owner until or unless the owner deletes the host.
Always defer ownership (default): This option leaves ownership unchanged on merged hosts, and allows other apps to take ownership.
Note that multiple apps can report on a single service, but only one can own the host.
See Ownership options.
Connection Status Click Test to verify a connection using the GroundWork server entries.
Next you will need to fill in the OpenStack Connector parameters and test the connection.
- Enter a Display Name.
- Optionally check (enable) SSH on the NetApp Server.
- Enter the OpenStack Server URL.
- Enter the OpenStack Tenant ID.
- Enter an OpenStack Tenant Name.
- Enter an OpenStack Server Username.
- Enter an OpenStack Server Password.
- Enter the Nova Port Number.
- Enter the Keystone Port Number.
- Enter the Ceilometer Port Number.
- Optionally set the Sample Rate, Interval, and Retries directives.
- Validate the connection by clicking Test. A dialog will be displayed with either a Success message or, if the project cannot be contacted, an error message will be displayed with a hint as to why the connection failed. When a successful connection is made, the Connection Status buttons will change to green.
- Click Save in the upper right corner to save your correct connection parameters.
After the credentials have been validated and the resources indicated, select the Metrics link (top navigation) to start customizing metrics for the connection. Please refer to the article How to determine Cloud Hub metrics to be monitored.
Table: OpenStack server values
Display Name This is the configuration’s name displayed in the list of Cloud Hub connectors on the Cloud Hub home page. 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. 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. Ceilometer Sample Rate (in mins) The Ceilometer sample rate is 10.. 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). Connection Status Click Test to verify a connection using the OpenStack connector entries.
Cloud Hub (Documentation)
How to determine Cloud Hub metrics to be monitored (Knowledge Base)
Cloud Hub troubleshooting (Knowledge Base)
Ownership options (Documentation)
Transit Connection Generator (TCG) (Documentation)