x
/
fuel-plugin-dynatrace
Code Issues Proposed changes

updated plugin documentation, qa documentation, and test report

This commit is contained in:
dirkwall 2016-12-15 15:43:24 +01:00
parent 716cbe5e9c
commit b805ecff72
8 changed files with 94 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/qa-report/source/results.rst
View File

@ -2,13 +2,13 @@ Test results summary
====================
+-----------------------------------------+------+
|Total quantity of executed test cases | 5|
|Total quantity of executed test cases | 6|
+-----------------------------------------+------+
|Total quantity of not executed test cases| 0|
+-----------------------------------------+------+
|Quantity of automated test cases | 0|
+-----------------------------------------+------+
|Quantity of not automated test cases | 5|
|Quantity of not automated test cases | 6|
+-----------------------------------------+------+
Detailed test results
@ -27,7 +27,9 @@ Detailed test results
+-------+--------------------------------------------+------+------+-------+
|5 |uninstall_plugin |X | | |
+-------+--------------------------------------------+------+------+-------+
|Total |5 |0 |0 |
|6 |hot_pluggable_plugin |X | | |
+-------+--------------------------------------------+------+------+-------+
|Total |6 |0 |0 |
+-------+--------------------------------------------+------+------+-------+
|Total % |100% |  |  |
+-------+--------------------------------------------+------+------+-------+

28
doc/qa/source/overview.rst
View File

@ -1,24 +1,24 @@
Overview
========
The Dynatrace Fuel plugin introduces two new node roles called *Dynatrace
OneAgent* and *Dynatrace Security Gateway*. In order to work properly you need
an active Dynatrace account (free trial also works) and access to your SaaS
account or a Dynatrace Managed node/cluster on premise.
The Dynatrace Fuel plugin install the *Dynatrace OneAgent* on all controller
nodes and introduces a new node role called *Dynatrace Security
Gateway*. In order to work properly you need an active Dynatrace account (free
trial also works) and access to your SaaS account or a Dynatrace Managed
node/cluster on premise.
* Dynatrace OneAgent
The *Dynatrace OneAgent* role must be applied to all nodes
in your environment that have the Controller role. The OneAgent instruments the
OpenStack services and also the supporting services like MySQL, RabbitMQ,
Memcached, HAproxy, ... and sends all monitoring and log data to the node with
The *Dynatrace OneAgent* is automatically installed on all controller nodes,
as soon as the plugin is activated. The OneAgent instruments the OpenStack
services and also the supporting services like MySQL, RabbitMQ, Memcached,
HAproxy, ... and sends all monitoring and log data to the node with
*Dynatrace Security Gateway* role.
* Dynatrace Security Gateway
The *Dynatrace Security Gateway* role must be
applied to a standalone physical machine, where no other OpenStack service is
running. If you plan to use Dynatrace for monitoring your applications that run
on top of OpenStack as well, you need to make sure that the VMs where the
Dynatrace OneAgent is installed have network access to the *Dynatrace Security
Gateway* node.
The *Dynatrace Security Gateway* role must be applied to a standalone physical
machine, where no other OpenStack service is running. If you plan to use
Dynatrace for monitoring your applications that run on top of OpenStack as
well, you need to make sure that the VMs where the Dynatrace OneAgent is
installed have network access to the *Dynatrace Security Gateway* node.
Developer's specification
-------------------------

55
doc/qa/source/systemtesting.rst
View File

