Difference between revisions of "Zenoss Core 5 Beta/Download"

From Zenoss Wiki
Jump to: navigation, search
m
(Initial Modeling)
(72 intermediate revisions by 8 users not shown)
Line 1: Line 1:
#REDIRECT [[:Install_Zenoss]]
+
The Alpha program uses a virtual appliance for ease of evaluation. A VMWare and Oracle VirtualBox appliance have been provided.
  
The Zenoss Core 5 Beta 3 release is provided as a virtual appliance. It also supports manual deployment.
+
== Download ==
  
This page provides download and deployment instructions for the Zenoss Core 5 Beta 3.  
+
To run Zenoss Core 5 Alpha, first download the appliance of your choice from SourceForge: https://sourceforge.net/projects/zenoss/files/zenoss-alpha/builds/europa-122/
  
For frequently asked questions related to the Zenoss Core 5/Europa Beta 3 release, see the [[Zenoss_Core_5_Beta/FAQ|Zenoss Core 5 Beta FAQ]].
+
== Run Appliance ==
==Documentation==
+
The installation guide will get your Zenoss Core 5 Beta 3 instance up and running, the Eval Guide will allow you to demo the new features in this release of Zenoss Core 5.  Instructions to add an apt repo with Zenoss Core 5 are in the Install Guide.
+
  
