Deploy BOSH release for Full-Stack monitoring on Cloud Foundry
The following guidelines apply to the deployment of Dynatrace OneAgent to Cloud Foundry VMs, including Cloud Foundry components, Diego cells, and Windows Diego cells.
There are two approaches for the deployment of the OneAgent BOSH release: immutable and lightweight. See the deployment strategies to decide which approach suits your needs.
-
Deploy an Environment ActiveGate (SaaS customers only).
-
Locate the download URLs—check documentation for the Deployment API, which is part of the Environment API v1.
-
Get the latest versions of the BOSH release.
curl -X GET https://{api-url}/api/v1/deployment/boshrelease/versions/unix -H /'Authorization: Api-Token {paas-token}' -
Download the BOSH release.
For Dynatrace SaaS, replace
{api-url}with the address of the environment ActiveGate.wget -O dynatrace-release.tgz --header="Authorization: Api-Token {paas-token}" /https://{api-url}/api/v1/deployment/boshrelease/agent/unix/version/{version}?skipMetadata=truewget -O dynatrace-release.tgz --header="Authorization: Api-Token {paas-token}" /https://{api-url}/api/v1/deployment/boshrelease/agent/windows/version/{version}?skipMetadata=true -
Confirm the checksum of the release.
For Dynatrace SaaS, replace
{api-url}with the address of the environment ActiveGate.curl -H "Authorization: Api-Token {paas-token}" /https://{api-url}/api/v1/deployment/boshrelease/agent/windows/version/{version}/checksum?skipeMetadata=true# this results in a response as follows (example):{"sha256":"13658655d922aedc93951b545e8b881b76a77545ba6f8442828cfed53ffac3a8"}# use the sha256 value to check against the file:echo "13658655d922aedc93951b545e8b881b76a77545ba6f8442828cfed53ffac3a8 dynatrace-release.tgz" | sha256sum -c# if the checksum matches the response is:dynatrace-release.tgz: OK# if the checksum doesn't match:# dynatrace-release.tgz FAILED# sha256sum: WARNING: 1 computed checksum did NOT match -
Ensure that your BOSH CLI is successfully connected to the BOSH Director. For details, see the Cloud Foundry or VMware Tanzu documentation.
-
Upload the BOSH release of OneAgent to the BOSH Director.
bosh -e my-env upload-release PATH-TO-BINARY/dynatrace-release.tgz -
Create a runtime configuration named
runtime-config-dynatrace.ymland adapt the settings according to your environment:- The
apiurlkey:
Replace the Dynatrace
ENVIRONMENTIDinhttps://ENVIRONMENTID.live.dynatrace.com/apiwith your own environment ID.Use
https://YourActiveGateIPorFQDN:9999/e/<ENVIRONMENTID>/apito download the OneAgent, as well as to communicate OneAgent traffic through the ActiveGate.We recommend that you use an ActiveGate as a connection endpoint. By default, ActiveGates have a self-signed certificate. However, if you prefer to use a trusted CA rather than the self-signed certificate, or if you're getting SSL errors during install after switching to the ActiveGate endpoint, follow the instructions on how to properly set up your ActiveGate.
- optional Configure network zones:
To configure network zones, use the following installer argument:--set-network-zone=<your.network.zone>.
See network zones for more information.
releases:- name: dynatrace-oneagentversion: 1.187.100.20200217-114813addons:- name: dynatrace-oneagent-addonjobs:- name: dynatrace-oneagentrelease: dynatrace-oneagentproperties:dynatrace:environmentid: <environmentId># The following keys are required for 1.177+ immutable OneAgent releaseapitoken: <paas-token>#### optional properties below#### Replace with your Dynatrace Managed URL, including the environment ID.# An example URL might look like the followingapiurl: https://{your-managed-cluster.com}/e/{environmentid}/api# Set to 'all' if you want to accept all self-signed SSL certificates.sslmode: all# Specify the proxy to be used for communication. This setting is for BOSH only.# If you're using a proxy from an ActiveGate, leave this option commented out.proxy: https://your-proxy-url# Specify in which hostgroup the VMs in this deployments belonghostgroup: example_hostgroup# Define host tags for the VMs in this deploymenthosttags: landscape=production team=my_team# Define custom properties for the VMs in this deploymenthostprops: Department=Acceptance Stage=Sprint# Enable cloud infrastructure monitoring mode.# Set this to 1 to activate itinfraonly: 0# Enable validation of the download via certificate# Set this to true to active itvalidatedownload: false# Hand over any installer argument# Use either this OR the hostgroup, hosttags, infraonly, proxy properties.# Usage of 'installerargs' will overwrite the others!# (Linux only) Usage of USER= and GROUP= arguments will change user and group for plugin and network agentsinstallerargs: USER=vcap GROUP=vcap --set-network-zone=<your.network.zone>include:deployments:- name-of-your-deploymentstemcell:- os: ubuntu-xenialexclude:lifecycle: errand - The
-
Update the BOSH Director runtime configuration.
Replace
PATHwith the path to theruntime-config-dynatrace.ymlfile.bosh -e my-env update-runtime-config PATH/runtime-config-dynatrace.ymlThis runtime configuration applies to all new BOSH deployments going forward.
If you have multiple BOSH runtime configurations with different OneAgent versions, you must delete the older ones using
bosh delete-config. -
Deploy your changes.
Since existing BOSH deployments won’t be automatically updated with the jobs specified in the runtime configuration, you need to redeploy them so that BOSH rolls out the OneAgent.
bosh -e my-env -d deployment deploy
This version isn't recommended for controlled production environments as it automatically downloads the latest OneAgent release with each bosh deploy.
The latest OneAgent release can be controlled in the OneAgent updates section of your Dynatrace environment.
-
Download the lightweight OneAgent BOSH release from the Dynatrace Github repository
-
Ensure that your BOSH CLI is successfully connected to the BOSH Director. For details, see the Cloud Foundry or VMware Tanzu documentation.
-
Upload the BOSH release of OneAgent to the BOSH Director.
bosh -e my-env upload-release PATH-TO-BINARY/dynatrace-release.tgz -
Create a runtime configuration named
runtime-config-dynatrace.ymland adapt the settings according to your environment:- The
apiurlkey:
Replace the Dynatrace
ENVIRONMENTIDinhttps://ENVIRONMENTID.live.dynatrace.com/apiwith your own environment ID.Use
https://YourActiveGateIPorFQDN:9999/e/<ENVIRONMENTID>/apito download the OneAgent, as well as to communicate OneAgent traffic through the ActiveGate.We recommend that you use an ActiveGate as a connection endpoint. By default, ActiveGates have a self-signed certificate. However, if you prefer to use a trusted CA rather than the self-signed certificate, or if you're getting SSL errors during install after switching to the ActiveGate endpoint, follow the instructions on how to properly set up your ActiveGate.
- optional Configure network zones:
To configure network zones, use the following installer argument:--set-network-zone=<your.network.zone>.
See network zones for more information.
releases:- name: dynatrace-oneagentversion: 1.3.2addons:- name: dynatrace-oneagent-addonjobs:- name: dynatrace-oneagentrelease: dynatrace-oneagentproperties:dynatrace:environmentid: <environmentId># The following keys are required for 1.177+ immutable OneAgent releaseapitoken: <paas-token>#### optional properties below#### Replace with your Dynatrace Managed URL, including the environment ID.# An example URL might look like the followingapiurl: 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. This setting is for BOSH only.# If you're using a proxy from an ActiveGate, leave this option commented out.proxy: https://your-proxy-url# Specify in which hostgroup the VMs in this deployments belonghostgroup: example_hostgroup# Define host tags for the VMs in this deploymenthosttags: landscape=production team=my_team# Define custom properties for the VMs in this deploymenthostprops: Department=Acceptance Stage=Sprint# Enable cloud infrastructure monitoring mode.# Set this to 1 to activate itinfraonly: 0# Enable validation of the download via certificate# Set this to true to active itvalidatedownload: false# Hand over any installer argument# Use either this OR the hostgroup, hosttags, infraonly, proxy properties.# Usage of 'installerargs' will overwrite the others!# (Linux only) Usage of USER= and GROUP= arguments will change user and group for plugin and network agentsinstallerargs: USER=vcap GROUP=vcap --set-network-zone=<your.network.zone>include:deployments:- name-of-your-deploymentstemcell:- os: ubuntu-xenialexclude:lifecycle: errand# optional: extra addon configuration for Windows cells- name: dynatrace-oneagent-windows-addonjobs:- name: dynatrace-oneagent-windowsrelease: dynatrace-oneagentproperties:dynatrace:environmentid: <environmentId>apitoken: <paas-token># 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-deploymentstemcell:- os: windows1803exclude:lifecycle: errand - The
-
Update the BOSH Director runtime configuration.
Replace
PATHwith the path to theruntime-config-dynatrace.ymlfile.bosh -e my-env update-runtime-config PATH/runtime-config-dynatrace.ymlThis runtime configuration applies to all new BOSH deployments going forward.
If you have multiple BOSH runtime configurations with different OneAgent versions, you must delete the older ones using
bosh delete-config. -
Deploy your changes.
Since existing BOSH deployments won’t be automatically updated with the jobs specified in the runtime configuration, you need to redeploy them so that BOSH rolls out the OneAgent.
bosh -e my-env -d deployment deploy