-
Notifications
You must be signed in to change notification settings - Fork 9
/
installing.html.md.erb
executable file
·289 lines (240 loc) · 12.9 KB
/
installing.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
---
title: Installing and Configuring Dynatrace Full-Stack Add-on for VMware Tanzu
owner: Partners
---
This topic explains how to install and configure the Dynatrace Full-Stack Add-on for VMware Tanzu.
<p class="note"><strong>Note:</strong> The syntax for the Dynatrace manifest is identical for TAS and TKGI. As such, if no detailed include/exclude rules are used the same manifest can be utilized for both TAS and TKGI. In deployments utilizing Pivotal Operations Manager (OpsMan) 2.5 or greater where both TAS and TKGI are configured by the same OpsMan instance, this means both TAS and TKGI can be monitored simulatenously via a single deployment of the Dynatrace Full-Stack Add-on.</p>
## <a id='create-mfest'></a> Create the Dynatrace Manifest
Follow these steps to create the Dynatrace manifest for your deployment:
1. Create a Dynatrace manifest file called `runtime-config-dynatrace.yml`, using the code below as a template to get started.
<p class="note"><strong>Note:</strong> With Operations Manager 2.9, the use of properties at the add-on level has been deprecated. These properties have been moved to the job level.</p>
```
releases:
- name: dynatrace-oneagent
version: 1.4.0
addons:
- name: dynatrace-oneagent-addon
jobs:
- name: dynatrace-oneagent
release: dynatrace-oneagent
properties:
dynatrace:
environmentid: <environmentId>
apitoken: <paas-token> # sorry it's confusing :(
###
# optional properties below
###
# Replace with your Dynatrace Managed URL, including the environment ID.
# An example URL might look like the following
apiurl: https://{your-managed-cluster.com}/e/{environmentid}/api
# Set to 'all' if you want to accept all self-signed SSL certificates.
sslmode: all
# Specify a direct download URL for Dynatrace OneAgent.
# If this propery is set, BOSH will download OneAgent from this location.
downloadurl: https://direct-download-url-for-agent
# Specify the proxy to be used for communication.
proxy: https://your-proxy-url
# Specify in which hostgroup the VMs in this deployments belong
hostgroup: example_hostgroup
# Define host tags for the VMs in this deployment
hosttags: landscape=production team=my_team
# Define custom properties for the VMs in this deployment
hostprops: Department=Acceptance Stage=Sprint
# Enable cloud infrastructure monitoring mode.
# Set this to 1 to activate it
infraonly: 0
# Enable validation of the download via certificate
# Set this to true to active it
validatedownload: false
# Hand over any installer argument
# Use either this OR the hostgroup, hosttags, infraonly, proxy properties.
# Usage of 'installerargs' will overwrite the others!
installerargs: HOST_GROUP=example_hostgroup INFRA_ONLY=0
include:
deployments:
- name-of-your-deployment
stemcell:
- os: ubuntu-bionic
exclude:
lifecycle: errand
# optional: extra addon configuration for Windows cells
- name: dynatrace-oneagent-windows-addon
jobs:
- name: dynatrace-oneagent-windows
release: dynatrace-oneagent
properties:
dynatrace:
environmentid: <environmentId>
apitoken: <paas-token> # sorry it's confusing :(
# All of the optional properties for the Linux addon shown above (for example, apiurl, hostgroup) can also be used here.
include:
deployments:
- name-of-your-deployment
stemcell:
- os: windows
exclude:
lifecycle: errand
```
1. Replace the values listed in the template as follows:
* `releases: - version`: Specify the version number of your Dynatrace Full-Stack Add-on for VMware Tanzu download from Pivotal Network.
* `jobs: - name`: Do not change the name of this job. It must be `dynatrace-oneagent` for Linux VMs.
* `include: stemcell - os<`: Change to the OS type of your linux stemcell(s).
* `environmentid`: Replace with your Dynatrace environment ID.
* `apitoken`: Replace with your PaaS token from the Dynatrace UI.
* `apiurl`: If using Dynatrace Managed, replace with your Dynatrace Managed URL, including the environment ID. An example URL might look like the following: `https://{your-managed-cluster.com}/e/{environmentid}/api`
1. (Optional) The add-on supports additional configuration properties:
* `sslmode`: Set to `all` if you want to accept all self-signed SSL certificates.
* `downloadurl`: Specify a direct download URL for Dynatrace OneAgent. If this propery is set, BOSH will download OneAgent from this location.
* `proxy`: Specify the proxy to be used for communication.
* `hostgroup`: Specify hostgroup for VMs in this deployment.
* `hosttags`: Specify host tags for VMs in this deployment.
* `hostprops`: Specify custom properties for VMs in this deployment.
* `infraonly`: Set to `1` to enable cloud infrastructure monitoring mode. This disables all deep process monitoring.
* `validatedownload`: Set to `true` to enable validation of the download via certificate.
* `installerargs`: Supports Dynatrace [installer arguments](https://www.dynatrace.com/support/help/technology-support/operating-systems/linux/installation/customize-oneagent-installation-on-linux/), suggested values include setting USER=vcap and GROUP=vcap to allow Dynatrace plugins to monitor HAProxy. Note, setting hostgroup, hosttags, infraonly, proxy properties here will override settings deployed elsewhere in runtime config.
1. If you also want to deploy Dynatrace to Windows Diego cells, 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.
* `jobs: - name`: For Windows cells, this must be `dynatrace-oneagent-windows`.
* `include: stemcell - os`: Change to the OS type of your Windows stemcell(s).
<p class="note"><strong>Note:</strong> To modify the configuration of an existing deployment, you must update the manifest file and redeploy.</p>
## <a id="download-deploy"></a> Download and Deploy the Dynatrace Full-Stack Add-on for VMware Tanzu
After deploying Ops Manager, do the following to download and deploy the Dynatrace Full-Stack Add-on for VMware Tanzu:
1. Download the Dynatrace Full-Stack Add-on for VMware Tanzu software binary from [Pivotal Network](https://network.pivotal.io/products/dynatrace-fullstack-addon) to your local machine.
1. 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>
1. Copy the Dynatrace manifest file to your Ops Manager instance.
<pre class="terminal">$ scp -i PATH/TO/PRIVATE/KEY runtime-config-dynatrace.yml ubuntu@YOUR-OPS-MANAGER-VM-IP:</pre>
1. SSH into Ops Manager.
<pre class="terminal">$ ssh -i PATH-TO-PRIVATE-KEY ubuntu@YOUR-OPS-MANAGER-VM-IP</pre>
1. On the Ops Manager VM, navigate to the software binary location in your working directory.
<pre class="terminal">
$ cd PATH-TO-BINARY</pre>
1. Log in to the BOSH Director.
<ol type="i">
<li>
On the Ops Manager VM, create an alias in the BOSH CLI for your BOSH Director IP address. For example:
<pre class="terminal">$ bosh alias-env my-env -e 10.0.16.10</pre>
</li>
<li>
Log in to the BOSH Director, specifying the newly created alias.
For example:
<pre class="terminal">$ bosh -e my-env login</pre>
</li>
</ol>
1. Upload your release.
<pre class="terminal">$ bosh -e my-env upload-release PATH-TO-BINARY/dynatrace-release.tar.gz</pre>
1. (Optional) From the command line, you can confirm that upload of the Dynatrace software binary is complete. You should see the Dynatrace binary file.
<pre class="terminal">$ bosh -e my-env releases</pre>
1. Update your runtime configuration to include the Dynatrace Add-on for VMware Tanzu.
<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 <code>runtime-config-dynatrace.yml</code> to your existing add-on YML file.</p>
<pre class="terminal">$ bosh -e my-env update-runtime-config PATH/runtime-config-dynatrace.yml</pre>
1. Verify your runtime configuration changes match what you specified in the Dynatrace manifest file.
<pre class="terminal">$ bosh -e my-env runtime-config</pre>
For example:
<pre class="terminal">
Acting as user 'admin' on 'micro'
releases:
<span>-</span> {name: dynatrace-oneagent, version: 1.4.0}
addons:
<span>-</span> name: dynatrace-oneagent-addon
jobs:
<span>-</span> name: dynatrace-oneagent
release: dynatrace-oneagent
...
</pre>
1. Navigate to your **Installation Dashboard** in Ops Manager.
1. Click **Apply Changes**.
## <a id='advanced-configuration'></a> Advanced Configuration
This section explains advanced configuration of the Dynatrace Full-Stack Add-on for VMware Tanzu.
## <a id='host-groups'></a> About the Hostgroup Property
Dynatrace utilizes host group functionality to automatically group hosts. Host groups make it easier to apply unique configurations within Dynatrace to groups of hosts. Functionality that can be configured based on host group includes anomaly detection and OneAgent updates. Host groups also change how process groups are detected. When the same process is running in two different host groups, Dynatrace will create one process group for each host group. Additionally, automatic tagging can make use of host groups.
For more information read the [full host group documentation.](https://www.dynatrace.com/support/help/how-to-use-dynatrace/hosts/configuration/organize-your-environment-using-host-groups/)
## <a id='host-groups-examples'></a> Hostgroup Property Examples
An example use of the hostgroup property is to create hostgroups for individual Tanzu Kubernetes Grid - Integrated (TKGI) clusters
1. Log in to the BOSH Director.
<ol type="i">
<li>
Log in to TKGI.
For example:
<pre class="terminal">$ tkgi login -a api.tkgi.somedomain.com -u someusername</pre>
</li>
</ol>
1. Determine the UUID for the TKGI cluster (will begin with service-instance_)
<ol type="i">
<li>
For example:
<pre class="terminal">$ tkgi cluster my-cluster</pre>
output snipped for brevity:
<pre class="terminal"> UUID: a4604071-07df-49e7-92d1-2effc9e3fe42</pre>
</li>
</ol>
1. Create a Dynatrace manifest file called `runtime-config-dynatrace.yml`, using the code below as a template to get started.
```
releases:
- {name: dynatrace-oneagent, version: 1.4.0}
addons:
- name: dynatrace-oneagent-addon
jobs:
- name: dynatrace-oneagent
release: dynatrace-oneagent
include:
deployments:
# enter the BOSH deployment name, in the format of service-instance_<UUID-OBTAINED-IN-PREVIOUS-STEP>
- service-instance_a4604071-07df-49e7-92d1-2effc9e3fe42
stemcell:
- os: ubuntu-bionic
exclude:
lifecycle: errand
properties:
dynatrace:
environmentid: <environmentid>
apitoken: <token>
# Specify a hostgroup for this TKGI cluster
hostgroup: tkgi_cluster_xyz
```
1. Update your runtime configuration to include the Dynatrace Add-on for VMware Tanzu.
<pre class="terminal">$ bosh -e my-env update-runtime-config PATH/runtime-config-dynatrace.yml</pre>
1. Navigate to your **Installation Dashboard** in Ops Manager.
1. Click **Apply Changes**.
## <a id='host-groups-examples'></a> Multiple Deployment Host Group Example
When applying host groups to multiple deployments, the entire addon block is duplicated with unique job names, see below example:
```
releases:
- {name: dynatrace-oneagent, version: 1.4.0}
addons:
- name: dynatrace-oneagent-addon-xyz
jobs:
- name: dynatrace-oneagent
release: dynatrace-oneagent
include:
deployments:
# enter the BOSH deployment name, in the format of service-instance_<UUID-OBTAINED-IN-PREVIOUS-STEP>
- service-instance_a4604071-07df-49e7-92d1-2effc9e3fe42
stemcell:
- os: ubuntu-xenial
exclude:
lifecycle: errand
properties:
dynatrace:
environmentid: <environmentid>
apitoken: <token>
# Specify a hostgroup for this TKGI cluster
hostgroup: tkgi_cluster_xyz
- name: dynatrace-oneagent-abc
jobs:
- name: dynatrace-oneagent
release: dynatrace-oneagent
include:
deployments:
# enter the BOSH deployment name, in the format of service-instance_<UUID-OBTAINED-IN-PREVIOUS-STEP>
- service-instance_adee170c-21ba-4274-97a4-cab13ed07bb7
stemcell:
- os: ubuntu-xenial
exclude:
lifecycle: errand
properties:
dynatrace:
environmentid: <environmentid>
apitoken: <token>
# Specify a hostgroup for this TKGI cluster
hostgroup: tkgi_cluster_abc
```