Install guide(PDF):
+
Start Appliance using either VMWare Player or Oracle VirtualBox, and note down the banner URL reference, which should include an IP address and port in the pre-login banner. If it doesn't appear, log in as <tt>root</tt>/<tt>zenoss</tt> and run <tt>ifconfig eth0</tt> to display the IP address of the appliance.
* [https://beta.zenoss.io/Core-5-Beta-3/Documentation/Zenoss_Core_Beta_Installation_Guide_r5.0.0b3_d09.14.325.pdf Zenoss Core 5 Beta 3 Installation Guide]
+
  
== Appliance ==
+
[[File:Alpha 5 Appliance Banner.png]]
Open Virtualized Appliance (VMware, VirtualBox, RHEV, etc...):
+
* [https://beta.zenoss.io/Core-5-Beta-3/Appliance/VMware/zenoss-core-5.0.0-2014-11-23.vmware.ova Zenoss Core 5 Beta 3 OVA]
+
  
== Auto install script ==
+
As you can see upon boot, we are currently using Fedora 19 as a development platform and will be targeting (at a minimum) RHEL and CentOS for the release version of Core 5.
Community version:
+
 
* Beta 2 version: https://github.com/jangaraj/zenoss/blob/master/scripts/core-autodeploy.sh
+
== Open Web Browser ==
 +
 
 +
Now, open up your Web browser and navigate to <tt>http://[ApplianceIP]:8080</tt>. In the example above, the address would be <tt>http://192.168.3.136:8080</tt>.
 +
 
 +
{{note| If you don’t see Zenoss come up after navigating to the appliance web address, you may need to check a couple of things in the appliance, whcih is described in the troubleshooting section below. }}
 +
 
 +
The following Zenoss setup screen will appear in your browser:
 +
 
 +
[[File:Alpha 5 Setup.png]]
 +
 
 +
Click on "Get Started!". We are now ready to enter the configuration settings for this install of Zenoss.
 +
 
 +
== Initial Settings ==
 +
 
 +
You will be greeted by an initial settings screen that looks like this:
 +
 
 +
[[File:Alpha 5 Initial Settings.png|border]]
 +
 
 +
Fill out these fields as follows:
 +
 
 +
;Hostname: localhost
 +
;Device Type: Linux Server (SSH)
 +
 
 +
Use the following SSH Credentials:
 +
 
 +
;User: <tt>root</tt>
 +
;Password: <tt>zenoss</tt>
 +
 
 +
Now, click on the "Save" button and skip the rest of the setup.
 +
 
 +
Zenoss is now ready to use! :)
 +
 
 +
== Initial Modeling ==
 +
 
 +
Now, let's model the appliance within Zenoss, so that we don't need to wait for modeling to happen on its own. Enter in <tt>localhost</tt> in the search bar at the top hand corner of the UI:
 +
 
 +
[[File:Alpha 5 Localhost.png]]
 +
 
 +
Click on the localhost link presented by the search bar, and model the device manually by clicking on the plus sign at the bottom of the UI and selecting "Model Device":
 +
 
 +
[[File:Alpha 5 Model.png]]
 +
 
 +
The following screen will appear and there should be no errors returned once the model job has completed. If there are errors, review error messages and correct the stated issue(s) and/or seek help in the forums or on IRC:
 +
 
 +
[[File:Alpha 5 Model 2.png]]
 +
 
 +
The following components should now appear on the left hand pane of the device:
 +
 
 +
[[File:Alpha 5 Components.png]]
 +
 
 +
'''Note:''' If you click on any of the components or graphs, you may see the following error message in the UI:
 +
 
 +
[[File:Alpha 5 Error.png|200px]]
 +
 
 +
The error message is OK, it just means the metric tag has not been created yet. The new back-end takes a JIT approach and will create new tags as they are added to the system vs. pre-populating the Hbase back-end with a bunch of KPI tags that may never be populated. If you wait a few minutes (polling cycle dependent - default is 5 minutes) you should start to see time series data being rendered in the new graphs, similar to the example below:
 +
 
 +
[[File:Alpha 5 Graph Tooltip.png]]
 +
 
 +
== Exploring the New Back-end ===
 +
 
 +
Here are some things you can explore related to the new performance data back-end that you may want to explore and test out.
 +
 
 +
=== CSV Output ===
 +
 
 +
Data be exported to CSV through each graph widget via the cog icon embedded in the title bar:
 +
 
 +
[[File:Alpha 5 CSV.png]]
 +
 
 +
=== JSON View ===
 +
 
 +
The underlying JSON data structure can also be viewed by clicking on "Definition":
 +
 
 +
[[File:Alpha 5 JSON.png]]
 +
 
 +
If you look carefully, you can see where the metric and tag data is stated. This information can be used directly for querying and graphing time series data directly in the TSD interface section below.
 +
 
 +
=== Time Series Data Interface ===
 +
 
 +
For those who are curious as to how we are leveraging TSD under the covers, you can take a look at the TSD UI via <tt>http://[ApplianceIP]:4242/</tt> or telnet directly into TSD via telnet [ApplianceIP] 4242.
 +
 
 +
[[File:Alpha 5 TSD.png]]
 +
 
 +
The TSD UI has built-in auto-complete, so you can quickly find interesting metrics to graph against. Try a combination of uppercase and lowercase letters when searching for metrics.
 +
 
 +
[[File:Alpha 5 TSD Metrics 1.png]]
 +
 
 +
For tags, you can use wildcard expressions, thus any metric with one or more tags can be rendered on the same graph.
 +
 
 +
[[File:Alpha 5 TSD Metrics 2.png]]
 +
 
 +
You can even plot different metrics on the same graph across multiple targets. You can even plot different metrics on the same graph across multiple targets, by clicking on the "+" tab. In future, API documentation will be provided so you can build your own graphs and also be able to import/export data as needed.
 +
 
 +
'''Note:''' The current version of OpenTSDB has no authentication functionality, thus it will most likely only be able for debugging/development in the final release and the UI/API will . A REST API will be available which will require authentication before any query is executed.
 +
 
 +
== Troubleshooting ==
 +
 
 +
If the web UI appears inaccessible after starting the appliance and navigating to the stated IP:port combination, verify the network configuration of your VM appliance.
 +
 
 +
If in doubt, set the network configuration to bridged mode (assuming you are on the same network as a DHCP server) and restart the appliance, or restart the network service within the appliance itself, run ifconfig and then try again.
 +
 
 +
=== Connection Problems ===
 +
 
 +
If you see any errors in the console around not unable to connect to 127.0.0.1:9001, please follow these steps. First, SSH into the appliance (user: root, password: zenoss). Then:
 +
 
 +
 
 +
<console>
 +
# ##i##rm $ZENHOME/var/supervisord.pid
 +
# ##i##zenoss restart
 +
</console>
 +
 
 +
Run <tt>netstat -ant | grep 8080</tt> and see if there anything is listening on 8080, if there is you are gold. If there isn't then restart the appliance and try again.
 +
 
 +
=== Further Troubleshooting ===
 +
 
 +
If you are still having issues with the UI coming up or seeing connection refused error messages in the graphs, try the following steps. First, SSH into appliance (user: root, password: zenoss). Then:
 +
 
 +
 
 +
<console>
 +
# ##i##rm $ZENHOME/var/supervisord.pid
 +
# ##i##zenoss shutdown
 +
# ##i##service hbase restart
 +
# ##i##service opentsdb restart
 +
# ##i##su - zenoss
 +
# ##i##zenoss start
 +
# ##i##zsupervisor
 +
# ##i##stop all
 +
# ##i##start all
 +
# ##i##exit
 +
</console>
 +
 
 +
Now, run <tt>netstat -ant | grep 8080</tt> and see if there anything is listening on 8080, if there is you are gold. Else, try rebooting the appliance.
 +
 
 +
== Bugs ==
 +
 
 +
We gladly accept bugs as a token of appreciation from our community. The filing process is the same as it is for available Core releases. The main difference is the affected version is code named ‘europa’.
 +
 
 +
If you don’t have a JIRA account already, please go ahead and create one, by navigating to jira.zenoss.com. Sign-up link: https://jira.zenoss.com/secure/Signup!default.jspa
 +
 
 +
Once you have created an account, the process is pretty straight-forward for filing a bug.
 +
 
 +
# Click on the Create Issue button on the top of the UI
 +
# Fill out the following fields and attach any relevant screenshots/log files as required
 +
 
 +
Please use the defect priority guide below when filing bugs:
 +
 
 +
{| class="wikitable"
 +
!Priority
 +
!Description
 +
|-
 +
|1
 +
|System crash, loss of data, loss of monitoring. This bug will take top priority with development and stop the release of the software until fixed.
 +
|-
 +
|2
 +
|A Feature is not functioning and no workaround exists. Next highest priority for development; will not hold up release.
 +
|-
 +
|3
 +
|A Feature is not functioning a workaround exists.
 +
|-
 +
|4
 +
|Lowest severity, minor issues, cosmetic issues.
 +
|}

Revision as of 01:32, 18 December 2013

The Alpha program uses a virtual appliance for ease of evaluation. A VMWare and Oracle VirtualBox appliance have been provided.

Download

To run Zenoss Core 5 Alpha, first download the appliance of your choice from SourceForge: https://sourceforge.net/projects/zenoss/files/zenoss-alpha/builds/europa-122/

Run Appliance

Start Appliance using either VMWare Player or Oracle VirtualBox, and note down the banner URL reference, which should include an IP address and port in the pre-login banner. If it doesn't appear, log in as root/zenoss and run ifconfig eth0 to display the IP address of the appliance.

Alpha 5 Appliance Banner.png

As you can see upon boot, we are currently using Fedora 19 as a development platform and will be targeting (at a minimum) RHEL and CentOS for the release version of Core 5.

Open Web Browser

Now, open up your Web browser and navigate to http://[ApplianceIP]:8080. In the example above, the address would be http://192.168.3.136:8080.

Bulbgraph.png Note: If you don’t see Zenoss come up after navigating to the appliance web address, you may need to check a couple of things in the appliance, whcih is described in the troubleshooting section below.

The following Zenoss setup screen will appear in your browser:

Alpha 5 Setup.png

Click on "Get Started!". We are now ready to enter the configuration settings for this install of Zenoss.

Initial Settings

You will be greeted by an initial settings screen that looks like this:

Alpha 5 Initial Settings.png

Fill out these fields as follows:

Hostname
localhost
Device Type
Linux Server (SSH)

Use the following SSH Credentials:

User
root
Password
zenoss

Now, click on the "Save" button and skip the rest of the setup.

Zenoss is now ready to use! :)

