Skip to content

Commit

Permalink
Initial Dynatrace addon documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@aloismayr
aloismayr committed Jun 5, 2017
1 parent cb971b2 commit 24f2a9c
Show file tree
Hide file tree
Showing 9 changed files with 283 additions and 114 deletions.
9 changes: 4 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On the first use in body text in a page, spell out Pivotal Cloud Foundry (PCF).

### About the Partner Template for Tile Documentation

This template helps partners prepare documentation for Pivotal Cloud Foundry (PCF) partner services that appear on [Pivotal Network](https://network.pivotal.io/).
This template helps partners prepare documentation for Pivotal Cloud Foundry (PCF) partner services that appear on [Pivotal Network](https://network.pivotal.io/).

### <a id='overview'></a>Overview

Expand All @@ -27,7 +27,7 @@ To begin using this repo to develop your documentation, perform the following st

1. Make a fork of this repo.
1. Clone your fork onto your local machine.
1. Work your way through each topic, replacing the placeholders in ALL-CAPS and following the instructions in **bold**.
1. Work your way through each topic, replacing the placeholders in ALL-CAPS and following the instructions in **bold**.
* When writing your documentation, follow the guidelines in [Style Notes for Tile Authors](style-guide.md).
1. Complete the subnav by replacing the placeholders in ALL-CAPS in the subnav file at `docs-book/master_middleman/source/subnavs/myservice_subnav.erb` in this repo.
1. View your documentation as a live local site in a browser, by following the steps below in the [How To Use Bookbinder To View Your Docs](#bookbinder) section.
Expand Down Expand Up @@ -86,7 +86,7 @@ In Terminal window:
```
$ ssh-keygen
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/pspinrad/.ssh/id_rsa):
Enter file in which to save the key (/Users/pspinrad/.ssh/id_rsa):
```
1. Get a [Github](http://github.com) account.
Expand Down Expand Up @@ -144,7 +144,7 @@ In Terminal window:
1. Run `bundle exec bookbinder watch` to build the book on your machine.
`$ bundle exec bookbinder watch`
1. Browse to `localhost:4567` to view the book locally and "watch" any changes that you make to source `html.md.erb` files. As you make and save changes to the local source files for your site, you will see them in your browser after a slight delay.
1. After each session of writing or revising your docs source files, commit and push them to your github repo.
Expand All @@ -154,4 +154,3 @@ Happy documenting!
![Partner Template landing page](./docs-book/master_middleman/source/images/partner-template-landing.png)
![Partner Template service index page](./docs-book/master_middleman/source/images/partner-template-service-index.png)
12 changes: 10 additions & 2 deletions docs-book/master_middleman/source/subnavs/dynatrace-fullstack-addon_subnav.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,21 @@
</li>

<li>
<a href="/dynatrace-fullstack-addon/using.html">Using Dynatrace Full-Stack Add-on for PCF</a>
<a href="/dynatrace-fullstack-addon/upgrading.html">Upgrading the Dynatrace Full-Stack Add-On for PCF</a>
</li>

<li>
<a href="/dynatrace-fullstack-addon/uninstalling.html">Uninstalling the Dynatrace Full-Stack Add-On for PCF</a>
</li>

<li>
<a href="/dynatrace-fullstack-addon/troubleshooting.html">Troubleshooting the Dynatrace Full-Stack Add-On for PCF</a>
</li>

<li>
<a href="/dynatrace-fullstack-addon/release-notes.html">Release Notes for Dynatrace Full-Stack Add-on for PCF</a>
</li>

</ul>
</div>
</div><!--end of sub-nav-->
88 changes: 26 additions & 62 deletions docs-content/index.html.md.erb
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: YOUR-PRODUCT-NAME (Beta)
title: Dynatrace Full-Stack Add-on for PCF (Beta)
owner: Partners
---
<style>
Expand All @@ -13,46 +13,30 @@ owner: Partners
}
</style>

<p class="note warning">
<strong>WARNING! </strong>
The PRODUCT-NAME for PCF tile is currently in beta and is intended for evaluation and test purposes only.
Do not use this product in a PCF production environment.
<p class="note">
<strong>Note: </strong>
The Dynatrace Full-Stack Add-on for PCF tile is currently in beta and is intended for evaluation and test purposes only.
</p>

**This topic begins with a brief description of what the product tile (e.g. Apigee Edge Service Broker for PCF) does,
whereas the Overview section below describes what the service itself (e.g. Apigee Edge) does. See below for an example.**

This documentation describes the Apigee Edge Service Broker for Pivotal Cloud Foundry (PCF). The Apigee Edge Service
Broker for PCF enables developers to manage APIs for their PCF apps through the Apigee Edge management console.

**Note**: This description will appear under **OVERVIEW** in the tile's listing on
[Pivotal Network](http://network.pivotal.io).
This documentation describes the Dynatrace Full-Stack Add-on for Pivotal Cloud Foundry (PCF). The Dynatrace Full-Stack Add-on
for PCF enables operators to roll out Dynatrace OneAgent to CF clusters and installed tiles for monitoring the platform and deployed applications.

## <a id='overview'></a>Overview

**The overview describes the service that your product offers to PCF developers. See below for an example.**

The Apigee Edge Service Broker for PCF registers a service broker with PCF and exposes its service plans on the
Marketplace. Developers can then create service plan instances using Apps Manager or the Cloud Foundry Command
Line Interface (cf CLI) and bind them to their apps.

Creating an Apigee Edge for PCF service instance and binding it to an app creates an Apigee Edge API proxy that
handles requests for the app. This lets developers use the Apigee Edge management console to manage API request
handling between clients and the app.

**Note**: This overview will appear under **OVERVIEW**, combined with the description above in the tile's listing on
[Pivotal Network](http://network.pivotal.io).
Dynatrace Full-Stack Addon for PCF enables monitoring of PCF components like PCF Elastic Runtime, PCF Runtime for Windows, and all applications deployed to PCF.
Once the Dynatrace Full-Stack Addon was deployed to the platform, Dynatrace OneAgent will automatically start monitoirng any deployed applications. Developers
can use Dynatrace UI to get insights into their apps and microservices.

## <a id='features'></a>Key Features

YOUR-PRODUCT-NAME includes the following key features:
Dynatrace Full-Stack Addon includes the following key features:

* Feature one.
* Feature two.
* Feature three.
* Monitoring of PCF components.
* Automatic monitoring of deployed applications.
* Automatic distributed tracing of microservices.
* Automatic discovery of deployment dependencies and communication behavior.
* Automatic root-cause analysis and AI-based problem detection

**Note**: This feature list will appear under **FEATURES** in the tile's listing on
[Pivotal Network](http://network.pivotal.io).

## <a id="snapshot"></a>Product Snapshot

Expand All @@ -63,55 +47,35 @@ The following table provides version and version-support information about PRODU
<th>Details</th>
<tr>
<td>Version</td>
<td>vYOUR-VERSION-NUMBER</td>
<td>v0.3.2</td>
</tr>
<tr>
<td>Release date</td>
<td>YOUR-RELEASE-DATE (Ex: July 1, 2017)</td>
<td>June 12, 2017</td>
</tr>
<tr>
<td>Software component version</td>
<td>vYOUR-SOFTWARE-COMPONENT-VERSION-NUMBER</td>
<td>v0.3.2</td>
</tr>
<tr>
<td>Compatible Ops Manager version(s)</td>
<td>vYOUR-COMPATIBLE-OPS-MAN-VERSION (Ex. v1.8.x, v1.9.x, v1.10.x)</td>
<td>v1.10.x</td>
</tr>
<tr>
<td>Compatible Elastic Runtime version(s)</td>
<td>vYOUR-COMPATIBLE-ELASTIC-RUNTIME-VERSION (Ex. v1.8.x, v1.9.x, v1.10.x)</td>
</tr>
<tr>
<td>IaaS support</td>
<td>AWS?, Azure?, GCP?, OpenStack?, and vSphere?</td>
</tr>
<tr>
<td>IPsec support?</td>
<td>[Yes or No]</td>
<td>v1.10.x</td>
</tr>
</table>

## <a id="reqs"></a>Requirements

**Provide any general or specific requirements, prerequisites, or dependencies here.
A general requirement might be something like, "An AppDynamics account."
A specific requirement might be something like, "Packaging Dependencies for Offline Buildpacks."**

YOUR-PRODUCT-NAME has the following requirements:

+ PREREQUISITE-1

+ PREREQUISITE-2
Dynatrace Full-Stack Addon has the following requirements:

## <a id="limitations"></a>Limitations

**List any known limitations.**
+ A Dynatrace environment
+ Pivotal Cloud Foundry (PCF) operator administration rights
+ BOSH deployed through Ops Manager 1.10 or later

## <a id="feedback"></a>Feedback

Please provide any bugs, feature requests, or questions to the
[Pivotal Cloud Foundry Feedback](mailto:[email protected]) list or send an email to YOUR-SUPPORT-EMAIL.

## <a id='license'></a>License

**List any license information here.**
Please provide any bugs, feature requests, or questions to the
[Pivotal Cloud Foundry Feedback](mailto:[email protected]) list.
123 changes: 108 additions & 15 deletions docs-content/installing.html.md.erb
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,121 @@
---
title: Installing and Configuring YOUR-PRODUCT-NAME
title: Installing and Configuring Dynatrace Full-Stack Add-on
owner: Partners
---

This topic describes how to install and configure YOUR-PRODUCT-NAME.
This topic describes how to install and configure the Dynatrace Full-Stack Add-on.

##<a id='install'></a> Install and Configure YOUR-PRODUCT-NAME
##<a id='create-mfest'></a> Create the Dynatrace Manifest

1. Download the product file from Pivotal Network.
Follow these steps to create the Dynatrace manifest for your deployment:

1. Navigate to the Ops Manager Installation Dashboard and click **Import a Product** to upload the product file.
1. Create a Dyntrace manifest file `runtime-config-dyntrace.yml`, starting with the code below as a template.
<pre>releases:
\- {name: dynatrace-oneagent, <strong>version</strong>: 0.3.2}<br>
addons:
\- name: dynatrace-oneagent-addon
jobs:
\- <strong>name</strong>: dynatrace-oneagent
release: dynatrace-oneagent
include:
stemcell:
\- <strong>os</strong>: ubuntu-trusty
properties:
dynatrace:
<strong>environmentid</strong>: abc12345
<strong>apitoken</strong>: bvQ0e--secret--2fEL9B
<strong>apiurl</strong>: https://{your-managed-cluster.com}/e/{environmentid}/api
starthelper: 1
\#optional: extra addon configuration for Windows cells
\- name: dynatrace-oneagent-windows-addon
jobs:
\- <strong>name</strong>: dynatrace-oneagent-windows
release: dynatrace-oneagent
include:
stemcell:
\- <strong>os</strong>: windows2012R2
properties:
dynatrace:
<strong>environmentid</strong>: abc12345
<strong>apitoken</strong>: bvQ0e--secret--2fEL9B
<strong>apiurl</strong>: https://{your-managed-cluster.com}/e/{environmentid}/api
</pre>

1. Under the **Import a Product** button, click **+** next to the version number of YOUR-PRODUCT-NAME.
This adds the tile to your staging area.
2. Replace the values listed in the template as follows:
* <code>releases: - version</code>: Specify the version number of your Dynatrace Full-Stack Add-on download from Pivotal Network.
* <code>jobs: - name</code>: Do not change the name of this job. It must be `dynatrace-oneagent` for Linux VMs.
* <code>include: stemcell - os</code>: Do not change the OS type.
* <code>environmentid</code>: Replace with your environmentId from the Dynatrace UI
* <code>apitoken</code>: Replace with your PaaS token from the Dynatrace UI
* <code>apiurl</code>: Replace with your Dynatrace Managed URL, including the environmentId. An example URL might look like the following `https://{your-managed-cluster.com}/e/{environmentid}/api`

1. Click the newly added **YOUR-PRODUCT-NAME** tile.
3. Optional: The add-on supports additional configuration properties:
* <code>sslmode</code>: Set to `all` if you want to accept all self-signed SSL certificates.
* <code>downloadurl</code> Specify a direct download URL for the Dynatrace OneAgent. If this propery is set, bosh will download the OneAgent from this location.
* <code>proxy</code>: Specify the proxy to be used for communication.

1. **This portion of the procedure should tell the users how to configure the newly added tile by
walking them through the sections. Which fields should they fill out? What are the different
checkboxes? Include relevant screenshots here.**
4. If you also want to deploy Dynatrace to Windows Diego cells, please configure a second add-on section for the `dynatrace-oneagent-windows` job. The properties for `environmentid`, `apitoken`, and `apiurl` remain the same as with the normal Linux configuration.
* <code>jobs: - name</code>: For Windows cells it must be `dynatrace-oneagent-windows`.
* <code>include: stemcell - os</code>: For Windows cells it must be `windows2012R2`.

1. Click **Save**.
<p class="note"><strong>Note</strong>: To modify the configuration in an existing deployment, you must update the manifest file and redeploy.</p>

1. Return to the Ops Manager Installation Dashboard and click **Apply Changes** to install YOUR-PRODUCT-NAME tile.

**If needed, include additional configuration information below. For example, maybe there are
configuration options not required for installation but which could be useful for certain users.**
##<a id="download-deploy"></a>Download and Deploy the Dynatrace Full-Stack Add-On

After deploying Ops Manager, perform the following steps to download and deploy the Dynatrace Full-Stack Add-on:

1. Download the Dynatrace Full-Stack Add-on software binary from the [Pivotal Network](https://network.pivotal.io/products/p-dynatrace-addon) to your local machine.

2. Copy the software binary to your Ops Manager instance.
<pre class="terminal">$ scp -i PATH/TO/PRIVATE/KEY dynatrace-release.tar.gz ubuntu@YOUR-OPS-MANAGER-VM-IP:</pre>

3. Copy the Dynatrace manifest file to your Ops Manager instance.
<pre class="terminal">$ scp -i PATH/TO/PRIVATE/KEY runtime-config-dyntrace.yml ubuntu@YOUR-OPS-MANAGER-VM-IP:</pre>

4. SSH into Ops Manager.
<pre class="terminal">$ ssh -i PATH-TO-PRIVATE-KEY ubuntu@YOUR-OPS-MANAGER-VM-IP</pre>

5. On the Ops Manager VM, navigate to the software binary location in your working directory.
<pre class="terminal">
$ cd PATH-TO-BINARY</pre>

6. On the Ops Manager VM, target the internal IP address of your BOSH Director. When prompted, enter your BOSH Director credentials. To retrieve your BOSH Director credentials, navigate to Ops Manager, click the **Credentials** tab, and click **Link to Credential** next to **Director Credentials**.
<pre class="terminal">
$ bosh --ca-cert /var/tempest/workspaces/default/root\_ca\_certificate target YOUR-BOSH-DIRECTOR-INTERNAL-IP
Target set to 'p-bosh'
Your username: director
Enter password: ******************
Logged in as 'director'
</pre>

7. Upload your release.
<pre class="terminal">$ bosh upload release PATH-TO-BINARY/dynatrace-release.tar.gz</pre>

8. Optionally, from the command line, confirm that the upload of the Dynatrace software binary completed. You should see the Dynatrace binary file.
<pre class="terminal">$ bosh releases</pre>

9. Update your runtime configuration to include the Dynatrace Add-on.
<p class="note"><strong>Note</strong>: If you installed other BOSH add-ons, you must merge the Dynatrace manifest into your existing add-on manifest. Append the contents of runtime-config-dyntrace.yml to your existing add-on YML file.</p>
<pre class="terminal">$ bosh update runtime-config PATH/runtime-config-dyntrace.yml</pre>

10. Verify your runtime configuration changes match what you specified in the Dynatrace manifest file.

<pre class="terminal">
$ bosh runtime-config
Acting as user 'admin' on 'micro'

releases:
<span>-</span> {name: dynatrace-oneagent, version: 0.3.2}

addons:
<span>-</span> name: dynatrace-oneagent-addon
jobs:
<span>-</span> name: dynatrace-oneagent
release: dynatrace-oneagent
...
</pre>

11. Navigate to your **Installation Dashboard** in Ops Manager.

12. Click **Apply Changes**
25 changes: 10 additions & 15 deletions docs-content/release-notes.html.md.erb
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,22 @@
---
title: Release Notes for YOUR-PRODUCT-NAME
title: Release Notes for the PCF Dynatrace Full-Stack Add-on
owner: Partners
---

**This topic should include the Release Notes for your product. For examples, see the
[GCP Service Broker Release Notes](http://docs.pivotal.io/gcp-sb/release-notes.html) or the
**This topic should include the Release Notes for your product. For examples, see the
[GCP Service Broker Release Notes](http://docs.pivotal.io/gcp-sb/release-notes.html) or the
[ISS Knowtify Search Analytics Release Notes](http://docs.pivotal.io/knowtify/release.html).
When you release a new version, add new release notes to this file, keeping the older notes below.**

These are release notes for YOUR-PRODUCT-NAME.
These are release notes for the PCF Dynatrace Full-Stack Add-on.

##<a id="ver"></a> vCURRENT-VERSION-NUMBER (Ex. v1.0.1)
##<a id="ver"></a> v0.3.2

**Release Date:** RELEASE-DATE (Ex. August 1, 2016)
**Release Date:** June 12, 2017

Features included in this release:

* Feature one.
* Feature two.
* Feature three.

Known issues in this release:

* Issue one.
* Issue two.
* Issue three.
* BOSH job for deploying Dynatrace OneAgent to Linux VMs.
* BOSH job for deploying Dynatrace OneAgent to Windows VMs.
* Flag for accepting self-signed certificates for agent deployment
* Property to specify proxy credentials in proxied environments
Loading

0 comments on commit 24f2a9c

Please sign in to comment.