@ -15,9 +15,9 @@ Steps 1. Install plugin using Fuel CLI, refer to the `Installation
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Add 3 controller nodes and apply the Controller role to
all 3, 1 compute node, and 1 Dynatrace Security Gateway
node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
@ -43,7 +43,7 @@ Steps 1. Install plugin using Fuel CLI, refer to the `Installation
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
#. Add 3 controller nodes and apply the Controller
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
@ -79,7 +79,7 @@ Steps 1. Install plugin using Fuel CLI, refer to the `Installation
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
#. Add 3 controller nodes and apply the Controller
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
@ -115,7 +115,7 @@ Steps 1. Install plugin using Fuel CLI, refer to the `Installation
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
#. Add 3 controller nodes and apply the Controller
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
@ -149,7 +149,7 @@ Steps 1. Install plugin using Fuel CLI, refer to the `Installation
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
#. Add 3 controller nodes and apply the Controller
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
@ -165,7 +165,46 @@ Expected Result Plugin is installed successfully. The cluster is created and
default state, no output for command "fuel plugins --list").
=============== =====
**Verify hot-pluggable functionality of the plugin**
=============== =====
Test Case ID hot_pluggable_plugin
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with disabled plugin in Fuel Web UI
#. Add 1 controller node and apply the Controller
role and 1 compute node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
#. Run health check
#. Verify that no Dynatrace processes are running on either
the controller node, nor the compute node
#. Enable the plugin and fill out mandatory fields
#. Add 2 controller nodes and 1 Dynatrace Security Gateway
node
#. Run network verification
#. Redeploy the cluster
#. Verify there were no error messages during the deployment
#. Run health check
#. Verify that Dynatrace OneAgent is running on all
controller nodes
--------------- -----
Expected Result Plugin is installed successfully. When the plugin is disabled
no Dynatrace component is installed. It's possible to
redeploy the cluster with the plugin activated. Then the
Dynatrace OneAgent is installed on the controller nodes, the
Dynatrace Security Gateway is setup successfully. All OSTF
tests pass. Environment is deployed successfully. The
environment is redeployed successfully when adding nodes.
=============== =====

BIN
doc/user/source/images/k9ma8.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 138 KiB

BIN
doc/user/source/images/uh37r.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 109 KiB

2
doc/user/source/installationGuide.rst
View File

@ -39,7 +39,7 @@ of your Dynatrace environment (Settings > Other > Dynatrace).
.. image:: images/9yl01.png
4. Add nodes and assign the *Dynatrace OneAgent* role to all controller nodes.
4. Add nodes and assign the Controller role to all controller nodes.
Assign the *Dynatrace Security Gateway* role to a node and don't assign any
other roles to that node. Sample node configuration is provided below.

12
doc/user/source/limitations.rst
View File

@ -1,3 +1,13 @@
Limitations
-----------
None.
The node with the *Dynatrace Security Gateway* role needs to have network
access to either the Dynatrace Managed cluster or the Dynatrace SaaS
endpoint. Furthermore, if you want to monitor your applications that run on
top of OpenStack as well, you need to install the *Dynatrace OneAgent* in
your workloads and you need to make sure, that the *Dynatrace OneAgent* has
network access to the node with the *Dynatrace Security Gateway* role.
Find more information about the necessary configuration steps here:
`Dynatrace Security Gateway Help <https://help.dynatrace.com/get-started/install/how-do-i-install-dynatrace-security-gateway//>`_

32
doc/user/source/overview.rst
View File

@ -1,30 +1,30 @@
Overview
--------
Dynatrace is the innovator behind the industry’s premier
Digital Performance Platform. Gartner had recognized Dynatrace as APM leader now
for 6 consecutive years. More than 8,000 customers trust Dynatrace. Our
Digital Performance Platform. Gartner had recognized Dynatrace as APM leader
now for 6 consecutive years. More than 8,000 customers trust Dynatrace. Our
experience and knowledge has been bundled to develop a new generation of
monitoring software. Dynatrace digital performance monitoring covers web scale
application environments down to each individual transaction – with no gaps
or blind spots – including front end, application performance, infrastructure,
containers, and cloud platforms, like OpenStack.
The Dynatrace Fuel plugin introduces two new node roles called *Dynatrace
OneAgent* and *Dynatrace Security Gateway*. In order to work properly you need
an active Dynatrace account (free trial also works) and access to your SaaS
account or a Dynatrace Managed node/cluster on premise.
The Dynatrace Fuel plugin install the *Dynatrace OneAgent* on all controller
nodes and introduces a new node role called *Dynatrace Security
Gateway*. In order to work properly you need an active Dynatrace account (free
trial also works) and access to your SaaS account or a Dynatrace Managed
node/cluster on premise.
* Dynatrace OneAgent
The *Dynatrace OneAgent* role must be applied to all nodes
in your environment that have the Controller role. The OneAgent instruments the
OpenStack services and also the supporting services like MySQL, RabbitMQ,
Memcached, HAproxy, ... and sends all monitoring and log data to the node with
The *Dynatrace OneAgent* is automatically installed on all controller nodes,
as soon as the plugin is activated. The OneAgent instruments the OpenStack
services and also the supporting services like MySQL, RabbitMQ, Memcached,
HAproxy, ... and sends all monitoring and log data to the node with
*Dynatrace Security Gateway* role.
* Dynatrace Security Gateway
The *Dynatrace Security Gateway* role must be
applied to a standalone physical machine, where no other OpenStack service is
running. If you plan to use Dynatrace for monitoring your applications that run
on top of OpenStack as well, you need to make sure that the VMs where the
Dynatrace OneAgent is installed have network access to the *Dynatrace Security
Gateway* node.
The *Dynatrace Security Gateway* role must be applied to a standalone physical
machine, where no other OpenStack service is running. If you plan to use
Dynatrace for monitoring your applications that run on top of OpenStack as
well, you need to make sure that the VMs where the Dynatrace OneAgent is
installed have network access to the *Dynatrace Security Gateway* node.