Difference between revisions of "ZenPack:OpenStack (Tenant View)"

From Zenoss Wiki
Jump to: navigation, search
Line 34: Line 34:
 
|DataAudits=
 
|DataAudits=
 
}}
 
}}
This ZenPack allows for monitoring of OpenStack from a service provider
+
This ZenPack allows for monitoring of OpenStack. This means that you can monitor the flavors, images and servers from a user or consumer perspective.  Please watch the [http://www.youtube.com/watch?v=-43gnQLbX9g Monitoring OpenStack] video for a quick introduction that covers most of the details below.
perspective. This means that in addition to the user-oriented components
+
supported in the regular OpenStack ZenPack (instances, flavors, images), the
+
underlying OpenStack servers and software are monitored.
+
  
== Availability ==
+
{{note}} The video is of an early version of the ZenPack that doesn't have as many options when adding an OpenStack endpoint. See the usage notes below for help with the new fields available on the ''Add OpenStack'' dialog.
  
{{note}} This ZenPack is currently in a controlled availability state for
+
<blockquote>
Zenoss customers. Please contact prodmgmt@zenoss.com before deploying the
+
OpenStack is a global collaboration of developers and cloud computing technologists producing the ubiquitous open source cloud computing platform for public and private clouds. The project aims to deliver solutions for all types of clouds by being simple to implement, massively scalable, and feature rich. The technology consists of a series of interrelated projects delivering various components for a cloud infrastructure solution.
ZenPack.
+
</blockquote>
  
== Prerequisites ==
+
== Usage ==
 
+
Once the OpenStack ZenPack is installed you can begin monitoring by going to the infrastructure screen and clicking the normal button for adding devices. You'll find a new option labeled, "Add OpenStack."
* OpenStack (Icehouse or newer)
+
* Ceilometer
+
** A Zenoss-specific ceilometer plugin must be installed on your ceilometer nodes (see below)
+
** If you do not have ceilometer installed and configured properly, some graphs will be black, and Zenoss will not detect changes (such as new instances or instance state changes) until a full model operation is performed.
+
* PyYAML needs to be installed in order to use the YAML configuration         
+
** All 5.X versions of Zenoss have PyYAML already installed                   
+
** Only 4.2.4 SP763 or 4.2.5 SP378 or earlier affected                         
+
** You will have to add this Python package to your Zenoss installation otherwise
+
** Update to the latest RPS or "easy_install pyyaml" manually if required
+
* SSH credentials to the Linux devices in your OpenStack environment
+
** Configure the zCommandUsername/zCommandPassword properties on the /Devices/Server/SSH/Linux/NovaHost device class.
+
** If your Linux devices are already managed under Zenoss, move them into /Devices/Server/SSH/Linux/NovaHost
+
* Administrative credentials for your OpenStack environment
+
** Username, password, keystone URL, Region
+
 
+
== Basic Usage ==
+
 
+
Once the OpenStack ZenPack is installed and you can begin monitoring by going
+
to the infrastructure screen and clicking the normal button for adding devices.
+
You'll find a new option labeled, "Add OpenStack Endpoint (Infrastructure)."
+
  
 
Choose that option and you'll be presented with a dialog asking for the following inputs.
 
Choose that option and you'll be presented with a dialog asking for the following inputs.
  
# Device To Create - name to use for this device in Zenoss.  Should not be an actual hostname, since that name will be used when the host is registered as a Linux device.
+
# Username - Same username used to login to OpenStack web interface
# Auth URL - A keystone URL, such as http://<hostname>:5000/v2.0/
+
# API Key - Can be found by going to "Your Account/API Access"
# Username, Password/API Key, Project/Tenant ID - *Administrative* credentials to your Zenoss instance.
+
# Project ID - This can be left blank if you don't know what it is
# Region Name - choose the correct region from the dropdown.  You may only choose one, so each region you wish to manage must be registered as a separate endpoint in Zenoss.
+
# Auth URL - For Rackspace this would be https://auth.api.rackspacecloud.com/v2.0
# Ceilometer URL - Will auto-populate based on the other selections.
+
# Region Name - This can be left blank if you don't know what it is
  
Once you click Add, Zenoss will contact the OpenStack API and discover servers,
+
Once you click Add, Zenoss will contact the OpenStack API and discover servers, images and flavors. Once it is complete you'll find a new device in the OpenStack device class with the same name as the hostname or IP you entered into the dialog. Click into this new device to see everything that was discovered.
images and flavors. Once it is complete you'll find a new device in the
+
OpenStack device class with the same name as the hostname or IP you entered
+
into the dialog. Click into this new device to see everything that was
+
discovered.
+
  
 
+
The following types of elements are discovered.
===Organizational Elements===
+
* Servers
;The following organizational elements are discovered:
+
 
+
* Regions
+
* Availability Zones
+
* Tenants
+
 
+
;The following virtual-machine elements are discovered:
+
 
+
* Nova Services (processes supporting nova servers)
+
* Instances (Servers)
+
* Hosts
+
* Hypervisors
+
 
* Images
 
* Images
 
* Flavors
 
* Flavors
* Nova API Endpoints
 
  
;The following network elements are discovered:
+
The following metrics are collected.
* Neutron Agents
+
* Total Servers and Servers by State
* Networks
+
** States: Active, Build, Rebuild, Suspended, Queue Resize, Prep Resize, Resize, Verify Resize, Password, Rescue, Reboot, Hard Reboot, Delete IP, Unknown, Other
* Subnets
+
* Total Images and Images by State
* Routers
+
** States: Active, Saving, Preparing, Queued, Failed, Unknown, Other
* Ports
+
* Total Flavors
* Floating-Ips
+
* vNICs
+
  
===Metrics===
+
Status monitoring is performed on servers and images with the following mapping of state to Zenoss event severity.
;The following component level metrics are collected:
+
Instances
+
* CPU Utilization (percent)
+
* Disk Requests (requests/sec)
+
* Disk IO Rate (bytes/sec)
+
Vnics
+
* Network Packet Rate (packets/sec)
+
* Network Throughput (bytes/sec)
+
Hosts (Zenoss Linux OS monitoring)
+
* Load Average (processes)
+
* CPU Utilization (percent)
+
* Free Memory (bytes)
+
* Free Swap (bytes)
+
* IO (sectors/sec)
+
Nova Services (Zenoss Process monitoring)
+
* CPU Utilization (percent)
+
* Memory Utilization (bytes)
+
* Process Count (processes)
+
Neutron Agents
+
* CPU Utilization (percent)
+
* Memory Utilization (bytes)
+
* Process Count (processes)
+
  
 +
;Servers State to Severity Mapping
 +
: Reboot, Hard Reboot, Build, Rebuild, Rescue, Unknown == Critical
 +
: Resize == Error
 +
: Prep Resize, Delete IP == Warning
 +
: Suspended, Queue Resize, Verify Resize, Password == Info
 +
: Active == Clear
  
;The following device level metrics are collected:
+
;Images State to Severity Mapping
Flavors
+
: Failed, Unknown == Critical
* Total (count)
+
: Queued, Saving, Preparing == Info
Images
+
: Active == Clear
* Total (count)
+
* Total count per image state
+
Servers
+
* Total (count)
+
* Total count per server state
+
Queues
+
* Event (count)
+
* Performance (count)
+
Agents
+
* Total (count)
+
* Total count per agent type
+
Networks
+
* Total (count)
+
* Total count per network state
+
Routers
+
* Total (count)
+
* Total count per router state
+
  
 +
If you are also using Zenoss to monitor the guest operating system running within the server Zenoss will present the graphs for that operating system when the graphs option is chosen for the OpenStack server.
  
{{note}} All metrics collected by OpenStack Ceilometer may be collected and graphed in
+
== Changes ==
Zenoss, and all events processed through ceilometer are exposed via the
+
Zenoss Event Console.
+
  
==Ceilometer Enablement==
+
;1.2.3
 +
* Move devices from /Devices/OpenStack to /Devices/OpenStack/User
 +
* Support new OpenStackInfrastructure ZenPack
 +
* Drop support for Compute API v1.x
  
Although you may add an OpenStack device to Zenoss, as shown above, event and
+
;1.2.2
performance data will not be collected until the following steps are performed.
+
* Fix bug that could prevent data collection.
  
===Zenoss Configuration Steps===
+
;1.2.1
 
+
* Fix bug in handling of flavor ID. ([https://jira.zenoss.com/browse/ZEN-10333 ZEN-10333])
On the Zenoss host in Zenoss 4.X, or rabbitmq container in Zenoss 5.X:
+
 
+
* ssh in as the Zenoss user:
+
* export ZP_DIR=$ZENHOME/ZenPacks/ZenPacks.zenoss.OpenStackInfrastructure*
+
* Now execute:
+
 
+
<syntaxhighlight lang="bash">
+
  $ZPDIR/ZenPacks/zenoss/OpenStackInfrastructure/bin/openstack_amqp_config
+
</syntaxhighlight>
+
 
+
This script will create a new user in rabbitmq and set up its permissions.  It
+
will print out the proper values to use for amqp_hostname, amqp_port,
+
amqp_userid, amqp_password, and amqp_virtualhost during ceilometer
+
configuration (see below)
+
 
+
===OpenStack Ceilometer Configuration Steps===
+
 
+
Zenoss relies upon a ceilometer dispatcher plugin to ship raw event and
+
metering data from ceilometer to Zenoss for storage in the Zenoss event
+
and performance databases.  This integration is done by publishing messages
+
to Zenoss's RabbitMQ server.
+
 
+
This dispatcher should be installed on all nodes running any ceilometer, but
+
particularly those running ceilometer-collector or ceilometer-agent-notification.
+
 
+
To install it, perform the following steps on each of these OpenStack nodes (NOT
+
on the Zenoss collector):
+
 
+
<syntaxhighlight lang="bash">
+
  sudo pip -q install --force-reinstall https://github.com/zenoss/ceilometer_zenoss/archive/master.zip
+
  sudo cp /usr/lib/*/site-packages/ceilometer_zenoss/event_definitions.yaml /etc/ceilometer/
+
</syntaxhighlight>
+
 
+
Edit /etc/ceilometer/ceilometer.conf, and add the following lines to the
+
appropriate sections:
+
 
+
<syntaxhighlight lang="text">
+
  [DEFAULT]
+
  dispatcher=zenoss
+
 
+
  [notification]
+
  store_events=True
+
</syntaxhighlight>
+
 
+
Also add the [dispatcher_zenoss] section reported by openstack_amqp_config above.
+
 
+
{{note}} Please restart all ceilometer services on all hosts after making these changes.
+
 
+
===Optional Steps===
+
 
+
====VM State Changes====
+
 
+
By default, instance state changes will be captured by Zenoss when certain
+
events occur, for example, when an instance is shut down, the state change
+
to SHUTDOWN will be reflected in Zenoss.
+
 
+
However, certain state changes that don't correspond to another defined event
+
may not be picked up until the next time Zenoss models the environment.
+
 
+
If you would like to reduce the likelihood of this occurring, you can configure
+
OpenStack Nova to send an event (through ceilometer) to Zenoss whenever
+
any VM state change occurs by adding the following to nova.conf:
+
 
+
<syntaxhighlight lang="text">
+
  [DEFAULT]
+
  notify_on_state_change=vm_state
+
</syntaxhighlight>
+
 
+
Note that this will cause increased event load, both on OpenStack and Zenoss,
+
and additional processing within the event transforms in Zenoss to keep
+
the model consistent.  Since most instance changes will still be caught
+
without this option enabled, it is recommended to leave this disabled if your
+
OpenStack environment is very large.
+
 
+
====Increasing Polling Interval====
+
 
+
Zenoss will process performance datapoints from ceilometer every 5 minutes, but
+
by default, ceilometer will only produce one datapoint every 10 minutes.  This
+
can be adjusted by modifying the "interval: 600" line in your
+
pipeline.yaml file (typically /etc/ceilometer/pipeline.yaml) to 300 seconds.
+
 
+
== Zenoss Analytics ==
+
 
+
This ZenPack provides additional support for Zenoss Analytics. Perform the
+
following steps to install extra reporting resources into Zenoss Analytics
+
after installing the ZenPack.
+
 
+
# Copy analytics-bundle.zip from $ZENHOME/ZenPacks/ZenPacks.zenoss.OpenStackInfrastructure*/ZenPacks/zenoss/OpenStackInfrastructure/analytics/ on your Zenoss server.
+
# Navigate to Zenoss Analytics in your browser.
+
# Login as superuser.
+
# Remove any existing ''OpenStackInfrastructure ZenPack'' folder.
+
## Choose ''Repository'' from the ''View'' menu at the top of the page.
+
## Expand ''Public'' in the list of folders.
+
## Right-click on ''OpenStackInfrastructure ZenPack'' folder and choose ''Delete''.
+
## Confirm deletion by clicking ''OK''.
+
# Add the new ''OpenStackInfrastructure ZenPack'' folder.
+
## Choose ''Server Settings'' from the ''Manage' menu at the top of the page.
+
## Choose ''Import'' in the left page.
+
## Remove checks from all check boxes.
+
## Click ''Choose File'' to import a data file.
+
## Choose the analytics-bundle.zip file copied from your Zenoss server.
+
## Click ''Import''.
+
 
+
You can now navigate back to the ''OpenStackInfrastructure ZenPack'' folder in the repository to see the following resources added by the bundle.
+
 
+
;Domains
+
* OpenStackInfrastructure Domain
+
 
+
;Ad Hoc Views
+
* OpenStack Instance List
+
 
+
Domains can be used to create ad hoc views using the following steps.
+
 
+
# Choose ''Ad Hoc View'' from the ''Create'' menu.
+
# Click ''Domains'' at the top of the data chooser dialog.
+
# Expand ''Public'' then ''OpenStackInfrastructure ZenPack''.
+
# Choose the ''OpenStackInfrastructure Domain'' domain
+
 
+
 
+
=== Service Impact and Root Cause Analysis ===
+
 
+
When combined with the Zenoss Service Dynamics product, this ZenPack adds
+
built-in service impact and root cause analysis capabilities for OpenStack
+
infrastructure and instances. The service impact relationships shown in the
+
diagram and described below are automatically added. These will be included in
+
any services that contain one or more of the explicitly mentioned components.
+
 
+
[[File:impact.png|thumb|320px|Impact Relationship Diagram]]
+
 
+
====Recommended Impact Setup====                                               
+
                                                                               
+
Since most components will be related to Tenants and Region we recommend:     
+
                                                                               
+
* Navigate to Services (Impact)                                               
+
* Add a Dynamic Service to your Services tab                                   
+
* Add all Tenants to the Dynamic Service                                       
+
* Add all Regions to the Dynamic Service                                                                                                   
+
+
====Impact Relations====
+
 
+
Component failures will affect Impact as follows:
+
 
+
;Internal Impact Relationships
+
* OpenStack API endpoint impacts all Hosts
+
* Availabilty zone impacts associated Region
+
* Host impacts associated Hypervisors, Nova Services, Cells, Nova Apis, and Neutron Agents
+
* Hypervisor impacts the resident Instances (VMs)
+
* Nova Service affects the Availability Zone or Region that it supports
+
* Instance impacts the associated Tenant
+
* vNIC impacts the related Instance.
+
* Port impacts associated Instance
+
* Subnet impacts associated Ports
+
* Floating-IP impacts associated Port
+
* Network impacts associated Subnets and Tenants
+
* Router impacts associated Subnets and Floating-ips
+
* Neutron Agent impacts associated Networks, Subnets and Routers
+
 
+
;External Impact Relationships
+
* Instance impacts guest operating system device.
+
* Cisco UCS vNIC impacts related host's underlying Linux device NIC.
+
* Cisco UCS service profile impacts host's underlying Linux device.
+
* Host impacted by associated Linux device.
+
* OS Processes on an underlying Linux device impact corresponding Nova Services on Host.
+
 
+
 
+
== Known Issues ==
+
 
+
# [https://jira.zenoss.com/browse/ZEN-14803 ZEN-14803]: Ceilometer AMQP Heartbeat monitoring expects ceilometer-collector and ceilometer-agent-notification to run on a single host
+
## Most commonly, these processes would run on a single controller node, so this will not impact most users.  No workaround available.
+
# [https://jira.zenoss.com/browse/ZEN-14585 ZEN-14585]: The same endpoint can not be monitored both as user and an infrastructure endpoints.
+
## Workaround: If you have been previously monitoring the endpoint as a User endpoint, delete the device before you re-add it as an Infrastructure endpoint.
+
# [https://jira.zenoss.com/browse/ZEN-14491 ZEN-14491]: A stacktrace may occur during the initial modeling of the device
+
## The trace will contain the error "ValueError: expected txn status 'Active' or 'Doomed', but it's 'Committed'"
+
## Workaround: Disregard the error.  You may also manually model the device to confirm that no further errors are reported.
+
# [https://jira.zenoss.com/browse/ZEN-17905]: Nova APIs component: Grey icons for Enabled and State after model/monitor.
+
## OpenStack nova service API does not provide information about Nova-API, so its status is, in fact, unknown.
+
 
+
== Changes ==
+
  
;2.0.0
+
;1.2.0
* Initial Release
+
* Add support for compute API versions 2 and 3. Still support version 1.
 +
* Add zOpenstackComputeApiVersion configuration property.
 +
* Update python-novaclient to 2.15.0.
 +
* Support uuid format for image identifier.
  
;2.1.0
 
* Added Neutron network components
 
* Update Impact models for Neutron
 
* Update multiple UI interfaces
 
* Upgrade to ZenPackLib 1.0.1
 
* Add ML2 Pluggin Capability
 
* Add OpenvSwitch Integration
 
 
{{ZenPackFooter}}
 
{{ZenPackFooter}}

Revision as of 17:32, 22 July 2015

Organization
Zenoss, Inc.
License
GNU General Public License, Version 2, or later
ZenPack name
ZenPacks.zenoss.OpenStack
More Information
GitHub page/HomePage
Git sources (for cloning)
Link


Applications Monitored: 



OpenStack (Tenant View) ZenPack

This project is a Zenoss extension (ZenPack) that allows for monitoring of OpenStack. This means that you can monitor the flavors, images and servers from a user or consumer perspective.

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This is an Open Source ZenPack developed by Zenoss, Inc. Enterprise support for this ZenPack is available to commercial customers with an active subscription.

Releases

Version 1.2.3- Download
Summary of changes: * Move devices from /Devices/OpenStack to /Devices/OpenStack/User
Released on 2014/10/09
Compatible with Zenoss Core 4.2.x, Zenoss Core 5.0.x, Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x
Version 1.2.2- Download
Released on 2014/02/27
Compatible with Zenoss Core 3.1.x, Zenoss Core 3.2.x, Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x
Version 1.1.6- Download
Released on 2013/06/12
Compatible with Zenoss Core 3.1.x, Zenoss Core 3.2.x, Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x

Background

This ZenPack allows for monitoring of OpenStack. This means that you can monitor the flavors, images and servers from a user or consumer perspective. Please watch the Monitoring OpenStack video for a quick introduction that covers most of the details below.

Bulbgraph.png Note: The video is of an early version of the ZenPack that doesn't have as many options when adding an OpenStack endpoint. See the usage notes below for help with the new fields available on the Add OpenStack dialog.

OpenStack is a global collaboration of developers and cloud computing technologists producing the ubiquitous open source cloud computing platform for public and private clouds. The project aims to deliver solutions for all types of clouds by being simple to implement, massively scalable, and feature rich. The technology consists of a series of interrelated projects delivering various components for a cloud infrastructure solution.

Usage

Once the OpenStack ZenPack is installed you can begin monitoring by going to the infrastructure screen and clicking the normal button for adding devices. You'll find a new option labeled, "Add OpenStack."

Choose that option and you'll be presented with a dialog asking for the following inputs.

  1. Username - Same username used to login to OpenStack web interface
  2. API Key - Can be found by going to "Your Account/API Access"
  3. Project ID - This can be left blank if you don't know what it is
  4. Auth URL - For Rackspace this would be https://auth.api.rackspacecloud.com/v2.0
  5. Region Name - This can be left blank if you don't know what it is

Once you click Add, Zenoss will contact the OpenStack API and discover servers, images and flavors. Once it is complete you'll find a new device in the OpenStack device class with the same name as the hostname or IP you entered into the dialog. Click into this new device to see everything that was discovered.

The following types of elements are discovered.

  • Servers
  • Images
  • Flavors

The following metrics are collected.

  • Total Servers and Servers by State
    • States: Active, Build, Rebuild, Suspended, Queue Resize, Prep Resize, Resize, Verify Resize, Password, Rescue, Reboot, Hard Reboot, Delete IP, Unknown, Other
  • Total Images and Images by State
    • States: Active, Saving, Preparing, Queued, Failed, Unknown, Other
  • Total Flavors

Status monitoring is performed on servers and images with the following mapping of state to Zenoss event severity.

Servers State to Severity Mapping
Reboot, Hard Reboot, Build, Rebuild, Rescue, Unknown == Critical
Resize == Error
Prep Resize, Delete IP == Warning
Suspended, Queue Resize, Verify Resize, Password == Info
Active == Clear
Images State to Severity Mapping
Failed, Unknown == Critical
Queued, Saving, Preparing == Info
Active == Clear

If you are also using Zenoss to monitor the guest operating system running within the server Zenoss will present the graphs for that operating system when the graphs option is chosen for the OpenStack server.

Changes

1.2.3
  • Move devices from /Devices/OpenStack to /Devices/OpenStack/User
  • Support new OpenStackInfrastructure ZenPack
  • Drop support for Compute API v1.x
1.2.2
  • Fix bug that could prevent data collection.
1.2.1
  • Fix bug in handling of flavor ID. (ZEN-10333)
1.2.0
  • Add support for compute API versions 2 and 3. Still support version 1.
  • Add zOpenstackComputeApiVersion configuration property.
  • Update python-novaclient to 2.15.0.
  • Support uuid format for image identifier.

Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.OpenStack-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone git://github.com/zenoss/ZenPacks.zenoss.OpenStack.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.OpenStack
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus