diff --git a/doc/source/installationGuide.rst b/doc/source/installationGuide.rst index 9295a8a..47e06c7 100644 --- a/doc/source/installationGuide.rst +++ b/doc/source/installationGuide.rst @@ -30,12 +30,25 @@ Configure Dynatrace Plugin 3. Enable the plugin and fill the configuration fields with correct values of your Dynatrace environment (Settings > Other > Dynatrace). - - Dynatrace Environment ID: your Dynatrace environment ID - - Dynatrace Token: your Dynatrace environment token + - Environment ID: your Dynatrace environment ID + - Token: your Dynatrace environment token + - Managed IP/Domain: if you have a Dynatrace Managed node/cluster setup in + your environment, provide the IP address or the domain name -4. Add nodes and assign the *Dynatrace* role to all nodes. Sample node -configuration is provided below. [IMAGE] +4. Add nodes and assign the *Dynatrace OneAgent* 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. 5. Finish the configuration according to your requirements. -6. Press *Deploy changes* to deploy the environment. \ No newline at end of file +6. Press *Deploy changes* to deploy the environment. + +Validate Dynatrace Plugin +''''''''''''''''''''''''' +1. After a successful deployment, ssh to the controller nodes and make sure + that there is a *oneagentwatchdog* process running. +2. After a successful deployment, ssh to the node with the *Dynatrace Security* + *Gateway* role. Make sure that there is a *dyntracegateway* process running. +3. After a successful deployment, log in to your Dynatrace environment and make + sure that you find all nodes with the *Dynatrace OneAgent* role in the host + view and that you see, that one Security Gateway has been found in your environment. diff --git a/doc/source/limitations.rst b/doc/source/limitations.rst index 0bdc83f..68b8019 100644 --- a/doc/source/limitations.rst +++ b/doc/source/limitations.rst @@ -1,3 +1,3 @@ Limitations ----------- -None known. \ No newline at end of file +None. diff --git a/doc/source/overview.rst b/doc/source/overview.rst index fc159c9..bc48552 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -1,7 +1,30 @@ -Overview --------- -The Dynatrace Fuel plugin introduces a new node role called *Dynatrace*. -During the deployment the Dynatrace agent will be installed on all -*Dynatrace* nodes. In the settings you can specify the information that the -agent needs to work properly. After a successful deployment the Dynatrace -agent should be running on all *Dynatrace* hosts. \ No newline at end of file +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 +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. + +* 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 +*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. diff --git a/doc/source/prerequisites.rst b/doc/source/prerequisites.rst index ee6760a..3f8acc7 100644 --- a/doc/source/prerequisites.rst +++ b/doc/source/prerequisites.rst @@ -1,4 +1,6 @@ Prerequisites ------------- You need an active Dynatrace environment. For the configuration of the -plugin you need the environment ID and the token of your Dynatrace environment. \ No newline at end of file +plugin you need the environment ID, the token of your Dynatrace environment, +and, if you use Dynatrace Managed, the IP address of the Dynatrace Managed +server. diff --git a/doc/source/releaseNotes.rst b/doc/source/releaseNotes.rst index 6f4c090..1a203ce 100644 --- a/doc/source/releaseNotes.rst +++ b/doc/source/releaseNotes.rst @@ -1,4 +1,4 @@ Release Notes ------------- -- 1.0-1.0.0-1: first version of the plugin \ No newline at end of file +- 1.0-1.0.0-1: initial version of the plugin diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index f0fcec0..1b10ee8 100644 --- a/doc/source/requirements.rst +++ b/doc/source/requirements.rst @@ -2,4 +2,4 @@ Requirements ------------ The plugin has the following requirements for software and hardware. -- Fuel version: 9.0 \ No newline at end of file +- Fuel version: 9.[0,1]