Initial Modeling

Now, let's model the appliance within Zenoss, so that we don't need to wait for modeling to happen on its own. Enter in localhost in the search bar at the top hand corner of the UI:

Alpha 5 Localhost.png

Click on the localhost link presented by the search bar, and model the device manually by clicking on the plus sign at the bottom of the UI and selecting "Model Device":

Alpha 5 Model.png

The following screen will appear and there should be no errors returned once the model job has completed. If there are errors, review error messages and correct the stated issue(s) and/or seek help in the forums or on IRC:

Alpha 5 Model 2.png

The following components should now appear on the left hand pane of the device:

Alpha 5 Components.png

Note: If you click on any of the components or graphs, you may see the following error message in the UI:

Alpha 5 Error.png

The error message is OK, it just means the metric tag has not been created yet. The new back-end takes a JIT approach and will create new tags as they are added to the system vs. pre-populating the Hbase back-end with a bunch of KPI tags that may never be populated. If you wait a few minutes (polling cycle dependent - default is 5 minutes) you should start to see time series data being rendered in the new graphs, similar to the example below:

Alpha 5 Graph Tooltip.png

Exploring the New Back-end =

Here are some things you can explore related to the new performance data back-end that you may want to explore and test out.

CSV Output

Data be exported to CSV through each graph widget via the cog icon embedded in the title bar:

