Retire repository
Fuel repositories are all retired in openstack namespace, retire remaining fuel repos in x namespace since they are unused now. This change removes all content from the repository and adds the usual README file to point out that the repository is retired following the process from https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project See also http://lists.openstack.org/pipermail/openstack-discuss/2019-December/011675.html A related change is: https://review.opendev.org/699752 . Change-Id: I751152c1c1f32d6048708186ab5e63e530468157
This commit is contained in:
Andreas Jaeger
parent
a4f51d34ca
commit
fc7b433429
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,5 +0,0 @@
|
||||
.DS_Store
|
||||
.build
|
||||
repositories/centos/*
|
||||
repositories/ubuntu/*
|
||||
*.rpm
|
||||
202
LICENSE
202
LICENSE
@ -1,202 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
24
README.md
24
README.md
@ -1,24 +0,0 @@
|
||||
Dynatrace plugin for Fuel
|
||||
============
|
||||
|
||||
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* 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.
|
||||
10
README.rst
Normal file
10
README.rst
Normal file
@ -0,0 +1,10 @@
|
||||
This project is no longer maintained.
|
||||
|
||||
The contents of this repository are still available in the Git
|
||||
source code management system. To see the contents of this
|
||||
repository before it reached its end of life, please check out the
|
||||
previous commit with "git checkout HEAD^1".
|
||||
|
||||
For any further questions, please email
|
||||
openstack-discuss@lists.openstack.org or join #openstack-dev on
|
||||
Freenode.
|
||||
@ -1,12 +0,0 @@
|
||||
# This file contains wizard components descriptions that are pretty similar to
|
||||
# the `environment_config.yaml`.
|
||||
# Please, take a look at following link for the details:
|
||||
# - https://blueprints.launchpad.net/fuel/+spec/component-registry
|
||||
# - https://specs.openstack.org/openstack/fuel-specs/specs/8.0/component-registry.html
|
||||
|
||||
- name: additional_service:dynatrace
|
||||
label: "Install Dynatrace"
|
||||
description: "Installs Dynatrace in your OpenStack cluster"
|
||||
compatible: []
|
||||
requires: []
|
||||
incompatible: []
|
||||
@ -1,4 +0,0 @@
|
||||
notice('MODULAR: dynatrace/dynatrace-oneagent.pp')
|
||||
|
||||
include dynatrace
|
||||
class { 'dynatrace::oneagent': }
|
||||
@ -1,4 +0,0 @@
|
||||
notice('MODULAR: dynatrace/dynatrace-security-gateway.pp')
|
||||
|
||||
include dynatrace
|
||||
class { 'dynatrace::security_gateway': }
|
||||
@ -1,8 +0,0 @@
|
||||
class dynatrace {
|
||||
$dynatrace = hiera('dynatrace')
|
||||
|
||||
$tenant = $dynatrace['dynatrace_tenant']
|
||||
$token = $dynatrace['dynatrace_token']
|
||||
$managed = $dynatrace['dynatrace_managed']
|
||||
$server = $dynatrace['dynatrace_server']
|
||||
}
|
||||
@ -1,24 +0,0 @@
|
||||
class dynatrace::oneagent {
|
||||
$file = "/tmp/Dynatrace-OneAgent.sh"
|
||||
|
||||
if ($dynatrace::managed) {
|
||||
$url = "https://${dynatrace::server}/e/${dynatrace::tenant}/installer/agent/unix/latest/${dynatrace::token}/${dynatrace::tenant}"
|
||||
}
|
||||
else {
|
||||
$url = "https://${dynatrace::tenant}.live.dynatrace.com/installer/agent/unix/latest/${dynatrace::token}"
|
||||
}
|
||||
|
||||
file { '/etc/hiera/plugins/dynatrace.yaml':
|
||||
ensure => file,
|
||||
} ->
|
||||
|
||||
download {'Download Dynatrace OneAgent':
|
||||
uri => $url,
|
||||
dest => $file
|
||||
} ->
|
||||
|
||||
exec { 'install_oneagent':
|
||||
command => "/bin/sh ${file} APP_LOG_CONTENT_ACCESS=1",
|
||||
path => $::path
|
||||
}
|
||||
}
|
||||
@ -1,24 +0,0 @@
|
||||
class dynatrace::security_gateway {
|
||||
$file = "/tmp/Dynatrace-Security-Gateway.sh"
|
||||
|
||||
if ($dynatrace::managed) {
|
||||
$url = "https://${dynatrace::server}/e/${dynatrace::tenant}/installer/sg/unix/latest/${dynatrace::token}/${dynatrace::tenant}"
|
||||
}
|
||||
else {
|
||||
$url = "https://${dynatrace::tenant}.live.dynatrace.com/installer/sg/unix/latest/${dynatrace::token}"
|
||||
}
|
||||
|
||||
file { '/etc/hiera/plugins/dynatrace.yaml':
|
||||
ensure => file,
|
||||
} ->
|
||||
|
||||
download {'Download Dynatrace Security Gateway':
|
||||
uri => $url,
|
||||
dest => $file
|
||||
} ->
|
||||
|
||||
exec { 'install_security_gateway':
|
||||
command => "/bin/sh ${file}",
|
||||
path => $::path
|
||||
}
|
||||
}
|
||||
@ -1,18 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<projectDescription>
|
||||
<name>http_download</name>
|
||||
<comment></comment>
|
||||
<projects>
|
||||
</projects>
|
||||
<buildSpec>
|
||||
<buildCommand>
|
||||
<name>org.eclipse.xtext.ui.shared.xtextBuilder</name>
|
||||
<arguments>
|
||||
</arguments>
|
||||
</buildCommand>
|
||||
</buildSpec>
|
||||
<natures>
|
||||
<nature>com.puppetlabs.geppetto.pp.dsl.ui.puppetNature</nature>
|
||||
<nature>org.eclipse.xtext.ui.shared.xtextNature</nature>
|
||||
</natures>
|
||||
</projectDescription>
|
||||
@ -1,62 +0,0 @@
|
||||
# http_download
|
||||
|
||||
## Overview
|
||||
|
||||
This module contains a puppet type that allows http downloads directly via ruby. No additional executables are needed.
|
||||
It supports SSL and Basic authentication.
|
||||
|
||||
## Class: http_download
|
||||
|
||||
The class of that module just acts as test and example showing how to use the type.
|
||||
|
||||
### Sample Usage
|
||||
|
||||
```puppet
|
||||
download {'test file 1':
|
||||
uri => 'http://downloads.sourceforge.net/project/sevenzip/7-Zip/9.22/7z922.exe',
|
||||
dest => '/tmp/7z922.exe'
|
||||
}
|
||||
|
||||
download { 'my ssl and basic auth download':
|
||||
uri => 'https://www.example.com/download/example.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
user => 'user',
|
||||
pass => 'pass'
|
||||
}
|
||||
|
||||
download {'download if not exists':
|
||||
uri => 'http://downloads.sourceforge.net/project/sevenzip/7-Zip/9.22/7z922.exe',
|
||||
force => false,
|
||||
dest => '/tmp/7z922.exe'
|
||||
}
|
||||
|
||||
download { 'download with basic auth and ssl, ssl forced':
|
||||
uri => 'http://host.com:8443/test.txt',
|
||||
use_ssl => true,
|
||||
dest => '/tmp/example.txt',
|
||||
user => 'user',
|
||||
pass => 'pass'
|
||||
}
|
||||
|
||||
download { 'download with proxy settings without auth':
|
||||
uri => 'http://host.com:8443/test.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
proxy_host => '127.0.0.1',
|
||||
proxy_port => '3128'
|
||||
}
|
||||
|
||||
download { 'download with proxy setting with auth':
|
||||
uri => 'http://host.com:8443/test.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
proxy_host => '127.0.0.1',
|
||||
proxy_port => '3128',
|
||||
proxy_user => 'my-proxy-user',
|
||||
proxy_pass => 'my-proxy-pass'
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Supported OSes
|
||||
|
||||
As it's written in plain ruby all OS that can run Puppet should be able to use it.
|
||||
I have tested it on different Windows versions and various Linux distributions (CentOS, Ubuntu, AmazonLinux) without issues.
|
||||
@ -1,2 +0,0 @@
|
||||
require 'rubygems'
|
||||
require 'puppetlabs_spec_helper/rake_tasks'
|
||||
@ -1,103 +0,0 @@
|
||||
# This type allows dowloads of files via plain ruby
|
||||
#
|
||||
require 'puppet'
|
||||
require 'net/http'
|
||||
require 'uri'
|
||||
|
||||
Puppet::Type.type(:download).provide(:ruby) do
|
||||
def fetch(uri_str, limit = 10)
|
||||
raise ArgumentError, 'Too many HTTP redirects' if limit == 0
|
||||
uri = URI(uri_str)
|
||||
|
||||
|
||||
if resource[:proxy_host] and resource[:proxy_port]
|
||||
if resource[:proxy_user] and resource[:proxy_pass]
|
||||
http = Net::HTTP.new(uri.host, uri.port, resource[:proxy_host], resource[:proxy_port], resource[:proxy_user], resource[:proxy_pass])
|
||||
else
|
||||
http = Net::HTTP.new(uri.host, uri.port, resource[:proxy_host], resource[:proxy_port])
|
||||
end
|
||||
else
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
end
|
||||
|
||||
begin
|
||||
if resource[:use_ssl] or uri_str.start_with? 'https'
|
||||
http.use_ssl = true
|
||||
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
|
||||
end
|
||||
request = Net::HTTP::Get.new uri.request_uri
|
||||
if nil != resource[:user] and nil != resource[:pass]
|
||||
request.basic_auth(resource[:user], resource[:pass])
|
||||
end
|
||||
http.request request do |response|
|
||||
case response
|
||||
when Net::HTTPRedirection then
|
||||
location = response['location']
|
||||
Puppet.notice("redirected to #{location}")
|
||||
fetch(location, limit - 1)
|
||||
when Net::HTTPForbidden then
|
||||
raise SecurityError, 'Access denied'
|
||||
when Net::HTTPNotFound then
|
||||
raise ArgumentError, 'Not found'
|
||||
when Net::HTTPSuccess then
|
||||
open resource[:dest], 'wb' do |io|
|
||||
response.read_body do |chunk|
|
||||
io.write chunk
|
||||
end
|
||||
end
|
||||
else
|
||||
raise "Unexpected state => #{response.code} - #{response.message}"
|
||||
end
|
||||
end
|
||||
rescue Net::HTTPError => e
|
||||
if nil != http and http.started?
|
||||
http.finish()
|
||||
end
|
||||
raise e
|
||||
end
|
||||
end
|
||||
|
||||
def download
|
||||
success = false
|
||||
for retries in 1..3
|
||||
begin
|
||||
fetch(resource[:uri])
|
||||
success = true
|
||||
break
|
||||
rescue SecurityError => s
|
||||
Puppet.crit("SecurityError -> \n#{s.inspect}")
|
||||
break
|
||||
rescue ArgumentError => a
|
||||
Puppet.crit("ArgumentError -> \n#{a.inspect}")
|
||||
break
|
||||
rescue IOError => eio
|
||||
Puppet.crit("IO Exception during http download -> \n#{eio.inspect}")
|
||||
rescue Net::HTTPError => ehttp
|
||||
Puppet.crit("HTTP Exception during http download -> \n#{ehttp.inspect}")
|
||||
rescue StandardError => e
|
||||
Puppet.crit("Exception during http download -> \n#{e.inspect}")
|
||||
end
|
||||
sleep(5)
|
||||
end
|
||||
return success
|
||||
end
|
||||
|
||||
def exists?
|
||||
(File.file?(resource[:dest]) and !resource[:force])
|
||||
end
|
||||
|
||||
def destroy
|
||||
if File.file?(resource[:dest])
|
||||
File.delete(resource[:dest])
|
||||
end
|
||||
true
|
||||
end
|
||||
|
||||
def create
|
||||
succ = download()
|
||||
if !succ
|
||||
Puppet.crit("HTTP download of '#{resource[:uri]}' failed!")
|
||||
end
|
||||
succ
|
||||
end
|
||||
end
|
||||
@ -1,107 +0,0 @@
|
||||
# This type holds the code to upload the user attributes
|
||||
#
|
||||
#
|
||||
require 'puppet'
|
||||
require 'puppet/parameter/boolean'
|
||||
|
||||
Puppet::Type.newtype(:download) do
|
||||
desc <<-EOS
|
||||
This type allows to do downloads via ruby without the need for any localy provided executable.
|
||||
|
||||
Example usage:
|
||||
|
||||
Download a file:
|
||||
|
||||
download { 'my download':
|
||||
uri => 'http://www.example.com/download/example.txt',
|
||||
dest => '/tmp/example.txt'
|
||||
}
|
||||
|
||||
Download file only if no local file exists:
|
||||
|
||||
download { 'my download':
|
||||
uri => 'http://www.example.com/download/example.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
force => false
|
||||
}
|
||||
|
||||
Download file using basic authentication:
|
||||
|
||||
download { 'my ssl and basic auth download':
|
||||
uri => 'https://www.example.com/download/example.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
user => 'user',
|
||||
pass => 'pass'
|
||||
}
|
||||
|
||||
Download file using proxy settings:
|
||||
|
||||
download { 'my download behind a proxy':
|
||||
uri => 'https://www.example.com/download/example.txt',
|
||||
dest => '/tmp/example.txt',
|
||||
proxy_host => '127.0.0.1',
|
||||
proxy_port => '3128',
|
||||
proxy_user => 'user', # optionnal: only if proxy need authentication
|
||||
proxy_pass => 'pass' # optionnal: only if proxy need authentication
|
||||
}
|
||||
EOS
|
||||
|
||||
ensurable do
|
||||
defaultvalues
|
||||
defaultto :present
|
||||
end
|
||||
|
||||
newparam(:name, :namevar => true) do
|
||||
desc "The name for the download."
|
||||
end
|
||||
|
||||
newparam(:uri) do
|
||||
desc "The uri of the file to download."
|
||||
end
|
||||
|
||||
newparam(:dest) do
|
||||
desc "The destination file. Make sure the path to this file exists!"
|
||||
end
|
||||
|
||||
newparam(:force, :boolean => true, :parent => Puppet::Parameter::Boolean) do
|
||||
desc <<-EOS
|
||||
Per default a file download will be forced as there is no good way to check if the local file
|
||||
matches the download. If you only want to ensure that a file with that name exists locally you
|
||||
can set this to false.
|
||||
EOS
|
||||
defaultto :true
|
||||
newvalues(:true, :false)
|
||||
end
|
||||
|
||||
newparam(:use_ssl, :boolean => true, :parent => Puppet::Parameter::Boolean) do
|
||||
desc "Use SSL for the transfer? If the URL starts with https this is set automatically."
|
||||
defaultto :false
|
||||
newvalues(:true, :false)
|
||||
end
|
||||
|
||||
newparam(:user) do
|
||||
desc "A user to use for basic authentication."
|
||||
end
|
||||
|
||||
newparam(:pass) do
|
||||
desc "A pass to use for basic authentication."
|
||||
end
|
||||
|
||||
newparam(:proxy_host) do
|
||||
desc "The proxy hostname. Make sure the host exists!"
|
||||
end
|
||||
|
||||
newparam(:proxy_port) do
|
||||
desc "The proxy port. Make sure the port is open!"
|
||||
end
|
||||
|
||||
|
||||
newparam(:proxy_user) do
|
||||
desc "The proxy username. This is an optional parameter"
|
||||
end
|
||||
|
||||
newparam(:proxy_pass) do
|
||||
desc "The proxy password. This is an optional parameter"
|
||||
end
|
||||
|
||||
end
|
||||
@ -1,33 +0,0 @@
|
||||
# Class: http_download
|
||||
#
|
||||
class http_download {
|
||||
# this is just a test for the module
|
||||
if $::kernel == 'linux' {
|
||||
$target = '/tmp/'
|
||||
} else {
|
||||
$target = 'C:/'
|
||||
}
|
||||
|
||||
download { 'test file basic':
|
||||
uri => 'http://www.7-zip.org/a/7z920-x64.msi',
|
||||
dest => "${target}7z920-x64.msi",
|
||||
}
|
||||
|
||||
download { 'test https and large file':
|
||||
uri => 'https://downloads.mariadb.org/f/mariadb-10.1.10/source/mariadb-10.1.10.tar.gz?serve',
|
||||
dest => "${target}mariadb-10.1.10.tar.gz",
|
||||
}
|
||||
|
||||
download { 'test force false':
|
||||
uri => 'https://downloads.mariadb.org/f/mariadb-10.1.10/source/mariadb-10.1.10.tar.gz?serve',
|
||||
dest => "${target}mariadb-10.1.10.tar.gz",
|
||||
force => false
|
||||
}
|
||||
|
||||
download { 'test basic auth':
|
||||
uri => 'http://brunmayr.org/test/README.md',
|
||||
dest => "${target}README.md",
|
||||
user => 'test',
|
||||
pass => 'Basic_Auth1'
|
||||
}
|
||||
}
|
||||
@ -1,24 +0,0 @@
|
||||
{
|
||||
"author": "Sledge Sulaweyo",
|
||||
"dependencies": [],
|
||||
"license": "Apache-2.0",
|
||||
"name": "sledge-http_download",
|
||||
"operatingsystem_support": [{
|
||||
"operatingsystem": "Windows"
|
||||
},{
|
||||
"operatingsystem": "RedHat"
|
||||
},{
|
||||
"operatingsystem": "Ubuntu"
|
||||
},{
|
||||
"operatingsystem": "Debian"
|
||||
},{
|
||||
"operatingsystem": "CentOS"
|
||||
}
|
||||
],
|
||||
"project_page": "https://github.com/sulaweyo/http_download",
|
||||
"requirements": [],
|
||||
"source": "https://github.com/sulaweyo/http_download",
|
||||
"summary": "Contains a type that allows simple http downloads via ruby.",
|
||||
"tags": [],
|
||||
"version": "0.1.7"
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
--format
|
||||
s
|
||||
--colour
|
||||
--loadby
|
||||
mtime
|
||||
--backtrace
|
||||
@ -1,2 +0,0 @@
|
||||
require 'rubygems'
|
||||
require 'puppetlabs_spec_helper/module_spec_helper'
|
||||
@ -1 +0,0 @@
|
||||
include http_download
|
||||
@ -1,45 +0,0 @@
|
||||
- id: dynatrace-oneagent
|
||||
role: [primary-controller, controller]
|
||||
type: puppet
|
||||
version: 2.1.0
|
||||
required_for: [post_deployment_end]
|
||||
requires: [hiera, globals]
|
||||
parameters:
|
||||
puppet_manifest: puppet/manifests/dynatrace-oneagent.pp
|
||||
puppet_modules: puppet/modules:/etc/puppet/modules
|
||||
timeout: 360
|
||||
reexecute_on:
|
||||
- deploy_changes
|
||||
|
||||
- id: dynatrace-sg-base
|
||||
type: group
|
||||
role: [dynatrace-security-gateway]
|
||||
required_for: [dynatrace-security-gateway]
|
||||
tasks:
|
||||
- fuel_pkgs
|
||||
- hiera
|
||||
- globals
|
||||
- tools
|
||||
- logging
|
||||
- netconfig
|
||||
- connectivity_tests
|
||||
- hosts
|
||||
parameters:
|
||||
strategy:
|
||||
type: one_by_one
|
||||
reexecute_on:
|
||||
- deploy_changes
|
||||
|
||||
- id: dynatrace-security-gateway
|
||||
role: [dynatrace-security-gateway]
|
||||
type: puppet
|
||||
groups: [dynatrace-sg-base]
|
||||
version: 2.1.0
|
||||
required_for: [post_deployment_end]
|
||||
requires: [hiera, globals]
|
||||
parameters:
|
||||
puppet_manifest: puppet/manifests/dynatrace-security-gateway.pp
|
||||
puppet_modules: puppet/modules:/etc/puppet/modules
|
||||
timeout: 360
|
||||
reexecute_on:
|
||||
- deploy_changes
|
||||
2
doc/.gitignore
vendored
2
doc/.gitignore
vendored
@ -1,2 +0,0 @@
|
||||
build/
|
||||
.idea/
|
||||
@ -1,197 +0,0 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# SVG to PDF conversion
|
||||
SVG2PDF = inkscape
|
||||
SVG2PDF_FLAGS =
|
||||
# Build a list of SVG files to convert to PDF
|
||||
PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhc"
|
||||
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
@ -1,341 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# plugin name documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
# 'sphinx.ext.todo',
|
||||
# 'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Dynatrace plugin for Fuel'
|
||||
copyright = u'2016, Dynatrace LLC'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.0-1.0.0-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Dynatrace-doc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'fuel-plugin-dynatrace-qa-report.tex', u'Dynatrace plugin for Fuel Test Report',
|
||||
u'Dynatrace LLC.', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
# make latex stop printing blank pages between sections
|
||||
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
|
||||
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'fuel-plugin-openbook', u'Guide to the Openbook Plugin ver. 1.1-1.1.0-1 for Fuel',
|
||||
[u'Talligent Inc.'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'Dynatrace', u'Dynatrace Plugin for Fuel Test Report',
|
||||
u'Dynatrace LLC.', 'Dynatrace', 'Dynatrace Plugin for Fuel Test Report',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
# Insert footnotes where they are defined instead of
|
||||
# at the end.
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
#epub_title = u'The Openbook Plugin for Fuel'
|
||||
#epub_author = u'Talligent Inc.'
|
||||
#epub_publisher = u'Talligent Inc.'
|
||||
#epub_copyright = u'2015, Talligent Inc.'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = u'fuel-plugin-openbook'
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not optimized
|
||||
# for small screen space, using the same theme for HTML and epub output is
|
||||
# usually not wise. This defaults to 'epub', a theme designed to save visual
|
||||
# space.
|
||||
#epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the PIL.
|
||||
#epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#epub_use_index = True
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
.. _fuel-plugin-dynatrace:
|
||||
|
||||
Test Report to the Dynatrace plugin version 1.0-1.0.0-1 for Fuel 9.0
|
||||
==============================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
|
||||
overview
|
||||
results
|
||||
@ -1,12 +0,0 @@
|
||||
Document purpose
|
||||
================
|
||||
|
||||
This document provides test results for system tests of Dynatrace Fuel Plugin 1.0.0 on Mirantis Fuel 9.0/9.1.
|
||||
|
||||
Test environment
|
||||
================
|
||||
A six node cluster made up of Dell Optiplex 7040 (4 cores, 16 GB memory, 256 GB storage) was used for conducting the tests. Two networks were used during the tests.
|
||||
|
||||
- mgmt-pxe, used for: Admin(PXE) (untagged)
|
||||
- trunk, used for: Management (VLAN101), Storage (VLAN102), Public (VLAN103), Private (VLAN104-110)
|
||||
|
||||
@ -1,39 +0,0 @@
|
||||
Test results summary
|
||||
====================
|
||||
|
||||
+-----------------------------------------+------+
|
||||
|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 | 6|
|
||||
+-----------------------------------------+------+
|
||||
|
||||
Detailed test results
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|# |Test case ID |Passed|Failed|Skipped|
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|1 |install_plugin_deploy_env |X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|2 |modify_env_with_plugin_remove_add_compute |X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|3 |modify_env_with_plugin_remove_add_controller|X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|4 |uninstall_plugin_with_deployed_env |X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|5 |uninstall_plugin |X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|6 |hot_pluggable_plugin |X | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|Total |6 |0 |0 |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|Total % |100% | | |
|
||||
+-------+--------------------------------------------+------+------+-------+
|
||||
|
||||
Known issues
|
||||
------------
|
||||
None.
|
||||
197
doc/qa/Makefile
197
doc/qa/Makefile
@ -1,197 +0,0 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# SVG to PDF conversion
|
||||
SVG2PDF = inkscape
|
||||
SVG2PDF_FLAGS =
|
||||
# Build a list of SVG files to convert to PDF
|
||||
PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhc"
|
||||
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
@ -1,4 +0,0 @@
|
||||
Appendix
|
||||
========
|
||||
|
||||
Provide any links to external resources or documentation here.
|
||||
@ -1,341 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# plugin name documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
# 'sphinx.ext.todo',
|
||||
# 'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Dynatrace plugin for Fuel'
|
||||
copyright = u'2016, Dynatrace LLC'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.0-1.0.0-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Dynatrace-doc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'fuel-plugin-dynatrace-qa.tex', u'Dynatrace plugin for Fuel Test Plan',
|
||||
u'Dynatrace LLC.', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
# make latex stop printing blank pages between sections
|
||||
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
|
||||
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'fuel-plugin-openbook', u'Guide to the Openbook Plugin ver. 1.1-1.1.0-1 for Fuel',
|
||||
[u'Talligent Inc.'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'Dynatrace', u'Dynatrace Plugin for Fuel Test Plan',
|
||||
u'Dynatrace LLC.', 'Dynatrace', 'Dynatrace Plugin for Fuel Test Plan',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
# Insert footnotes where they are defined instead of
|
||||
# at the end.
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
#epub_title = u'The Openbook Plugin for Fuel'
|
||||
#epub_author = u'Talligent Inc.'
|
||||
#epub_publisher = u'Talligent Inc.'
|
||||
#epub_copyright = u'2015, Talligent Inc.'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = u'fuel-plugin-openbook'
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not optimized
|
||||
# for small screen space, using the same theme for HTML and epub output is
|
||||
# usually not wise. This defaults to 'epub', a theme designed to save visual
|
||||
# space.
|
||||
#epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the PIL.
|
||||
#epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#epub_use_index = True
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
.. _fuel-plugin-dynatrace:
|
||||
|
||||
Test Plan to the Dynatrace plugin version 1.0-1.0.0-1 for Fuel 9.0
|
||||
==============================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
|
||||
overview
|
||||
teststrategy
|
||||
systemtesting
|
||||
appendix
|
||||
@ -1,29 +0,0 @@
|
||||
Overview
|
||||
========
|
||||
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* 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.
|
||||
|
||||
Developer's specification
|
||||
-------------------------
|
||||
https://github.com/Dynatrace/fuel-plugin-dynatrace/blob/master/specs/spec.rst
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
Dynatrace Fuel plugin version 1.0.0 has been developed for Fuel 9.0/9.1.
|
||||
@ -1,207 +0,0 @@
|
||||
System Test Scenarios
|
||||
=====================
|
||||
|
||||
Install plugin and deploy environment
|
||||
-------------------------------------
|
||||
|
||||
**Test Case ID**
|
||||
|
||||
- install_plugin_deploy_env
|
||||
|
||||
**Steps**
|
||||
|
||||
1. Install plugin using Fuel CLI, refer to the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Create environment with enabled plugin in Fuel Web UI
|
||||
#. 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
|
||||
#. Run health check
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. Plugin is installed successfully.
|
||||
#. Dynatrace OneAgent is installed on the controller nodes.
|
||||
#. Dynatrace Security Gateway is setup successfully.
|
||||
#. All OSTF tests pass.
|
||||
#. Environment is deployed successfully.
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\newpage
|
||||
|
||||
Modifying environment with enabled plugin (remove/add controller nodes)
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
**Test Case ID**
|
||||
|
||||
- modify_env_with_plugin_remove_add_controller
|
||||
|
||||
**Steps**
|
||||
|
||||
1. Install plugin using Fuel CLI, refer to the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Create environment with enabled plugin in Fuel Web UI
|
||||
#. 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
|
||||
#. Run OpenStack health check
|
||||
#. Remove 1 controller node
|
||||
#. Redeploy the cluster
|
||||
#. Run health check
|
||||
#. Add 1 new controller node
|
||||
#. Redeploy the cluster
|
||||
#. Run health check
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. Plugin is installed successfully.
|
||||
#. Dynatrace OneAgent is installed on the controller nodes.
|
||||
#. Dynatrace Security Gateway is setup successfully.
|
||||
#. All OSTF tests pass.
|
||||
#. Environment is deployed successfully.
|
||||
#. The environment is redeployed successfully when adding/removing a controller node.
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\newpage
|
||||
|
||||
Modifying environment with enabled plugin (remove/add compute nodes)
|
||||
--------------------------------------------------------------------
|
||||
|
||||
**Test Case ID**
|
||||
|
||||
- modify_env_with_plugin_remove_add_compute
|
||||
|
||||
**Steps**
|
||||
|
||||
1. Install plugin using Fuel CLI, refer to the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Create environment with enabled plugin in Fuel Web UI
|
||||
#. 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
|
||||
#. Run health check
|
||||
#. Add 1 compute node
|
||||
#. Redeploy the cluster
|
||||
#. Run health check
|
||||
#. Remove 1 compute node
|
||||
#. Redeploy the cluster
|
||||
#. Run health check
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. Plugin is installed successfully.
|
||||
#. Dynatrace OneAgent is installed on the controller nodes.
|
||||
#. Dynatrace Security Gateway is setup successfully.
|
||||
#. All OSTF tests pass.
|
||||
#. Environment is deployed successfully.
|
||||
#. The environment is redeployed successfully when adding/removing a compute node.
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\newpage
|
||||
|
||||
Uninstall of plugin in the deployed environment
|
||||
-----------------------------------------------
|
||||
|
||||
**Test Case ID**
|
||||
|
||||
- uninstall_plugin_with_deployed_env
|
||||
|
||||
**Steps**
|
||||
|
||||
1. Install plugin using Fuel CLI, refer to the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Create environment with enabled plugin in Fuel Web UI
|
||||
#. 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
|
||||
#. Run health check
|
||||
#. Uninstall the plugin with running ``fuel plugins --remove <plugin-name>==<plugin_version>``
|
||||
#. Ensure that the following output appears in CLI: *"400 Client Error: Bad Request (Can't delete plugin which is enabled for some environment.)"*
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. Plugin is installed successfully.
|
||||
#. Dynatrace OneAgent is installed on the controller nodes.
|
||||
#. Dynatrace Security Gateway is setup successfully.
|
||||
#. All OSTF tests pass.
|
||||
#. Environment is deployed successfully.
|
||||
#. An alert is displayed when trying to uninstall the plugin.
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\newpage
|
||||
|
||||
Uninstall of plugin in the non-deployed environment
|
||||
---------------------------------------------------
|
||||
|
||||
**Test Case ID**
|
||||
|
||||
- uninstall_plugin
|
||||
|
||||
**Steps**
|
||||
|
||||
1. Install plugin using Fuel CLI, refer to the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Create environment with enabled plugin in Fuel Web UI
|
||||
#. Add 3 controller nodes and apply the Controller role to all 3, 1 compute node, and 1 Dynatrace Security Gateway node
|
||||
#. Run network verification
|
||||
#. Delete listed environment
|
||||
#. Uninstall the plugin with running ``fuel plugins --remove <plugin-name>==<plugin_version>``
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. Plugin is installed successfully.
|
||||
#. The cluster is created and network verification is passed.
|
||||
#. The plugin is enabled and configured in the Fuel Web UI.
|
||||
#. When uninstalling the plugin, no plugin-related elements are left in the environment (e.g. UI elements disappear, Nailgun database is restored to the default state, no output for command "fuel plugins --list").
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\newpage
|
||||
|
||||
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/userdocs/fuel-install-guide/plugins/plugins_install_plugins.html>`_
|
||||
#. Ensure plugin is successfully installed, as in the `Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/plugins/plugins_install_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 and the Dynatrace Security Gateway was setup successfully
|
||||
|
||||
**Expected Result**
|
||||
|
||||
1. 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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
Test Strategy
|
||||
=============
|
||||
Dynatrace Fuel plugin is a non-intrusive plugin for Fuel, that doesn't modify or replace any standard OpenStack service. It provides the Dynatrace monitoring solution for the OpenStack control plane services and also monitoring for the applications, if you choose to install Dynatrace in your workloads as well. The plugin installs the Dynatrace Security Gateway and the Dynatrace OneAgent. The goal of the tests is to ensure that the installation of the Dynatrace components was successful and that the OpenStack services work as intended.
|
||||
|
||||
Acceptance Criteria
|
||||
-------------------
|
||||
All OSTF test should pass to ensure correct functionality of Fuel and the OpenStack cluster.
|
||||
|
||||
Test environment, infrastructure, and tools
|
||||
-------------------------------------------
|
||||
The plugin installs the Dynatrace OneAgent and the Dynatrace Security Gateway. The Dynatrace OneAgent runs on all major operating systems (see [1] for details). The Dynatrace Security Gateway should be installed on a dedicated physical or virtual machine. Find the requirements for the Dynatrace Security Gateway here [2].
|
||||
|
||||
To successfully operate Dynatrace, you also need a Dynatrace account with either a Dynatrace SaaS or Dynatrace Managed (on premise) environment. You can start a free trial [3] to setup a new environment or use your existing account. You will need the ID of your environment, the security token of your environment, and, if you use Dynatrace Managed, the IP address or domain name of the server where Dynatrace Managed is running for a successful setup of the Dynatrace OneAgent and the Dynatrace Security Gateway.
|
||||
|
||||
[1] Which environments and version does Dynatrace support?
|
||||
https://help.dynatrace.com/get-started/welcome/which-environments-and-versions-does-dynatrace-support/
|
||||
|
||||
[2] Requirements for the Dynatrace Security Gateway?
|
||||
https://help.dynatrace.com/get-started/install/how-do-i-install-dynatrace-security-gateway/
|
||||
|
||||
[3] Start 30-day free Dynatrace trial
|
||||
https://www.dynatrace.com/trial/
|
||||
|
||||
Product compatibility matrix
|
||||
----------------------------
|
||||
Dynatrace plugin is developed for Fuel 9.0/9.1. It works with all major operating systems (https://help.dynatrace.com/get-started/welcome/which-environments-and-versions-does-dynatrace-support/).
|
||||
@ -1,197 +0,0 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# SVG to PDF conversion
|
||||
SVG2PDF = inkscape
|
||||
SVG2PDF_FLAGS =
|
||||
# Build a list of SVG files to convert to PDF
|
||||
PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ContrailpluginforFuel.qhc"
|
||||
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ContrailpluginforFuel"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
@ -1,8 +0,0 @@
|
||||
Appendix
|
||||
--------
|
||||
|
||||
Find out more about Dynatrace here:
|
||||
`Dynatrace Help <https://help.dynatrace.com>`_
|
||||
|
||||
Find out more about Dynatrace Managed here:
|
||||
`Dynatrace Managed Help <https://help.dynatrace.com/managed/>`_
|
||||
@ -1,341 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# plugin name documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
# 'sphinx.ext.todo',
|
||||
# 'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Dynatrace plugin for Fuel'
|
||||
copyright = u'2016, Dynatrace LLC'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.0-1.0.0-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Dynatrace-doc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'fuel-plugin-dynatrace-doc.tex', u'Dynatrace plugin for Fuel Documentation',
|
||||
u'Dynatrace LLC.', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
# make latex stop printing blank pages between sections
|
||||
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
|
||||
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'fuel-plugin-openbook', u'Guide to the Openbook Plugin ver. 1.1-1.1.0-1 for Fuel',
|
||||
[u'Talligent Inc.'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'Dynatrace', u'Dynatrace Plugin for Fuel Documentation',
|
||||
u'Dynatrace LLC.', 'Dynatrace', 'Dynatrace Plugin for Fuel Documentation',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
# Insert footnotes where they are defined instead of
|
||||
# at the end.
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
#epub_title = u'The Openbook Plugin for Fuel'
|
||||
#epub_author = u'Talligent Inc.'
|
||||
#epub_publisher = u'Talligent Inc.'
|
||||
#epub_copyright = u'2015, Talligent Inc.'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = u'fuel-plugin-openbook'
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not optimized
|
||||
# for small screen space, using the same theme for HTML and epub output is
|
||||
# usually not wise. This defaults to 'epub', a theme designed to save visual
|
||||
# space.
|
||||
#epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the PIL.
|
||||
#epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#epub_use_index = True
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 157 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 138 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
@ -1,16 +0,0 @@
|
||||
.. _fuel-plugin-dynatrace:
|
||||
|
||||
Guide to the Dynatrace plugin version 1.0-1.0.0-1 for Fuel 9.0
|
||||
==============================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
|
||||
overview
|
||||
requirements
|
||||
prerequisites
|
||||
limitations
|
||||
releaseNotes
|
||||
installationGuide
|
||||
appendix
|
||||
@ -1,64 +0,0 @@
|
||||
Installation Guide
|
||||
------------------
|
||||
This guide assumes that you have installed Fuel and all the nodes of your
|
||||
future environment are discovered and functional.
|
||||
|
||||
Install Dynatrace Plugin
|
||||
''''''''''''''''''''''''
|
||||
1. Download the Dynatrace plugin from the `Dynatrace partner page
|
||||
<https://www.mirantis.com/partners/dynatrace/>`_.
|
||||
2. Copy the rpm package downloaded at the previous step to the Fuel Master
|
||||
node.
|
||||
|
||||
``scp fuel-plugin-dynatrace-1.0-1.0.0-1.noarch.rpm <fuel-master-ip>:/tmp>``
|
||||
|
||||
3. Log into the Fuel Master node and install the plugin.
|
||||
|
||||
``ssh <the Fuel Master node ip>``
|
||||
|
||||
``fuel plugins --install fuel-plugin-dynatrace-1.0-1.0.0-1.noarch.rpm``
|
||||
|
||||
4. You should get the following output:
|
||||
|
||||
``Plugin <plugin-name-version>.rpm was successfully installed``
|
||||
|
||||
Configure Dynatrace Plugin
|
||||
''''''''''''''''''''''''''
|
||||
1. First, you need to create an environment in Fuel web UI.
|
||||
|
||||
2. Select *Install Dynatrace* in the *Additional Services* screen to be able
|
||||
to assign the *Dynatrace* role to nodes.
|
||||
|
||||
3. Enable the plugin and fill the configuration fields with correct values
|
||||
of your Dynatrace environment (Settings > Other > Dynatrace).
|
||||
|
||||
- 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
|
||||
|
||||
.. image:: images/9yl01.png
|
||||
|
||||
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.
|
||||
|
||||
.. image:: images/uh37r.png
|
||||
|
||||
.. image:: images/k9ma8.png
|
||||
|
||||
5. Finish the configuration according to your requirements.
|
||||
|
||||
6. Execute network connectivity check.
|
||||
|
||||
7. 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.
|
||||
@ -1,13 +0,0 @@
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
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//>`_
|
||||
|
||||
@ -1,30 +0,0 @@
|
||||
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 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* 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.
|
||||
@ -1,9 +0,0 @@
|
||||
Prerequisites
|
||||
-------------
|
||||
You need an active Dynatrace environment. For the configuration of the
|
||||
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.
|
||||
|
||||
You can register for a free trial here:
|
||||
`Dynatrace Free Trial <https://www.dynatrace.com/trial/>`_
|
||||
@ -1,4 +0,0 @@
|
||||
Release Notes
|
||||
-------------
|
||||
|
||||
- 1.0-1.0.0-1: initial version of the plugin
|
||||
@ -1,5 +0,0 @@
|
||||
Requirements
|
||||
------------
|
||||
The plugin has the following requirements for software and hardware.
|
||||
|
||||
- Fuel version: 9.[0,1]
|
||||
@ -1,38 +0,0 @@
|
||||
attributes:
|
||||
metadata:
|
||||
group: 'other'
|
||||
dynatrace_tenant:
|
||||
type: "text"
|
||||
weight: 20
|
||||
value: ""
|
||||
label: "Environment ID"
|
||||
description: "Your Dynatrace environment ID"
|
||||
regex:
|
||||
source: '\S'
|
||||
error: "Environment ID must not be empty"
|
||||
dynatrace_token:
|
||||
type: "text"
|
||||
weight: 30
|
||||
value: ""
|
||||
label: "Token"
|
||||
description: "Your Dynatrace environment token"
|
||||
regex:
|
||||
source: '\S'
|
||||
error: "Token must not be empty"
|
||||
dynatrace_managed:
|
||||
value: false
|
||||
label: "Tick if you are using Dynatrace Managed"
|
||||
type: "checkbox"
|
||||
weight: 40
|
||||
dynatrace_server:
|
||||
value: ""
|
||||
label: "Dynatrace Managed IP/Domain"
|
||||
description: "Dynatrace Managed IP address or domain name"
|
||||
weight: 50
|
||||
type: "text"
|
||||
regex:
|
||||
source: '\S'
|
||||
error: "IP/Domain must not be empty"
|
||||
restrictions:
|
||||
- condition: "settings:dynatrace.dynatrace_managed.value == false"
|
||||
action: "hide"
|
||||
@ -1,33 +0,0 @@
|
||||
# Plugin name
|
||||
name: dynatrace
|
||||
# Human-readable name for your plugin
|
||||
title: Dynatrace
|
||||
# Plugin version
|
||||
version: '1.0.0'
|
||||
# Description
|
||||
description: "Installs the Dynatrace OneAgent and sets up the Dynatrace Security Gateway"
|
||||
# Required fuel version
|
||||
fuel_version: ['9.0']
|
||||
# Specify license of your plugin
|
||||
licenses: ['Apache License Version 2.0']
|
||||
# Specify author or company name
|
||||
authors: ['Dirk Wallerstorfer (dirk.wallerstorfer@dynatrace.com), Dynatrace']
|
||||
# A link to the plugin's page
|
||||
homepage: 'https://github.com/Dynatrace/fuel-plugin-dynatrace'
|
||||
# Specify a group which your plugin implements, possible options:
|
||||
# network, storage, storage::cinder, storage::glance, hypervisor,
|
||||
# equipment
|
||||
groups: ['monitoring']
|
||||
# Change `false` to `true` if the plugin can be installed in the environment
|
||||
# after the deployment.
|
||||
is_hotpluggable: true
|
||||
|
||||
# The plugin is compatible with releases in the list
|
||||
releases:
|
||||
- os: ubuntu
|
||||
version: mitaka-9.0
|
||||
mode: ['ha', 'multinode']
|
||||
deployment_scripts_path: deployment_scripts/
|
||||
repository_path: repositories/ubuntu
|
||||
# Version of plugin package
|
||||
package_version: '4.0.0'
|
||||
@ -1,43 +0,0 @@
|
||||
#dynatrace-oneagent:
|
||||
# Role name
|
||||
#name: "Dynatrace OneAgent"
|
||||
# Role description
|
||||
#description: "Installs the Dynatrace OneAgent"
|
||||
# If primary then during orchestration this role will be
|
||||
# separated into primary-role and role
|
||||
#has_primary: false
|
||||
# Assign public IP to node if true
|
||||
#public_ip_required: false
|
||||
# Weight that will be used to sort out the
|
||||
# roles on the Fuel web UI
|
||||
#weight: 1000
|
||||
#conflicts:
|
||||
# - compute
|
||||
# - ceph-osd
|
||||
# - cinder
|
||||
# - base-os
|
||||
# - compute-vmware
|
||||
# - virtual
|
||||
|
||||
dynatrace-security-gateway:
|
||||
# Role name
|
||||
name: "Dynatrace Security Gateway"
|
||||
# Role description
|
||||
description: "Installs the Dynatrace Security Gateway"
|
||||
# If primary then during orchestration this role will be
|
||||
# separated into primary-role and role
|
||||
has_primary: false
|
||||
# Assign public IP to node if true
|
||||
public_ip_required: false
|
||||
# Weight that will be used to sort out the
|
||||
# roles on the Fuel web UI
|
||||
weight: 1001
|
||||
conflicts:
|
||||
- controller
|
||||
- compute
|
||||
- ceph-osd
|
||||
- cinder
|
||||
- base-os
|
||||
- compute-vmware
|
||||
- dynatrace-oneagent
|
||||
- virtual
|
||||
@ -1,5 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Add here any the actions which are required before plugin build
|
||||
# like packages building, packages downloading from mirrors and so on.
|
||||
# The script should return 0 if there were no errors.
|
||||
112
specs/spec.rst
112
specs/spec.rst
@ -1,112 +0,0 @@
|
||||
|
||||
=========================
|
||||
Fuel Plugin for Dynatrace
|
||||
=========================
|
||||
|
||||
Dynatrace plugin for Fuel provides enterprise monitoring for your OpenStack
|
||||
environment and for the application that run on top.
|
||||
|
||||
It uses Fuel pluggable architecture.
|
||||
The plugin must be compatible with the version 9.0 of Mirantis OpenStack and the latest version of Dynatrace.
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
Implement a Fuel plugin which will deploy the Dynatrace OneAgent to controller nodes and setup the Dynatrace
|
||||
Security Gateway.
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
Manual installation of the Dynatrace OneAgent and the Dynatrace Security Gateway.
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
Upgrade impact
|
||||
--------------
|
||||
|
||||
Fuel currently supports upgrading of Fuel Master node, so it is necessary to
|
||||
install a new version of plugin which supports new Fuel release.
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
|
||||
Dynatrace plugin uses Fuel pluggable architecture.
|
||||
After it is installed, the user can enable the plugin on the Setting tab of the Fuel web UI
|
||||
and customize plugins settings.
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Primary assignee:
|
||||
|
||||
- Dirk Wallerstorfer <dirk.wallerstorfer@dynatrace.com> - feature lead, developer
|
||||
|
||||
|
||||
Project manager:
|
||||
|
||||
- Karolina Ruszkowska <karolina.ruszkowska@dynatrace.com>
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Create pre-dev environment and manually deploy Dynatrace software
|
||||
* Create Fuel plugin bundle, which contains deployments scripts, puppet modules and metadata
|
||||
* Implement puppet module with the following functions:
|
||||
|
||||
- Allow configuration of Dynatrace components
|
||||
- Install Dynatrace OneAgent to controller nodes
|
||||
- Install Dynatrace Security Gateway to node
|
||||
|
||||
* Test Dynatrace plugin
|
||||
* Create Documentation
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
* Fuel 9.0 and higher
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
* Sanity checks including plugin build
|
||||
* Syntax check
|
||||
* Functional testing
|
||||
* Non-functional testing (Destructive and Negative)
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
|
||||
* Deployment Guide (how to prepare an env for installation, how to install the plugin, how to deploy OpenStack env with the plugin)
|
||||
* User Guide (which features the plugin provides, how to use them in the deployed OS env)
|
||||
* Test Plan
|
||||
* Test Report
|
||||
|
||||
References
|
||||
==========
|
||||
@ -1 +0,0 @@
|
||||
[]
|
||||
@ -1,3 +0,0 @@
|
||||
#!/bin/bash
|
||||
set -eux
|
||||
echo uninstall > /tmp/fuel-plugin-dynatrace_uninstall
|
||||
Loading…
Reference in New Issue
Block a user