aem_curator
Puppet module for installing and configuring a curated set of Adobe Experience Manager (AEM) components
Version information
released Nov 25th 2018
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
- Puppet >= 5.0.0 < 7.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'shinesolutions-aem_curator', '1.3.0'
Learn more about managing modules with a PuppetfileDocumentation
shinesolutions/aem_curator — version 1.3.0 Nov 25th 2018
Puppet AEM Curator
A Puppet module for installing and configuring a curated set of Adobe Experience Manager (AEM) components.
This module supports AEM installation for various versions along with a combination of Service Packs, Cumulative Fix Packs, and hotfixes. Those combinations are bundled into what this module calls AEM Profiles.
Other than AEM installation, it also supports some common AEM management events:
- Deployment of a single AEM package or a single Dispatcher package
- Deployment of multiple AEM packages and Dispatcher packages declared in a descriptor file
- Enable and disable CRXDE
- Promote an AEM Author Standby to AEM Author Primary
- Flush AEM Dispatcher cache
- Export a single AEM package for backup
- Export multiple AEM packages for backup, declared in a descriptor file
- Import a single backup AEM package
- List AEM packages
Install
puppet module install shinesolutions-aem_curator
Or via a Puppetfile:
mod 'shinesolutions/aem_curator'
If you want to use the master version:
mod 'shinesolutions/aem_curator', :git => 'https://github.com/shinesolutions/puppet-aem-curator'
Usage
TODO
Types in this module release
1.3.0
- Add feature to configure SAML
- Add feature to configure AEM Trusttore
- Add feature to configure AEM Authorizable Keystore
- Add feature to manage AEM Truststore certificates
- Add feature to manage AEM Authorizable Keystore certificates
- Add action manifests for enabling/disabling SAML
1.2.4
- Fix parameters for "Wait until login page is ready" to consume parameters from aem-aws-stack-provisioner for all checks #76
- Add Amazon Linux 2 to supported OS list in Puppet metadata
1.2.3
- Change default JMX ports to 5982 for AEM Author and 5983 for AEM Publish
- Add wait until AEM Author Standby port is listening #75
- Add Puppet resource stopped status check for AEM services at the end of installation
- Disable collectd repo management to avoid any outbound connection #71
- Upgrade aem_resources to 3.2.1
1.2.2
- Remove collectd installation due to collectd provisioning already exists on Packer AEM #71
1.2.1
- Add parameter to enable/disable installation of collectd #68
- Add step to install collectd after installation of AEM for Author & Publish #71
- Upgrade InSpec to 2.3.10 with new vendoring structure #60
1.2.0
- Updated parameters for "Wait until login page is ready" to consume parameters from aem-aws-stack-provisioner
- Add additional checks during configuring AEM Author & AEM Publisher #63
- Add parameter deployment_sleep_seconds for resource deploy_packages
- Lock inspec version to 2.2.78 #60
- Remove support for Ruby 2.1 & 2.2 due to dependency issues
- Add feature to delete old bak files from the repository during offline-compaction
- Add install AEM profile action
- Simplify AEM profile installation logic #7
- Introduce pdk as Puppet module build
- Drop Puppet 4 support, add Puppet 6 support
- Upgrade aem_resources to 3.2.0
- Add new AEM profile: aem64_sp2
1.1.2
- Upgrade aem_resources to 3.1.1 for aem_user_alias support
1.1.1
- Fix pre-6.4 incorrect config path for AEM Password Reset and AEM Health Check
1.1.0
- Add support for reconfiguring existing AEM installations
- Place AEM Healthcheck installation to own manifest
- Place AEM Configuration to own manifest
- Add feature to change existing system users passwords
- Improved credentials handling for system users
1.0.3
- Fix temp directory clean up at the end of artifacts deployment
1.0.2
- Set repository ownership when configuring AEM Author Primary, Author Standby, and Publish
1.0.1
- Add 1.x.x AEM profiles: aem62_sp1_cfp15, aem63_sp2_cfp2, aem64_sp1
1.0.0
- Modify config path to /apps/system/config for AEM 6.4 support
0.10.2
- Add log rotation to author standby promotion
0.10.1
- Rename AEM 6.3 SP2 asset name to be identical to Adobe Package Share's
0.10.0
- Switch InSpec deps to released versions
- Add manifest for logrotation configuration
- Add AEM profiles: aem63_sp2, aem63_sp2_cfp1
0.9.30
- Add retries setting for deploying a single artifact #28
0.9.29
- Add AEM start opts support to AEM instance installation
- Backup import no longer fails when the package already exists
0.9.28
- Move snapshot attachment step to aem-aws-stack-provisioner
- Extract all scheduled jobs provisioning to config_aem_scheduled_jobs
- Fix missing Puppet exit code translation on all aem-tools
0.9.27
- Fix path conflict on flush dispatcher cache action
0.9.26
- Modify flush dispatcher cache action to remove only JCR sub-directories under docroot
- Add timeout setting to author and publish configuration manifests
0.9.25
- Clean up temp directory at the end of deploy artifacts
- Add parameter allowing additional java opts settings for author and publish
0.9.24
- Fix parameter passing on deploy artifact and export backups
0.9.23
- Add log_dir parameter to deploy artifact templates processing
- Add list packages support to aem-tools
0.9.22
- Fix incorrect match regex for Collectd CloudWatch config #25
0.9.21
- Set retry settings to AEM package deployment actions #28
- Add new AEM profile: aem64
- Move stack prefix and component details as a constant value dimension for Collectd CloudWatch config #25
0.9.20
- Add aem_id parameter to actions with on-demand AEM target
0.9.19
- Fix injection of aem_username & aem_password to action manifests #26
- Move export backup and import backup scripts provisioning to aem-aws-stack-provisioner
- Move AEM Author standby promotion instance rename to aem-aws-stack-provisioner
- Add InSpec testing for aem-tools actions
- Fix incorrect artifact name for aem63_sp1_cfp13
0.9.18
- Allow default aem_id via Hiera configuration for action manifests
0.9.17
- Add new AEM profile: aem63_sp1_cfp13 #21
- Add ssl_cert parameter to dispatcher templates
- Move aem_resources-generated virtual hosts config to virtual hosts directory
0.9.16
- Add complete dispatcher template parameters to all dispatcher template processing #19
0.9.15
- Move AEM Tools directory ensure to aem-aws-stack-provisioner
- Remove flush dispatcher cache script from config_aem_tools
0.9.14
- Add new manifest for Dispatcher aem-tools
- Add new aem-tool flush-dispatcher-cache
0.9.13
- Fix incorrect manifest for deploy-artifact aem-tools script
- Add integrated export-package,export-packages and import-packages from aem-aws-stack-provisioner to aem-curator
0.9.12
- Add multi AEM instances support to collectd config
- Fix aem63_sp1_cfp2 artifact file name and package name #6
- Add Author Standby component bean whitelisting
0.9.11
- Add new AEM profile: aem63_sp1_cfp2 #6
- Add aem_version to Author Standby and Author Primary OSGI configuration
0.9.10
- Migrate artifacts deployment tools from aem-aws-stack-provisioner to aem_curator
- Add feature enable jmxremote at AEM Author and Publish java instances
- Configure CloudWatch collectd plugin's proxy support only if proxy fact is set
- Add disable-crxde to aem-tools
- Drop Ruby 2.0 support
0.9.9
- Migrate all AEM Tools files and templates from aem-aws-stack-provisioner to aem_curator
- Migrate AWS-related scripts from aem_curator to aem-aws-stack-provisioner
- Parameterise all references to AWS S3
- Add multi AEM instances support to offline compaction and enable CRXDE
- Extract deployment support to config_aem_deployer manifest
0.9.8
- Localise global facts aem_password_reset_version, oak_run_version
0.9.7
- Remove publish_dispatcher_allowed_client, pairinstanceid, and publishdispatcherhost global facts
- Add config_author_dispatcher class
- Add config_author_standby class
0.9.6
- Add readiness checks during installation and configuration of AEM Dispatcher
- Added variable jvm_mem_opts to configure JVM Memory for AEM Author and Publisher
0.9.5
- config_publish_dispatcher no longer deploys artifacts (moved to aem-aws-stack-provisioner) due to AWS-specific check
- Fix Dispatcher artifacts descriptor generator script name
0.9.4
- Add enable_default_password flag for creating system users password with default value (i.e. same as username)
- Add enable_crxde flag for enabling CRXDE access
0.9.3
- Add new AEM profiles: aem62_sp1_cfp2, aem62_sp1_cfp9, aem63_sp1
- Rename jvm_opts param to aem_jvm_opts
0.9.2
- Introduce AEM profile concept which defines AEM base installation along with extra packages (hotfixes, service packs, cumulative fix packs)
- AEM and license files now have predetermined names, consistent with extra packages
- Add aem63 profile for vanilla AEM 6.3 base installation
0.9.1
- Add dependencies to metadata
0.9.0
- Initial version
- config_publish_dispatcher: Publisher Host definitions replaced: $publish_host class variable replaced $::publishhost
- config_publish: Flush agent definitions replaced: $publishdispatcherhost, $pairinstanceid class variable replaced $::publishdispatcherhost, $::pairinstanceid
- Move AEM Tools into its own manifest config_aem_tools.pp
- Migrate AEM installation manifests from packer-aem
- Add multi AEM instances support at manifests level by replacing classes with definitions and by introducing aem_id attributes
- Move collectd into its own manifest config_collectd.pp
- Each AEM installation has its own user and group named aem-<aem_id>
- Introduce vanilla AEM 6.2 option without hotfix, service pack, and cumulative fix pack packages
Dependencies
- aco-oracle_java (>= 2.8.3 <3.0.0)
- bstopp/aem (>= 2.5.0 <3.0.0)
- puppetlabs/apache (>= 2.3.0 <3.0.0)
- puppetlabs/concat (>= 4.1.0 <5.0.0)
- puppetlabs/java_ks (>= 1.6.0 <2.0.0)
- puppetlabs-stdlib (>= 4.25.1 <5.0.0)
- shinesolutions/aem_resources (>= 3.3.0 <4.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 2017 Shine Solutions 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.