Alpha 5 CSV.png

JSON View

The underlying JSON data structure can also be viewed by clicking on "Definition":

Alpha 5 JSON.png

If you look carefully, you can see where the metric and tag data is stated. This information can be used directly for querying and graphing time series data directly in the TSD interface section below.

Time Series Data Interface

For those who are curious as to how we are leveraging TSD under the covers, you can take a look at the TSD UI via http://[ApplianceIP]:4242/ or telnet directly into TSD via telnet [ApplianceIP] 4242.

Alpha 5 TSD.png

The TSD UI has built-in auto-complete, so you can quickly find interesting metrics to graph against. Try a combination of uppercase and lowercase letters when searching for metrics.

Alpha 5 TSD Metrics 1.png

For tags, you can use wildcard expressions, thus any metric with one or more tags can be rendered on the same graph.

Alpha 5 TSD Metrics 2.png

You can even plot different metrics on the same graph across multiple targets. You can even plot different metrics on the same graph across multiple targets, by clicking on the "+" tab. In future, API documentation will be provided so you can build your own graphs and also be able to import/export data as needed.

Note: The current version of OpenTSDB has no authentication functionality, thus it will most likely only be able for debugging/development in the final release and the UI/API will . A REST API will be available which will require authentication before any query is executed.

Troubleshooting

If the web UI appears inaccessible after starting the appliance and navigating to the stated IP:port combination, verify the network configuration of your VM appliance.

If in doubt, set the network configuration to bridged mode (assuming you are on the same network as a DHCP server) and restart the appliance, or restart the network service within the appliance itself, run ifconfig and then try again.

Connection Problems

If you see any errors in the console around not unable to connect to 127.0.0.1:9001, please follow these steps. First, SSH into the appliance (user: root, password: zenoss). Then:


# rm $ZENHOME/var/supervisord.pid
# zenoss restart

Run netstat -ant | grep 8080 and see if there anything is listening on 8080, if there is you are gold. If there isn't then restart the appliance and try again.

Further Troubleshooting

If you are still having issues with the UI coming up or seeing connection refused error messages in the graphs, try the following steps. First, SSH into appliance (user: root, password: zenoss). Then:


# rm $ZENHOME/var/supervisord.pid
# zenoss shutdown
# service hbase restart
# service opentsdb restart
# su - zenoss
# zenoss start
# zsupervisor 
# stop all
# start all
# exit

Now, run netstat -ant | grep 8080 and see if there anything is listening on 8080, if there is you are gold. Else, try rebooting the appliance.

Bugs

We gladly accept bugs as a token of appreciation from our community. The filing process is the same as it is for available Core releases. The main difference is the affected version is code named ‘europa’.

If you don’t have a JIRA account already, please go ahead and create one, by navigating to jira.zenoss.com. Sign-up link: https://jira.zenoss.com/secure/Signup!default.jspa

Once you have created an account, the process is pretty straight-forward for filing a bug.

  1. Click on the Create Issue button on the top of the UI
  2. Fill out the following fields and attach any relevant screenshots/log files as required

Please use the defect priority guide below when filing bugs:

Priority Description
1 System crash, loss of data, loss of monitoring. This bug will take top priority with development and stop the release of the software until fixed.
2 A Feature is not functioning and no workaround exists. Next highest priority for development; will not hold up release.
3 A Feature is not functioning a workaround exists.
4 Lowest severity, minor issues, cosmetic issues.