Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-appd_db_agent', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
puppet/appd_db_agent
Table of Contents
- Description
- Setup - The basics of getting started with appd_db_agent
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module installs, configures and provides a systemd based service for the AppDynamics Database Agent. It has been developed and tested with dbagent version 4.4.1.229 on CentOS 7 with Puppet 4.10. It should also work on Puppet 5 and on other RedHat Enterprise 7 clones.
Configuration is all done via the systemd service and environment file it loads from /etc/sysconfig/appd_db_agent.
No changes are made to controller-info.xml.
Setup
What appd_db_agent affects
The module downloads and installs the database agent under /opt/appdynamics.
It creates a systemd unit file for the agent and starts the service.
The agent depends on java being installed and this module will install by
including puppetlabs/java.
Setup Requirements
AppDynamics doesn't provide an anonymous download link for the agent.
You will have to provide the dbagent zip yourself. You have several choices for hosting it yourself.
You could make it available over http via an artifact repository such as Artifactory or Nexus.
Or you could make it available using your puppetserver's fileserver by placing the zip in your site module
and specifying a puppet:/// url as the source parameter.
If using an onsite AppDynamics controller, you will have to install the required license on your controller before the agent will work.
Beginning with appd_db_agent
The module has a single public class. There are several optional parameters, but 5 that are required. You will need to know
- The source for the dbagent zip file.
This can be any source the puppet/archive module supports such as a https URL, a local file, or a
puppet:///URL. - The version of the dbagent you're installing.
This isn't automatically extracted from the source URL. It should be the complete version number eg
4.4.1.2. - The controller host name. The module should work with local and hosted AppDynamics controllers.
- The controller port number. If using the hosted service, this will be 443.
- The password to use as the Agent Account Access Key.
You should also consider how much heap space to allocate to the JVM running the agent. This module defaults the parameter java_heap_size to just 256MB.
AppDynamic's recommend 1GB + 512MB for each monitored database.
Usage
A minimal example where the agent zip is stored in a site module and a locally installed controller is used.
class { 'appd_db_agent':
source => 'puppet:///modules/site/appdynamics/dbagent-4.4.1.229.zip',
version => '4.4.1.229',
controller_host_name => 'appdynamics.example.com',
controller_port => 8090,
agent_account_access_key => 'secret',
}
A more complete example using Artifactory as the source for the zip. Communications with the hosted SAAS is encrypted and via a squid proxy.
class { 'appd_db_agent':
source => 'https://artifactory.example.com/artifactory/infra/org/appdynamics/dbagent/dbagent-4.4.1.229.zip',
checksum => artifactory_sha1('https://artifactory.example.com/artifactory/api/storage/infra/org/appdynamics/dbagent/dbagent-4.4.1.229.zip'),
checksum_type => 'sha1',
version => '4.4.1.229',
controller_host_name => 'exampleorg.saas.appdynamics.com',
controller_port => 443,
controller_ssl_enabled => true,
agent_account_access_key => 'secret',
proxy_host => 'squid.example.com',
proxy_port => 3128,
java_heap_size => '4g',
}
Reference
Limitations
- Tested on CentOS 7
- Puppet 4.10 or greater.
Development
This module is maintained by Vox Pupuli. It was written by Alex Fisher and is licensed under the Apache-2.0 License.
Reference
Table of Contents
Classes
Public Classes
appd_db_agent: Downloads, installs, configures and runs an Appdynamics Database Agent service
Private Classes
appd_db_agent::config: This class handles the configuration.appd_db_agent::install: This class handles the installation.appd_db_agent::service: This class handles the service.
Classes
appd_db_agent
Downloads, installs, configures and runs an Appdynamics Database Agent service
Parameters
The following parameters are available in the appd_db_agent class:
sourceversioncontroller_host_namecontroller_portagent_account_access_keyusergroupmanage_useragent_account_namecontroller_ssl_enabledchecksumchecksum_typeproxy_hostproxy_portdb_agent_namejava_heap_sizejava_home
source
Data type: String
The source location of the dbagent-x.x.x.x.zip file. Can be any source that puppet/archive supports.
version
Data type: String
The version of the agent being installed eg 4.4.1.229.
controller_host_name
Data type: Stdlib::Host
The AppDynamics controller to connect to.
controller_port
Data type: Stdlib::Port
The port on which to connect to the controller.
agent_account_access_key
Data type: String
The account access key the agent should use.
user
Data type: String
The user to install and run the agent as.
Default value: 'appdynamics'
group
Data type: String
The primary group of the user.
Default value: 'appdynamics'
manage_user
Data type: Boolean
Whether to create the user and group. Useful if you already have puppet code creating an appdynamics user.
Default value: true
agent_account_name
Data type: Optional[String]
This is the account name used to authenticate with the Controller.
Default value: undef
controller_ssl_enabled
Data type: Optional[Boolean]
Whether to connect to the controller using SSL. Needs to be set to true if using the AppDynamics SaaS Controller.
Default value: undef
checksum
Data type: Optional[String]
Passed to the puppet/archive module when downloading the zip.
Default value: undef
checksum_type
Data type: Optional[Enum['md5', 'sha1', 'sha2', 'sha256', 'sha384', 'sha512']]
Passed to the puppet/archive module when downloading the zip.
Default value: undef
proxy_host
Data type: Optional[Stdlib::Host]
If specified, the HTTP proxy to use when connecting to the controller.
Default value: undef
proxy_port
Data type: Optional[Stdlib::Port]
The HTTP proxy port. Required when proxy_host is set.
Default value: undef
db_agent_name
Data type: Optional[String[1]]
The name you want the agent to appear as in the controller.
Default value: undef
java_heap_size
Data type: Pattern[/^\d+[kKmMgG]$/]
The heap size for the java process. The default is very low and should be increased according to how many databases the agent will connect to and in line with the AppDynamics documentation.
Default value: '256m'
java_home
Data type: Stdlib::Unixpath
The java home of the JRE you want to use.
Default value: '/usr/lib/jvm/java'
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v1.0.0 (2024-04-24)
Breaking changes:
- Drop Puppet 6 support #51 (bastelfreak)
- Drop support of Puppet 5 #43 (smortex)
- modulesync 2.7.0 and drop puppet 4 #29 (bastelfreak)
Implemented enhancements:
- puppetlabs/java: Allow 10.x #62 (zilchms)
- puppet/systemd: Allow 7.x #61 (zilchms)
- puppet/archive: allow 7.x #60 (zilchms)
- Add Puppet 8 support #54 (bastelfreak)
- puppetlabs/stdlib: Allow 9.x #53 (bastelfreak)
- bump puppet/systemd to \< 5.0.0 #49 (jhoblitt)
- Add support for Puppet 7 #44 (smortex)
- puppet/archive: allow 5.x #39 (bastelfreak)
Merged pull requests:
- Remove generated HTML documentation #57 (smortex)
- Allow stdlib 8.0.0 #42 (smortex)
- switch from camptocamp/systemd to voxpupuli/systemd #41 (bastelfreak)
- modulesync 3.0.0 & puppet-lint updates #36 (bastelfreak)
- Allow
puppetlabs/stdlib6.xpuppetlabs/java4.x andpuppet/archive4.x #30 (alexjfisher) - Update minimum stdlib version and use newer types #28 (alexjfisher)
v0.3.1 (2018-10-17)
Merged pull requests:
- modulesync 2.1.0 and allow puppet 6.x #23 (bastelfreak)
- allow puppetlabs/stdlib 5.x #20 (bastelfreak)
v0.3.0 (2018-08-15)
Merged pull requests:
- allow puppetlabs/java 3.x #18 (bastelfreak)
- allow puppet/archive 3.x #16 (bastelfreak)
v0.2.0 (2018-07-16)
Merged pull requests:
- allow camptocamp/systemd 2.X #11 (bastelfreak)
- Remove docker nodesets #10 (bastelfreak)
v0.1.1 (2018-03-05)
Merged pull requests:
- Add missing travis puppetforge deployment secret #6 (alexjfisher)
v0.1.0 (2018-03-05)
Merged pull requests:
- Add extra validation for proxy_port #4 (alexjfisher)
- Small doc updates #3 (alexjfisher)
- Add badges and fix up metadata.json for Vox Pupuli #2 (alexjfisher)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 4.25.0 < 10.0.0)
- puppetlabs/java (>= 1.5.0 < 11.0.0)
- puppet/archive (>= 1.1.2 < 8.0.0)
- puppet/systemd (>= 1.0.0 < 7.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.