OpenStack data source
The OpenStack (REST API / KVM) data source collects information about OpenStack hardware instances. This data source collects inventory data for all OpenStack instances, and optionally, VM performance data.
Requirements
The following are requirements for configuring the OpenStack data source.
-
IP address of the OpenStack controller
-
OpenStack admin role credentials and sudo access to the Linux KVM hypervisor are recommended.
If you are not using an admin account or admin equivalent privileges, you can still acquire data from the data source. You will need to modify the policy configuration file (i.e. etc/nova/policy.json) to allow users with non-admin role to call the API:
-
"os_compute_api:os-availability-zone:detail": ""
-
"os_compute_api:os-hypervisors": ""
-
os_compute_api:servers:detail:get_all_tenants": ""
-
-
For performance collection the OpenStack Ceilometer module must be installed and configured. Configuring the Ceilometer is done by editing the
nova.conf
file for each hypervisor and then restart the Nova Compute service on each hypervisor. The option name changes for different releases of OpenStack:-
Icehouse
-
Juno
-
Kilo
-
Liberty
-
Mitaka
-
Newton
-
Ocata
-
-
For CPU stats, "compute_monitors=ComputeDriverCPUMonitor" needs to be turned on in /etc/nova/nova.conf on compute nodes.
-
Port requirements:
-
5000 for http and 13000 for https, for the Keystone service
-
22 for KVM SSH
-
8774 for Nova Compute Service
-
8776 for Cinder Block Service
-
8777 for Ceilometer Performance Service
-
9292 for Glance Image Service
The port binds to the specific service, and the service may run on the controller or another host in larger environments.
-
Configuration
Field |
Description |
OpenStack Controller IP Address |
IP address or fully-qualified domain name of the OpenStack Controller |
OpenStack Administrator |
User name for an OpenStack Admin |
OpenStack Password |
Password used for the OpenStack Admin |
OpenStack Administrator Tenant |
OpenStack Administrator Tenant |
KVM Sudo User |
KVM Sudo User name |
Choose 'Password' or 'OpenSSH Key File' to specify credential type |
The credential type used to connect to the device via SSH |
Full Path to Inventory Private Key |
Full Path to Inventory Private Key |
KVM Sudo Password |
KVM Sudo Password |
Advanced configuration
Field |
Description |
Enable hypervisor inventory discovery through SSH |
Check this to enable hypervisor inventory discovery through SSH |
OpenStack Admin URL port |
OpenStack Admin URL port |
Use HTTPS |
Check to use secure HTTP |
HTTP Connection Timeout (sec) |
Timeout for HTTP connection (default 300 seconds) |
SSH Port |
Port used for SSH |
SSH Process Wait Timeout (sec) |
SSH process timeout (default 30 seconds) |
SSH Process Retries |
Number of inventory retry attempts |
Inventory Poll Interval (min) |
Interval between inventory polls (default 20 minutes) |